/tg/ Station 13 - Modules - TypesVar Details - Proc Details

cleaner

Component that can be used to clean things. Takes care of duration, cleaning skill and special cleaning interactions. A callback can be set by the datum holding the cleaner to add custom functionality. Soap uses a callback to decrease the amount of uses it has left after cleaning for example.

Vars

base_cleaning_durationThe time it takes to clean something, without reductions from the cleaning skill modifier.
cleaning_strengthDetermines what this cleaner can wash off, the available options are found here.
on_cleaned_callbackGets called when something is successfully cleaned.
skill_duration_modifier_offsetOffsets the cleaning duration modifier that you get from your cleaning skill, the duration won't be modified to be more than the base duration.

Procs

cleanCleans something using this cleaner. The cleaning duration is modified by the cleaning skill of the user. Successfully cleaning gives cleaning experience to the user and invokes the on_cleaned_callback.
on_start_cleaningHandles the COMSIG_START_CLEANING signal by calling the clean proc.

Var Details

base_cleaning_duration

The time it takes to clean something, without reductions from the cleaning skill modifier.

cleaning_strength

Determines what this cleaner can wash off, the available options are found here.

on_cleaned_callback

Gets called when something is successfully cleaned.

skill_duration_modifier_offset

Offsets the cleaning duration modifier that you get from your cleaning skill, the duration won't be modified to be more than the base duration.

Proc Details

clean

Cleans something using this cleaner. The cleaning duration is modified by the cleaning skill of the user. Successfully cleaning gives cleaning experience to the user and invokes the on_cleaned_callback.

Arguments

on_start_cleaning

Handles the COMSIG_START_CLEANING signal by calling the clean proc.

Arguments