slapcraft_recipe
Vars | |
assembly_name_suffix | Suffix for the assembly name. |
---|---|
assembly_weight_class | Weight class of the assemblies for this recipe. |
category | Category this recipe is in the handbook. |
desc | Description of the recipe. May be displayed as additional info in the handbook. |
examine_hint | Hint displayed to the user which examines the item required for the first step. |
name | Name of the recipe. Will use the resulting atom's name if not specified |
radial_appearance | Appearance in the radial menu for the user to choose from if there are recipe collisions. |
result_amount | Amount of how many resulting types will be crafted. |
result_list | Instead of result type you can use this as associative list of types to amounts for a more varied output |
result_type | Type of the item that will be yielded as the result. |
show_finish_text | Should we print text when we finish? Mostly used to de-bloat chat. |
step_order | Order in which the steps should be performed. |
steps | List of all steps to finish this recipe |
subcategory | Subcategory this recipe is in the handbook. |
Procs | |
after_create_items | Behaviour after the item is created, and before the slapcrafting assembly is disposed. Here you can move the components into the item if you wish, or do other stuff with them. |
can_finish | Runs when the last step tries to be performed and cancels the step if it returns FALSE. Could be used to validate location in structure construction via slap crafting. |
check_correct_step | Checks if a step of type step_type can be performed with the given step_states state. |
create_item | Check if we want to craft multiple items, if yes then populate the list passed by the argument with them. Creates and returns a new item. This gets called for every item that is supposed to be created in the recipe. |
create_items | The proc that creates the resulted item(s). Make sure to add them to the passed results list. |
dispose_assembly | Here is the proc to get rid of the assembly, should one want to override it to handle that differently. |
finish_recipe | User has finished the recipe in an assembly. |
next_suitable_step | Returns the next suitable step to be performed with the item by the user with such step_states |
Var Details
assembly_name_suffix
Suffix for the assembly name.
assembly_weight_class
Weight class of the assemblies for this recipe.
category
Category this recipe is in the handbook.
desc
Description of the recipe. May be displayed as additional info in the handbook.
examine_hint
Hint displayed to the user which examines the item required for the first step.
name
Name of the recipe. Will use the resulting atom's name if not specified
radial_appearance
Appearance in the radial menu for the user to choose from if there are recipe collisions.
result_amount
Amount of how many resulting types will be crafted.
result_list
Instead of result type you can use this as associative list of types to amounts for a more varied output
result_type
Type of the item that will be yielded as the result.
show_finish_text
Should we print text when we finish? Mostly used to de-bloat chat.
step_order
Order in which the steps should be performed.
steps
List of all steps to finish this recipe
subcategory
Subcategory this recipe is in the handbook.
Proc Details
after_create_items
Behaviour after the item is created, and before the slapcrafting assembly is disposed. Here you can move the components into the item if you wish, or do other stuff with them.
can_finish
Runs when the last step tries to be performed and cancels the step if it returns FALSE. Could be used to validate location in structure construction via slap crafting.
check_correct_step
Checks if a step of type step_type
can be performed with the given step_states
state.
create_item
Check if we want to craft multiple items, if yes then populate the list passed by the argument with them. Creates and returns a new item. This gets called for every item that is supposed to be created in the recipe.
create_items
The proc that creates the resulted item(s). Make sure to add them to the passed results
list.
dispose_assembly
Here is the proc to get rid of the assembly, should one want to override it to handle that differently.
finish_recipe
User has finished the recipe in an assembly.
next_suitable_step
Returns the next suitable step to be performed with the item by the user with such step_states