slapcraft_step

Vars
blacklist_item_types	Item types to make a typecache of for blacklisting.
blacklist_typecache	Typecache of the blacklist
check_if_mob_can_drop_item	If the user is holding the item, check if they need to be able to drop it to be able to craft with it.
check_types	Whether we should check the types of the item, if FALSE then make sure `can_perform()` checks conditions.
desc	The description of the step, it shows in the slapcraft handbook
finish_msg	Visible message when you finish the step.
finish_msg_self	Personalized visible message when you finish the step.
finished_desc	The description of the finished step when you examine the assembly.
insert_item	Whether we insert the valid item in the assembly.
insert_item_into_result	Whether we insert the item into the resulting item's contents
item_types	List of types of items that can be used. Only relevant if `check_types` is TRUE
list_desc	Quantified description of the required element of this step. "screwdriver" or "15 cable", or "can with 50u. fuel" etc.
optional	Whether this step is optional. This is forbidden for first and last steps of recipes, and cannot be used on recipes with an order of SLAP_ORDER_FIRST_THEN_FREEFORM
perform_time	How long does it take to perform the step.
recipe_link	The recipe this step can link to. Make sure to include %LINK% and %ENDLINK% in `desc` to properly linkify it.
start_msg	Visible message when you start the step.
start_msg_self	Personalized visible message when you start the step.
todo_desc	The description of the step when it's the next one to perform in the assembly.
typecache	The typecache of types of the items.
Procs
can_perform	Below are virtual procs I allow steps to override for their specific behaviours. Checks whether a user can perform this step with an item. Exists so steps can override this proc for their own behavioural checks. `assembly` can be null here, when the recipe finding checks are trying to figure out what recipe we can make.
check_type	Checks whether a type is in the typecache of the step.
get_speed_multiplier	Returns a speed multiplier to the time it takes for the step to complete. Useful for tool-related steps
make_desc	Makes a description for the step.
make_finish_msg	Makes a description for the visible message of finishing a step.
make_finish_msg_self	Makes a personalized description for the visible message of finishing a step.
make_finished_desc	Makes a finished description for the step.
make_list_desc	Makes a list description for the item.
make_start_msg	Makes a description for the visible message of starting a step that requires some time to perform.
make_start_msg_self	Makes a personalized description for the visible message of starting a step that requires some time to perform.
make_todo_desc	Makes a todo description for the step.
move_item_to_assembly	Behaviour to move the item into the assembly. Stackable items may want to change how they do this.
on_perform	Behaviour to happen on performing this step. Perhaps removing a portion of reagents to create an IED or something.
perform	Make a user perform this step, by using an item on the assembly, trying to progress the assembly.
perform_check	Checks if the passed item is a proper type to perform this step, and whether it passes the `can_perform()` check. Assembly can be null
perform_do_after	Proc to perform handling a do_after, return FALSE if it failed, TRUE if succeeded.
play_perform_sound	Plays a sound on successfully performing the step.
progress_crafting	Whether the step progresses towards the next step when successfully performed. This can be used to allow "freeform" crafting to put more things into an assembly than required, possibly utilizing it for things like custom burgers
step_replace_text	Text replacing for sending visibile messages when the steps are happening.

Var Details

var
blacklist_item_types
– /list

Item types to make a typecache of for blacklisting.

var
blacklist_typecache
– /list

Typecache of the blacklist

var
check_if_mob_can_drop_item
–

If the user is holding the item, check if they need to be able to drop it to be able to craft with it.

var
check_types
–

Whether we should check the types of the item, if FALSE then make sure can_perform() checks conditions.

var
desc
–

The description of the step, it shows in the slapcraft handbook

var
finish_msg
–

Visible message when you finish the step.

var
finish_msg_self
–

Personalized visible message when you finish the step.

var
finished_desc
–

The description of the finished step when you examine the assembly.

var
insert_item
–

Whether we insert the valid item in the assembly.

var
insert_item_into_result
–

Whether we insert the item into the resulting item's contents

var
item_types
– /list

List of types of items that can be used. Only relevant if check_types is TRUE

var
list_desc
–

Quantified description of the required element of this step. "screwdriver" or "15 cable", or "can with 50u. fuel" etc.

var
optional
–

Whether this step is optional. This is forbidden for first and last steps of recipes, and cannot be used on recipes with an order of SLAP_ORDER_FIRST_THEN_FREEFORM

var
perform_time
–

How long does it take to perform the step.

var
recipe_link
–

The recipe this step can link to. Make sure to include %LINK% and %ENDLINK% in desc to properly linkify it.

var
start_msg
–

Visible message when you start the step.

var
start_msg_self
–

Personalized visible message when you start the step.

var
todo_desc
–

The description of the step when it's the next one to perform in the assembly.

var
typecache
– /list

The typecache of types of the items.

Proc Details

proc
can_perform
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, /list/error_list)

Below are virtual procs I allow steps to override for their specific behaviours. Checks whether a user can perform this step with an item. Exists so steps can override this proc for their own behavioural checks. assembly can be null here, when the recipe finding checks are trying to figure out what recipe we can make.

proc
check_type
(checked_type)

Checks whether a type is in the typecache of the step.

proc
get_speed_multiplier
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

Returns a speed multiplier to the time it takes for the step to complete. Useful for tool-related steps

proc
make_desc
()

Makes a description for the step.

proc
make_finish_msg
()

Makes a description for the visible message of finishing a step.

proc
make_finish_msg_self
()

Makes a personalized description for the visible message of finishing a step.

proc
make_finished_desc
()

Makes a finished description for the step.

proc
make_list_desc
()

Makes a list description for the item.

proc
make_start_msg
()

Makes a description for the visible message of starting a step that requires some time to perform.

proc
make_start_msg_self
()

Makes a personalized description for the visible message of starting a step that requires some time to perform.

proc
make_todo_desc
()

Makes a todo description for the step.

proc
move_item_to_assembly
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

Behaviour to move the item into the assembly. Stackable items may want to change how they do this.

proc
on_perform
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

Behaviour to happen on performing this step. Perhaps removing a portion of reagents to create an IED or something.

proc
perform
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, instant, silent, /list/error_list)

Make a user perform this step, by using an item on the assembly, trying to progress the assembly.

proc
perform_check
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, check_type_only, error_list)

Checks if the passed item is a proper type to perform this step, and whether it passes the can_perform() check. Assembly can be null

proc
perform_do_after
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, time_to_do)

Proc to perform handling a do_after, return FALSE if it failed, TRUE if succeeded.

proc
play_perform_sound
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

Plays a sound on successfully performing the step.

proc
progress_crafting
(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

Whether the step progresses towards the next step when successfully performed. This can be used to allow "freeform" crafting to put more things into an assembly than required, possibly utilizing it for things like custom burgers

proc
step_replace_text
(msg, /mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

Text replacing for sending visibile messages when the steps are happening.

slapcraft_step /datum/slapcraft_step

Vars

Procs

Var Details

var blacklist_item_types – /list

var blacklist_typecache – /list

var check_if_mob_can_drop_item –

var check_types –

var desc –

var finish_msg –

var finish_msg_self –

var finished_desc –

var insert_item –

var insert_item_into_result –

var item_types – /list

var list_desc –

var optional –

var perform_time –

var recipe_link –

var start_msg –

var start_msg_self –

var todo_desc –

var typecache – /list

Proc Details

proc can_perform(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, /list/error_list)

proc check_type(checked_type)

proc get_speed_multiplier(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

proc make_desc()

proc make_finish_msg()

proc make_finish_msg_self()

proc make_finished_desc()

proc make_list_desc()

proc make_start_msg()

proc make_start_msg_self()

proc make_todo_desc()

proc move_item_to_assembly(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

proc on_perform(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

proc perform(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, instant, silent, /list/error_list)

proc perform_check(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, check_type_only, error_list)

proc perform_do_after(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly, time_to_do)

proc play_perform_sound(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

proc progress_crafting(/mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)

proc step_replace_text(msg, /mob/living/user, /obj/item/item, /obj/item/slapcraft_assembly/assembly)