[{"data":1,"prerenderedAt":754},["ShallowReactive",2],{"/docs/jobs/firejob/reference/exports/server-createfire":3,"/docs/jobs/firejob/reference/exports/server-createfire-surround":743,"/docs/jobs/firejob/reference/exports/server-createfire-implemented-suggestions":753},{"id":4,"title":5,"body":6,"description":734,"extension":735,"head":736,"implementedSuggestions":736,"meta":737,"navigation":598,"path":738,"schemaOrg":736,"seo":739,"sitemap":740,"stem":741,"__hash__":742},"docs/1.docs/0.jobs/3.firejob/4.reference/3.exports/1.server-createfire.md","Server: CreateFire(payload, creator)",{"type":7,"value":8,"toc":729},"minimark",[9,17,30,33,146,160,165,172,175,291,341,348,401,708,725],[10,11,12],"p",{},[13,14,16],"a",{"href":15},"/docs/jobs/firejob/reference/exports","All exports",[10,18,19,20,24,25,29],{},"Call these exports from a ",[21,22,23],"strong",{},"server script"," in your own resource, with ",[26,27,28],"code",{},"sky_firejob"," started. They create or remove an incident when called. Automatic oil leaks after collisions or from wear need Sky Mechanic or another resource that detects the condition and calls Firejob.",[10,31,32],{},"The return formats and IDs differ between fire and oil exports:",[34,35,36,52],"table",{},[37,38,39],"thead",{},[40,41,42,46,49],"tr",{},[43,44,45],"th",{},"Operation",[43,47,48],{},"Return value on success",[43,50,51],{},"ID to keep",[53,54,55,75,101,130],"tbody",{},[40,56,57,63,69],{},[58,59,60],"td",{},[26,61,62],{},"CreateFire",[58,64,65,66],{},"One table: ",[26,67,68],{},"{ success = true, fireId = ..., type = ..., label = ... }",[58,70,71,74],{},[26,72,73],{},"result.fireId",", a numeric fire ID",[40,76,77,82,87],{},[58,78,79],{},[26,80,81],{},"CreateVehicleFire",[58,83,65,84],{},[26,85,86],{},"{ success = true, fireId = ... }",[58,88,89,90,93,94,97,98,100],{},"Keep the ",[21,91,92],{},"vehicle network ID you supplied"," for ",[26,95,96],{},"RemoveVehicleFire","; ",[26,99,73],{}," identifies the fire",[40,102,103,108,117],{},[58,104,105],{},[26,106,107],{},"CreateOilSpill",[58,109,110,113,114],{},[21,111,112],{},"Two values:"," ",[26,115,116],{},"true, spill",[58,118,119,122,123,126,127],{},[26,120,121],{},"spill.id",", a string such as ",[26,124,125],{},"\"17\"",", for ",[26,128,129],{},"RemoveOilSpill",[40,131,132,137,140],{},[58,133,134],{},[26,135,136],{},"GetOilSpills",[58,138,139],{},"An array of spill tables",[58,141,142,143,145],{},"Each entry's ",[26,144,121],{},"; the array index is not the spill ID",[10,147,148,151,152,155,156,159],{},[26,149,150],{},"creator",", where accepted, is a player's current server ID (",[26,153,154],{},"source","). Use ",[26,157,158],{},"0"," or omit it for server-created incidents. It is separate from the vehicle network ID, fire ID, and oil spill ID.",[161,162,164],"h2",{"id":163},"server-exports","Server Exports",[166,167,169],"h3",{"id":168},"createfirepayload-creator",[26,170,171],{},"CreateFire(payload, creator)",[10,173,174],{},"Creates a regular synchronized fire with Firejob's normal spread, extinguishing, dispatch, effects, and lifecycle behavior.",[34,176,177,193],{},[37,178,179],{},[40,180,181,184,187,190],{},[43,182,183],{},"Argument / payload field",[43,185,186],{},"Type",[43,188,189],{},"Required / default",[43,191,192],{},"Meaning",[53,194,195,212,233,253,270],{},[40,196,197,202,206,209],{},[58,198,199],{},[26,200,201],{},"payload",[58,203,204],{},[26,205,34],{},[58,207,208],{},"Required",[58,210,211],{},"Fire creation data",[40,213,214,219,228,230],{},[58,215,216],{},[26,217,218],{},"payload.coords",[58,220,221,224,225],{},[26,222,223],{},"{ x, y, z }"," or ",[26,226,227],{},"vector3",[58,229,208],{},[58,231,232],{},"World position with numeric coordinates",[40,234,235,240,245,250],{},[58,236,237],{},[26,238,239],{},"payload.type",[58,241,242],{},[26,243,244],{},"string",[58,246,247],{},[26,248,249],{},"\"trash\"",[58,251,252],{},"A configured fire profile or alias",[40,254,255,260,264,267],{},[58,256,257],{},[26,258,259],{},"payload.metadata",[58,261,262],{},[26,263,34],{},[58,265,266],{},"Optional",[58,268,269],{},"Overrides for this fire, described below",[40,271,272,276,281,285],{},[58,273,274],{},[26,275,150],{},[58,277,278],{},[26,279,280],{},"number",[58,282,283],{},[26,284,158],{},[58,286,287,288,290],{},"Player server ID for creation/dispatch context, or ",[26,289,158],{}," for a scripted incident",[10,292,293,294,297,298,224,301,304,305,308,309,297,312,315,316,304,319,322,323,326,327,330,331,322,334,326,337,340],{},"Common metadata fields are ",[26,295,296],{},"locationType"," (",[26,299,300],{},"\"interior\"",[26,302,303],{},"\"exterior\"","), ",[26,306,307],{},"sourceScale"," (scale multiplier), ",[26,310,311],{},"smokeDensity",[26,313,314],{},"0.0","–",[26,317,318],{},"1.0",[26,320,321],{},"material",", ",[26,324,325],{},"scenePropsEnabled",", and ",[26,328,329],{},"reignitable",". Reignition overrides include ",[26,332,333],{},"reignitionEnabled",[26,335,336],{},"reignitionChancePercent",[26,338,339],{},"reignitionDelaySeconds",". Omitted settings follow the fire profile and Firejob configuration.",[10,342,343,344,347],{},"The export returns ",[21,345,346],{},"one table",":",[349,350,351,375],"ul",{},[352,353,354,355,322,358,297,361,304,363,297,366,368,369,297,372,374],"li",{},"Success: ",[26,356,357],{},"success = true",[26,359,360],{},"fireId",[26,362,280],{},[26,364,365],{},"type",[26,367,244],{},"), and ",[26,370,371],{},"label",[26,373,244],{},").",[352,376,377,378,381,382,297,385,387,388,322,391,322,394,326,397,400],{},"Failure: ",[26,379,380],{},"success = false"," and ",[26,383,384],{},"error",[26,386,244],{},"). Possible errors are ",[26,389,390],{},"invalid_payload",[26,392,393],{},"invalid_coords",[26,395,396],{},"invalid_fire_type",[26,398,399],{},"create_failed",".",[402,403,408],"pre",{"className":404,"code":405,"language":406,"meta":407,"style":407},"language-lua shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","-- server.lua; choose coordinates appropriate for your incident.\nlocal result = exports[\"sky_firejob\"]:CreateFire({\n    type = \"trash\",\n    coords = { x = 215.0, y = -810.0, z = 30.0 },\n    metadata = {\n        locationType = \"exterior\",\n        sourceScale = 1.0,\n        smokeDensity = 0.8,\n        scenePropsEnabled = false\n    }\n}, 0)\n\nif not result.success then\n    print((\"Could not create fire: %s\"):format(result.error))\n    return\nend\n\nlocal fire_id = result.fireId\nprint((\"Created fire %s (%s)\"):format(fire_id, result.type))\n","lua","",[26,409,410,419,453,472,511,522,539,552,565,576,582,593,600,620,650,656,662,667,682],{"__ignoreMap":407},[411,412,415],"span",{"class":413,"line":414},"line",1,[411,416,418],{"class":417},"sHwdD","-- server.lua; choose coordinates appropriate for your incident.\n",[411,420,422,426,430,433,436,439,442,444,447,450],{"class":413,"line":421},2,[411,423,425],{"class":424},"sMK4o","local",[411,427,429],{"class":428},"sTEyZ"," result ",[411,431,432],{"class":424},"=",[411,434,435],{"class":428}," exports[",[411,437,438],{"class":424},"\"",[411,440,28],{"class":441},"sfazB",[411,443,438],{"class":424},[411,445,446],{"class":428},"]:",[411,448,62],{"class":449},"s2Zo4",[411,451,452],{"class":428},"({\n",[411,454,456,459,461,464,467,469],{"class":413,"line":455},3,[411,457,458],{"class":428},"    type ",[411,460,432],{"class":424},[411,462,463],{"class":424}," \"",[411,465,466],{"class":441},"trash",[411,468,438],{"class":424},[411,470,471],{"class":428},",\n",[411,473,475,478,480,483,485,489,492,494,497,500,503,505,508],{"class":413,"line":474},4,[411,476,477],{"class":428},"    coords ",[411,479,432],{"class":424},[411,481,482],{"class":428}," { x ",[411,484,432],{"class":424},[411,486,488],{"class":487},"sbssI"," 215.0",[411,490,491],{"class":428},", y ",[411,493,432],{"class":424},[411,495,496],{"class":424}," -",[411,498,499],{"class":487},"810.0",[411,501,502],{"class":428},", z ",[411,504,432],{"class":424},[411,506,507],{"class":487}," 30.0",[411,509,510],{"class":428}," },\n",[411,512,514,517,519],{"class":413,"line":513},5,[411,515,516],{"class":428},"    metadata ",[411,518,432],{"class":424},[411,520,521],{"class":428}," {\n",[411,523,525,528,530,532,535,537],{"class":413,"line":524},6,[411,526,527],{"class":428},"        locationType ",[411,529,432],{"class":424},[411,531,463],{"class":424},[411,533,534],{"class":441},"exterior",[411,536,438],{"class":424},[411,538,471],{"class":428},[411,540,542,545,547,550],{"class":413,"line":541},7,[411,543,544],{"class":428},"        sourceScale ",[411,546,432],{"class":424},[411,548,549],{"class":487}," 1.0",[411,551,471],{"class":428},[411,553,555,558,560,563],{"class":413,"line":554},8,[411,556,557],{"class":428},"        smokeDensity ",[411,559,432],{"class":424},[411,561,562],{"class":487}," 0.8",[411,564,471],{"class":428},[411,566,568,571,573],{"class":413,"line":567},9,[411,569,570],{"class":428},"        scenePropsEnabled ",[411,572,432],{"class":424},[411,574,575],{"class":424}," false\n",[411,577,579],{"class":413,"line":578},10,[411,580,581],{"class":428},"    }\n",[411,583,585,588,590],{"class":413,"line":584},11,[411,586,587],{"class":428},"}, ",[411,589,158],{"class":487},[411,591,592],{"class":428},")\n",[411,594,596],{"class":413,"line":595},12,[411,597,599],{"emptyLinePlaceholder":598},true,"\n",[411,601,603,607,610,613,617],{"class":413,"line":602},13,[411,604,606],{"class":605},"s7zQu","if",[411,608,609],{"class":424}," not",[411,611,612],{"class":428}," result.",[411,614,616],{"class":615},"sBMFI","success",[411,618,619],{"class":605}," then\n",[411,621,623,626,629,631,634,636,639,642,645,647],{"class":413,"line":622},14,[411,624,625],{"class":449},"    print",[411,627,628],{"class":428},"((",[411,630,438],{"class":424},[411,632,633],{"class":441},"Could not create fire: %s",[411,635,438],{"class":424},[411,637,638],{"class":428},"):",[411,640,641],{"class":449},"format",[411,643,644],{"class":428},"(result.",[411,646,384],{"class":615},[411,648,649],{"class":428},"))\n",[411,651,653],{"class":413,"line":652},15,[411,654,655],{"class":605},"    return\n",[411,657,659],{"class":413,"line":658},16,[411,660,661],{"class":605},"end\n",[411,663,665],{"class":413,"line":664},17,[411,666,599],{"emptyLinePlaceholder":598},[411,668,670,672,675,677,679],{"class":413,"line":669},18,[411,671,425],{"class":424},[411,673,674],{"class":428}," fire_id ",[411,676,432],{"class":424},[411,678,612],{"class":428},[411,680,681],{"class":615},"fireId\n",[411,683,685,688,690,692,695,697,699,701,704,706],{"class":413,"line":684},19,[411,686,687],{"class":449},"print",[411,689,628],{"class":428},[411,691,438],{"class":424},[411,693,694],{"class":441},"Created fire %s (%s)",[411,696,438],{"class":424},[411,698,638],{"class":428},[411,700,641],{"class":449},[411,702,703],{"class":428},"(fire_id, result.",[411,705,365],{"class":615},[411,707,649],{"class":428},[10,709,710,711,714,715,717,718,720,721,724],{},"Creation notifications are silent by default. Set ",[26,712,713],{},"metadata.silent = false"," and supply a player ",[26,716,150],{}," to send the normal creation notification. ",[26,719,360],{}," identifies a Firejob fire; it is not a vehicle network ID or an oil spill ID. Regular fires follow Firejob's extinguishing and configured expiry lifecycle; this page does not provide a ",[26,722,723],{},"RemoveFire"," export.",[726,727,728],"style",{},"html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":407,"searchDepth":414,"depth":421,"links":730},[731],{"id":163,"depth":421,"text":164,"children":732},[733],{"id":168,"depth":455,"text":171},"Reference for Server: CreateFire(payload, creator) in firejob.","md",null,{},"/docs/jobs/firejob/reference/exports/server-createfire",{"title":5,"description":734},{"loc":738},"1.docs/0.jobs/3.firejob/4.reference/3.exports/1.server-createfire","LyanpKfzggw9pdBQaD08RUotS7Rs_SOt06wI7b30nKc",[744,748],{"title":745,"path":15,"stem":746,"children":-1,"description":747},"Exports","1.docs/0.jobs/3.firejob/4.reference/3.exports","Fire Job server exports with argument types, return values, incident IDs, error handling, and complete oil spill examples.",{"title":749,"path":750,"stem":751,"description":752,"children":-1},"Server: CreateVehicleFire(payload, creator, options)","/docs/jobs/firejob/reference/exports/server-createvehiclefire","1.docs/0.jobs/3.firejob/4.reference/3.exports/2.server-createvehiclefire","Reference for Server: CreateVehicleFire(payload, creator, options) in firejob.",[],1791814228851]