status_effect

Status effects are used to apply temporary or permanent effects to mobs. This file contains their code, plus code for applying and removing them.

Vars
alert_type	The typepath to the alert thrown by the status effect when created. Status effect "name"s and "description"s are shown to the owner here.
duration	When set initially / in on_creation, this is how long the status effect lasts in deciseconds. While processing, this becomes the world.time when the status effect will expire. -1 = infinite duration.
id	The ID of the effect. ID is used in adding and removing effects to check for duplicates, among other things.
linked_alert	The alert itself, created in [proc/on_creation] (if alert_type is specified).
max_duration	The maximum duration this status effect can be. -1 = No limit
on_remove_on_mob_delete	If TRUE, we call [proc/on_remove] when owner is deleted. Otherwise, we call [proc/be_replaced].
owner	The mob affected by the status effect.
processing_speed	Used to define if the status effect should be using SSfastprocess or SSprocessing
status_type	How many of the effect can be on one mob, and/or what happens when you try to add a duplicate.
tick_interval	This is how long between [proc/tick] calls in deciseconds. This has to be a multiple of the [var/wait] of the subsystem this status effect is running on, which is based on [var/processing_speed]. Putting STATUS_EFFECT_NO_TICK here will stop [proc/tick] calls, and if [var/duration] is STATUS_EFFECT_PERMANENT, it stops processing entirely. Putting STATUS_EFFECT_AUTO_TICK here will make every subsystem tick call [proc/tick], making the tick interval depend entirely on [var/processing_speed]
time_until_next_tick	The time until the next [proc/tick] call, gets set to [var/tick_interval] after every [proc/tick] call and decrements on every [proc/process] call.
Procs
be_replaced	Called instead of on_remove when a status effect of status_type STATUS_EFFECT_REPLACE is replaced by itself, or when a status effect with on_remove_on_mob_delete set to FALSE has its mob deleted
before_remove	Called before being fully removed (before on_remove) Returning FALSE will cancel removal
extend	Called when a status effect of status_type STATUS_EFFECT_EXTEND has its duration extended in apply_status_effect - is passed New() args
get_examine_text	Gets and formats examine text associated with our status effect. Return 'null' to have no examine text appear (default behavior).
nextmove_adjust	Adds nextmove adjustment additiviely to the owner while applied
nextmove_modifier	Adds nextmove modifier multiplicatively to the owner while applied
on_apply	Called whenever the effect is applied in on_created Returning FALSE will cause it to delete itself during creation instead.
on_creation	Called from New() with any supplied status effect arguments. Not guaranteed to exist by the end. Returning FALSE from on_apply will stop on_creation and self-delete the effect.
on_remove	Called whenever the buff expires or is removed (qdeleted) Note that at the point this is called, it is out of the owner's status_effects list, but owner is not yet null
refresh	Called when a status effect of status_type STATUS_EFFECT_REFRESH has its duration refreshed in apply_status_effect - is passed New() args
remove_duration	Removes [seconds] of duration from the status effect. Returns whether or not the status effect was qdeleted due to running out of duration.
tick	Called every tick from process().

Var Details

var
alert_type

The typepath to the alert thrown by the status effect when created. Status effect "name"s and "description"s are shown to the owner here.

var
duration

When set initially / in on_creation, this is how long the status effect lasts in deciseconds. While processing, this becomes the world.time when the status effect will expire. -1 = infinite duration.

var
id

The ID of the effect. ID is used in adding and removing effects to check for duplicates, among other things.

var
linked_alert
– /atom/movable/screen/alert/status_effect

The alert itself, created in [proc/on_creation] (if alert_type is specified).

var
max_duration

The maximum duration this status effect can be. -1 = No limit

var
on_remove_on_mob_delete

If TRUE, we call [proc/on_remove] when owner is deleted. Otherwise, we call [proc/be_replaced].

var
owner
– /mob/living

The mob affected by the status effect.

var
processing_speed

Used to define if the status effect should be using SSfastprocess or SSprocessing

var
status_type

How many of the effect can be on one mob, and/or what happens when you try to add a duplicate.

var
tick_interval

This is how long between [proc/tick] calls in deciseconds. This has to be a multiple of the [var/wait] of the subsystem this status effect is running on, which is based on [var/processing_speed]. Putting STATUS_EFFECT_NO_TICK here will stop [proc/tick] calls, and if [var/duration] is STATUS_EFFECT_PERMANENT, it stops processing entirely. Putting STATUS_EFFECT_AUTO_TICK here will make every subsystem tick call [proc/tick], making the tick interval depend entirely on [var/processing_speed]

var
time_until_next_tick

The time until the next [proc/tick] call, gets set to [var/tick_interval] after every [proc/tick] call and decrements on every [proc/process] call.

Proc Details

proc
be_replaced
()

Called instead of on_remove when a status effect of status_type STATUS_EFFECT_REPLACE is replaced by itself, or when a status effect with on_remove_on_mob_delete set to FALSE has its mob deleted

proc
before_remove
()

Called before being fully removed (before on_remove) Returning FALSE will cancel removal

proc
extend
(/mob/living/parent, effect_path, ...)

Called when a status effect of status_type STATUS_EFFECT_EXTEND has its duration extended in apply_status_effect - is passed New() args

proc
get_examine_text
()

Gets and formats examine text associated with our status effect. Return 'null' to have no examine text appear (default behavior).

proc
nextmove_adjust
()

Adds nextmove adjustment additiviely to the owner while applied

proc
nextmove_modifier
()

Adds nextmove modifier multiplicatively to the owner while applied

proc
on_apply
()

Called whenever the effect is applied in on_created Returning FALSE will cause it to delete itself during creation instead.

proc
on_creation
(/mob/living/new_owner, ...)

Called from New() with any supplied status effect arguments. Not guaranteed to exist by the end. Returning FALSE from on_apply will stop on_creation and self-delete the effect.

proc
on_remove
()

Called whenever the buff expires or is removed (qdeleted) Note that at the point this is called, it is out of the owner's status_effects list, but owner is not yet null

proc
refresh
(/mob/living/parent, effect_path, ...)

Called when a status effect of status_type STATUS_EFFECT_REFRESH has its duration refreshed in apply_status_effect - is passed New() args

proc
remove_duration
(seconds)

Removes [seconds] of duration from the status effect. Returns whether or not the status effect was qdeleted due to running out of duration.

proc
tick
(delta_time, times_fired)

Called every tick from process().

status_effect /datum/status_effect

Vars

Procs

Var Details

var alert_type

var duration

var id

var linked_alert – /atom/movable/screen/alert/status_effect

var max_duration

var on_remove_on_mob_delete

var owner – /mob/living

var processing_speed

var status_type

var tick_interval

var time_until_next_tick

Proc Details

proc be_replaced()

proc before_remove()

proc extend(/mob/living/parent, effect_path, ...)

proc get_examine_text()

proc nextmove_adjust()

proc nextmove_modifier()

proc on_apply()

proc on_creation(/mob/living/new_owner, ...)

proc on_remove()

proc refresh(/mob/living/parent, effect_path, ...)

proc remove_duration(seconds)

proc tick(delta_time, times_fired)