/datum/statusEffect

Our datum that keeps track of an individual status effect.

Vars
desc	Tooltip desc
duration	In deciseconds (tenths of a second, same as ticks just sane). A duration of NULL is infinite. (This is distinct from 0)
effect_quality	If the effect is positive (buffs), negative (debuffs), or neutral (misc)
exclusiveGroup	optional name of a group of buffs. players can only have a certain number of buffs of a given group - any new applications fail. useful for food buffs etc.
hud_elements	List because they might be on different HUDs. This is kind of hacky but should be fine since the screen object cleans up in disposing.
icon_state	Icon state to display.
id	Unique ID of the status effect
maxDuration	If non-null, duration of the effect will be clamped to be max. this amount.
move_triggered	has an on-move effect
movement_modifier	Has a movement-modifying effect
name	Tooltip name to display
owner	Owner of the status effect
track_cat	Put a label here to track anyone with this effect into this category
unique	If true, this status effect can only have one instance on any given object.
visible	Is this visible in the status effect bar?
Procs
dropSweat	Called by some foods, use inside onUpdate(timePassed)
getChefHint	Used to generate text specifically for the chef examining food. Otherwise fallbacks to getTooltip().
getExamine	Information that should show up when an object has this effect and is examined.
getTooltip	Used to generate tooltip. Can be changed to have dynamic tooltips.
onAdd	Called when the status is added to an object. owner is already set at this point.
onChange	Called when the status is changed using setStatus. Called after duration is updated etc.
onCheck	Called by hasStatus. Used to handle additional checks with the optional arg in that proc.
onRemove	Called when the status is removed from the object. owner is still set at this point.
onUpdate	Called every tick by the status controller.
preCheck	Used to run a custom check before adding status to an object. For when you want something to be flat out immune or something.

Var Details

var
desc
–

Tooltip desc

var
duration
–

In deciseconds (tenths of a second, same as ticks just sane). A duration of NULL is infinite. (This is distinct from 0)

var
effect_quality
–

If the effect is positive (buffs), negative (debuffs), or neutral (misc)

var
exclusiveGroup
–

optional name of a group of buffs. players can only have a certain number of buffs of a given group - any new applications fail. useful for food buffs etc.

var
hud_elements
– /list/atom/movable/screen/statusEffect

List because they might be on different HUDs. This is kind of hacky but should be fine since the screen object cleans up in disposing.

var
icon_state
–

Icon state to display.

var
id
–

Unique ID of the status effect

var
maxDuration
–

If non-null, duration of the effect will be clamped to be max. this amount.

var
move_triggered
–

has an on-move effect

var
movement_modifier
– /datum/movement_modifier

Has a movement-modifying effect

var
name
–

Tooltip name to display

var
owner
– /atom

Owner of the status effect

var
track_cat
–

Put a label here to track anyone with this effect into this category

var
unique
–

If true, this status effect can only have one instance on any given object.

var
visible
–

Is this visible in the status effect bar?

Proc Details

proc
dropSweat
(sweatReagent, sweatAmount, sweatChance, /turf/targetTurf)

Called by some foods, use inside onUpdate(timePassed)

Required: sweatReagent - the chemical you're sweating

targetTurf should be left default

proc
getChefHint
()

Used to generate text specifically for the chef examining food. Otherwise fallbacks to getTooltip().

proc
getExamine
()

Information that should show up when an object has this effect and is examined.

proc
getTooltip
()

Used to generate tooltip. Can be changed to have dynamic tooltips.

proc
onAdd
(optional)

Called when the status is added to an object. owner is already set at this point.

optional {optional} - arg from setStatus (passed in)

proc
onChange
(optional)

Called when the status is changed using setStatus. Called after duration is updated etc.

optional {optional} - arg from setStatus (passed in)

proc
onCheck
(optional)

Called by hasStatus. Used to handle additional checks with the optional arg in that proc.

proc
onRemove
()

Called when the status is removed from the object. owner is still set at this point.

proc
onUpdate
(timePassed)

Called every tick by the status controller.

required {timePassed} - the actual time since the last update call.

proc
preCheck
(/atom/A)

Used to run a custom check before adding status to an object. For when you want something to be flat out immune or something.

return = 1 allow, 0 = do not allow

/datum/statusEffect

Vars

Procs

Var Details

var desc –

var duration –

var effect_quality –

var exclusiveGroup –

var hud_elements – /list/atom/movable/screen/statusEffect

var icon_state –

var id –

var maxDuration –

var move_triggered –

var movement_modifier – /datum/movement_modifier

var name –

var owner – /atom

var track_cat –

var unique –

var visible –