Space Station 13 - Modules - TypesVar Details - Proc Details

stack_recipe

Vars

cult_structureResulting atom is a cult structure
max_res_amountMaximum amount of atoms made
on_floorRequires a floor underneath to make
on_floor_or_latticeRequires a floor OR lattice underneath to make
one_per_turfOnly one resulting atom is allowed per turf
req_amountRequired stack amount to make
res_amountAmount of atoms made
result_imageGenerated base64 image. Used only if result has color
result_typeResulting typepath of crafted atom
timeTime to make
titleVisible title of recipe
window_checksRequires a valid window location to make

Procs

do_buildCreates the atom defined by the recipe. Should always return the object it creates or FALSE. This proc assumes that the construction is already possible; for checking whether a recipe can be built before construction, use try_build()
post_buildWhat should be done after the object is built? obj/item/stack/result might not actually be a stack, but this proc needs access to merge() to work, which is on obj/item/stack, so declare it as obj/item/stack anyways.
try_buildReturns TRUE if the recipe can be built, otherwise returns FALSE. This proc is only meant as a series of tests to check if construction is possible; the actual creation of the resulting atom should be handled in do_build()

Var Details

cult_structure

Resulting atom is a cult structure

max_res_amount

Maximum amount of atoms made

on_floor

Requires a floor underneath to make

on_floor_or_lattice

Requires a floor OR lattice underneath to make

one_per_turf

Only one resulting atom is allowed per turf

req_amount

Required stack amount to make

res_amount

Amount of atoms made

result_image

Generated base64 image. Used only if result has color

result_type

Resulting typepath of crafted atom

time

Time to make

title

Visible title of recipe

window_checks

Requires a valid window location to make

Proc Details

do_build

Creates the atom defined by the recipe. Should always return the object it creates or FALSE. This proc assumes that the construction is already possible; for checking whether a recipe can be built before construction, use try_build()

post_build

What should be done after the object is built? obj/item/stack/result might not actually be a stack, but this proc needs access to merge() to work, which is on obj/item/stack, so declare it as obj/item/stack anyways.

try_build

Returns TRUE if the recipe can be built, otherwise returns FALSE. This proc is only meant as a series of tests to check if construction is possible; the actual creation of the resulting atom should be handled in do_build()