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	This is how long the status effect lasts in deciseconds. You can put STATUS_EFFECT_PERMANENT (or INFINITY) here for infinite duration.
heal_flag_necessary	If remove_on_fullheal is TRUE, what flag do we need to be removed?
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).
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.
particle_effect	A particle effect, for things like embers - Should be set on update_particles()
processing_speed	Used to define if the status effect should be using SSfastprocess or SSprocessing
remove_on_fullheal	Do we self-terminate when a fullheal is called?
show_duration	If TRUE, and we have an alert, we will show a duration on the alert
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
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.
remove_effect_on_heal	Signal proc for COMSIG_LIVING_POST_FULLY_HEAL to remove us on fullheal
tick	Called every tick from process(). This is only called of tick_interval is not -1.
update_particles	Updates the particles for the status effects Should be handled by subtypes!
update_shown_duration	Updates the status effect alert's maptext (if possible)

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

This is how long the status effect lasts in deciseconds. You can put STATUS_EFFECT_PERMANENT (or INFINITY) here for infinite duration.

var
heal_flag_necessary

If remove_on_fullheal is TRUE, what flag do we need to be removed?

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
– /final/atom/movable/screen/alert/status_effect

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

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
– /final/mob/living

The mob affected by the status effect.

var
particle_effect
– /final/obj/effect/abstract/particle_holder

A particle effect, for things like embers - Should be set on update_particles()

var
processing_speed

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

var
remove_on_fullheal

Do we self-terminate when a fullheal is called?

var
show_duration

If TRUE, and we have an alert, we will show a duration on the alert

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
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
(effect, ...)

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
remove_effect_on_heal
(/datum/source, heal_flags)

Signal proc for COMSIG_LIVING_POST_FULLY_HEAL to remove us on fullheal

proc
tick
(seconds_between_ticks)

Called every tick from process(). This is only called of tick_interval is not -1.

Note that every tick =/= every processing cycle.

seconds_between_ticks = This is how many SECONDS that elapse between ticks. This is a constant value based upon the initial tick interval set on the status effect. It is similar to seconds_per_tick, from processing itself, but adjusted to the status effect's tick interval.

proc
update_particles
()

Updates the particles for the status effects Should be handled by subtypes!

proc
update_shown_duration
()

Updates the status effect alert's maptext (if possible)

status_effect /datum/status_effect

Vars

Procs

Var Details

var alert_type

var duration

var heal_flag_necessary

var id

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

var on_remove_on_mob_delete

var owner – /final/mob/living

var particle_effect – /final/obj/effect/abstract/particle_holder

var processing_speed

var remove_on_fullheal

var show_duration

var status_type

var tick_interval

var time_until_next_tick

Proc Details

proc be_replaced()

proc before_remove(...)

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(effect, ...)

proc remove_duration(seconds)

proc remove_effect_on_heal(/datum/source, heal_flags)

proc tick(seconds_between_ticks)

proc update_particles()

proc update_shown_duration()