datum

Vars
chat_text	Anything can speak... if it can speak
default_material	Material id of this object as a material id (lowercase string), set on New()
filter_data	@file @copyright 2020 @author actioninja (https://github.com/actioninja ) @license MIT
gas_impermeable	If atmos should be blocked by this - special behaviours handled in gas_cross() overrides
help_message	The message displayed when the atom is alt+doubleclicked, should contain a description of the atom's functionality. You can also override get_help_message() to return a message dynamically (based on atom state or the user etc.) Try to highlight the tools used to do stuff with tags. DO NOT override this directly, use HELP_MESSAGE_OVERRIDE instead. Example: HELP_MESSAGE_OVERRIDE("Use a screwdriver to unscrew the cover.")
level	Are we above or below the floor tile?
mat_changeappearance	Change the appearance of this atom when a material is applied?
mat_changedesc	Change the desc of this atom when a material is applied?
mat_changename	Change the name of this atom when a material is applied?
material_applied_appearance	Whether the last material applied updated appearance. Used for re-applying material appearance on icon update
open_to_sound	If hear_talk is triggered on this object, make my contents hear_talk as well
pass_unstable	Whether pathfinding is forbidden from caching the passability of this atom. See /turf/passability_cache
pixel_point	Should points thrown at this take into account the click pixel value
pulled_by	Which mob is pulling this atom currently
reagents	Chemistry.
rest_mult	A multiplier that changes how an atom stands up from resting. Yes.
statusEffects	List of status effects
storage	Storage for items
texture_size	Override for the texture size used by setTexture.
typeinfo_type	The base type for nearly all physical objects in SS13
uses_default_material_appearance	Does this object use appearance from the default material?
uses_default_material_name	Does this object use the default material's name?
Procs
Attackby	wrapper proc for /atom/proc/attackby so that signals are always sent. Call this, but do not override it.
CheckExit	Wrapper around Uncross for when you want to call it manually with a target turf
Cross	This is the proc to check if a movable can cross this atom. DO NOT put side effects in this proc, it is called for pathfinding Seriously I mean it, you think it'll be fine and then it causes the teleporting gene booth bug
MouseDrop	Override mouse_drop instead of this. Call this instead of mouse_drop, but you probably shouldn't!
Uncross	Override and return FALSE to prevent O from moving out of the tile where src is. In order to override this properly be sure to have the `do_bump = TRUE` default argument AND to call UNCROSS_BUMP_CHECK(O) in all branches where the return value can be FALSE (assign this return value to `.` instead of doing an explicit `return`).
UpdateIcon	Call this proc inplace of update_icon(...)
_MouseDrop_T	Override MouseDrop_T instead of this. Call this instead of MouseDrop_T, but you probably shouldn't!
add_fingerprint	Add a mob's fingerprint to something. If `hidden_only` is TRUE, only add to admin-visible prints.
add_fingerprint_direct	Add a fingerprint to an atom directly. Doesn't interact with hidden prints at all
add_sm_light	light.pixel_x = (vx * min(dist,light.dist) * 32) - 32
admin_visible_name	A proc to give this item a special name when viewed in an admin context (just the tilde-rightclick menu for now but probably other places later)
attackby	internal proc for when an atom is attacked by an item. Override this, but do not call it,
blob_act	BLOB RELATED PROCS
changeStatus	If atom has status with {statusId}, change by {duration}.
contains	Returns true if the given atom is within src's contents (deeply/recursively)
contents_ui_distance	public
create_reagents	Convenience proc to create a reagents holder for an atom Max vol is maximum volume of holder
create_storage	add storage to an atom
damage_blunt	Does x blunt damage to the atom
damage_cold	Does x cold damage to the atom
damage_corrosive	Does x corrosive damage to the atom
damage_electricity	Does x electricity damage to the atom
damage_heat	does x heat damage to the atom
damage_piercing	Does x piercing damage to the atom
damage_radiation	Does x radiation damage to the atom
damage_slashing	Does x slashing damage to the atom
delStatus	Deletes the given status from the atom.
gas_cross	Checks whether or not gases can pass through. Called by /turf/gas_cross for all atoms within the turf. Returns: TRUE for allowed pass and FALSE for denied pass.
getStatusDuration	Returns duration of status with given {statusId}, or null if not found.
getStatusList	Returns a list of all the datum/statusEffect on source atom.
getStatusPrototype	Returns prototype of status effect from the globalStatusPrototypes list with given {statusId}, or null if not found
get_connected_directions_bitflag	Return a bitflag that represents all potential connected icon_states
get_help_message	Override this if you want the alt+doubleclick help message to be dynamic (for example based on the state of deconstruction). For consistency you should always also override help_message at least to a placeholder never-to-be-seen string, this is important for the context menu functionality. Use the HELP_MESSAGE_OVERRIDE macro to do that.
hasStatus	Returns first status with given {statusId} or null if not found.
help_verb_dynamic	Same as help_verb but this one except visible, added dynamically when requested by signals
is_open_container	Convenience proc to see if a container is open for chemistry handling Takes an argument of whether this openness is for the purpose of pouring something in or not (this should maybe just be a separate flag but we ran out of bits okay) returns true if open, false if closed
material_on_attack_use	Called when an atom is used for an attack a atom for mat effects
material_trigger_on_blob_attacked	Called when an atom or someone wearing the material is attacked for mat effects
material_trigger_on_bullet	Called when an atom is hit by a bullet for mat effects
material_trigger_on_chems	Called when an atom is hit by a bullet for mat effects
material_trigger_on_explosion	Called when an atom is caught in an explosion
material_trigger_on_mob_attacked	Called when a mob holding this atom is attacked for mat effects
material_trigger_on_temp	Called when an atom is affected by a heat change
material_trigger_when_attacked	Called when the item is attacked with another atom for mat effects. If someone is smashed against the item or with hands, the mob itself is expected to be passed as attackatom
onMaterialChanged	Called AFTER the material of the object was changed.
removeMaterial	Simply removes a material from an object.
remove_storage	remove atom's storage
setMaterial	Sets the material of an object. PLEASE USE THIS TO SET MATERIALS UNLESS YOU KNOW WHAT YOU'RE DOING.
setMaterialAppearance	sets the appearance of a material, but does not trigger any tiggerOnAdd or onMaterialChanged behaviour Order of precedence is as follows: if the material is in the list of appearences to ignore, do nothing If an iconstate exists in the icon for iconstate$$materialID, that is chosen If the material has mat_changeappaerance set, then first texture is applied, then color (including alpha)
setMaterialAppearanceForImage	Applies material icon_state override to an /image based on this atom's material (or the material provided)
setStatus	If atom has status with {statusId}, set it to {duration}.
set_icon_state	Changes the icon state and returns TRUE if the icon state changed.
set_open_container	Set a container to be open or closed and handle chemistry reactions that might happen as a result
should_auto_connect	Check a turf and its contents to see if they're a valid auto-connection target
special_desc
temperature_expose	Exposes our reagents and material to some temperature, letting them figure out how to react to it.
tri_message	Used in messages with three separate parties that should receive different messages second_target - the second individual involved in the interaction, with the source atom being the first individual viewer_message - the message shown to observers that aren't specified targets first_message - the message shown to the atom this proc is called from second_message - the message shown to second_target blind_message (optional) is what blind people will hear, e.g. "You hear something!" Observers in range of either target will see the message, so the proc can be called on either target
try_set_icon_state	Checks if the icon state in question exists. If it does it sets it and returns true. Otherwise returns false and doesn't change the icon state. You can supply the new_icon argument to also override src.icon. This will again only be overriden if the icon state + icon combination exists. Not intended for normal use. Current intended use is stuff like `src.try_set_icon_state(src.icon_state + "-autumn")` for seasonal modifiers etc.
updateStatusUi	Stub. Override for objects that need to update their ui with status effect information.
update_icon	DO NOT CALL THIS PROC - Call UpdateIcon(...) Instead!

Var Details

var
chat_text
– /obj/chat_maptext_holder

Anything can speak... if it can speak

var
default_material
–

Material id of this object as a material id (lowercase string), set on New()

var
filter_data
– /list/list

var
gas_impermeable
–

If atmos should be blocked by this - special behaviours handled in gas_cross() overrides

var
help_message
–

The message displayed when the atom is alt+doubleclicked, should contain a description of the atom's functionality. You can also override get_help_message() to return a message dynamically (based on atom state or the user etc.) Try to highlight the tools used to do stuff with tags. DO NOT override this directly, use HELP_MESSAGE_OVERRIDE instead. Example: HELP_MESSAGE_OVERRIDE("Use a screwdriver to unscrew the cover.")

var
level
–

Are we above or below the floor tile?

var
mat_changeappearance
–

Change the appearance of this atom when a material is applied?

var
mat_changedesc
–

Change the desc of this atom when a material is applied?

var
mat_changename
–

Change the name of this atom when a material is applied?

var
material_applied_appearance
–

Whether the last material applied updated appearance. Used for re-applying material appearance on icon update

var
open_to_sound
–

If hear_talk is triggered on this object, make my contents hear_talk as well

var
pass_unstable
– /tmp

Whether pathfinding is forbidden from caching the passability of this atom. See /turf/passability_cache

var
pixel_point
–

Should points thrown at this take into account the click pixel value

var
pulled_by
– /mob

Which mob is pulling this atom currently

var
reagents
– /datum/reagents

Chemistry.

var
rest_mult
–

A multiplier that changes how an atom stands up from resting. Yes.

var
statusEffects
– /list/datum/statusEffect

List of status effects

var
storage
– /datum/storage

Storage for items

var
texture_size
–

Override for the texture size used by setTexture.

typeinfo_type
–

The base type for nearly all physical objects in SS13

Lots of functionality resides in this type.

var
uses_default_material_appearance
–

Does this object use appearance from the default material?

var
uses_default_material_name
–

Does this object use the default material's name?

Proc Details

proc
Attackby
(/obj/item/W, /mob/user, params, is_special, silent)

wrapper proc for /atom/proc/attackby so that signals are always sent. Call this, but do not override it.

proc
CheckExit
(/atom/movable/mover, /turf/target, do_bump)

Wrapper around Uncross for when you want to call it manually with a target turf

proc
Cross
(/atom/movable/mover)

This is the proc to check if a movable can cross this atom. DO NOT put side effects in this proc, it is called for pathfinding Seriously I mean it, you think it'll be fine and then it causes the teleporting gene booth bug

proc
MouseDrop
(/atom/over_object, src_location, over_location, src_control, over_control, params)

Override mouse_drop instead of this. Call this instead of mouse_drop, but you probably shouldn't!

proc
Uncross
(/atom/movable/O, do_bump)

Override and return FALSE to prevent O from moving out of the tile where src is. In order to override this properly be sure to have the do_bump = TRUE default argument AND to call UNCROSS_BUMP_CHECK(O) in all branches where the return value can be FALSE (assign this return value to . instead of doing an explicit return).

proc
UpdateIcon
(...)

Call this proc inplace of update_icon(...)

proc
_MouseDrop_T
(dropped, user, src_location, over_location, src_control, over_control, params)

Override MouseDrop_T instead of this. Call this instead of MouseDrop_T, but you probably shouldn't!

proc
add_fingerprint
(/mob/living/M, hidden_only)

Add a mob's fingerprint to something. If hidden_only is TRUE, only add to admin-visible prints.

proc
add_fingerprint_direct
(print)

Add a fingerprint to an atom directly. Doesn't interact with hidden prints at all

proc
add_sm_light
(id, /list/rgba, medium, directional)

light.pixel_x = (vx * min(dist,light.dist) * 32) - 32

proc
admin_visible_name
()

A proc to give this item a special name when viewed in an admin context (just the tilde-rightclick menu for now but probably other places later)

proc
attackby
(/obj/item/W, /mob/user, params, is_special, silent)

internal proc for when an atom is attacked by an item. Override this, but do not call it,

proc
blob_act
(power)

BLOB RELATED PROCS

proc
changeStatus
(statusId, duration, optional)

If atom has status with {statusId}, change by {duration}.

(The change is relative to the current value, think +=) If atom does not have status, add it with given {duration}. In both cases {optional} will be passed into either .onAdd or .onChange on the status effect. Useful for custom behaviour.

Returns: The changed/added status effect or null on errors.

proc
contains
(/atom/A)

Returns true if the given atom is within src's contents (deeply/recursively)

proc
contents_ui_distance
(src_object, /mob/living/user)

public

Check the distance for a living mob. Really only used for checks outside the context of a mob. Otherwise, use shared_living_ui_distance().

required src_object The object which owns the UI. required user mob The mob who opened/is using the UI.

return UI_state The state of the UI.

proc
create_reagents
(max_vol)

Convenience proc to create a reagents holder for an atom Max vol is maximum volume of holder

proc
create_storage
(storage_type, /list/spawn_contents, /list/can_hold, /list/can_hold_exact, /list/prevent_holding, check_wclass, max_wclass, slots, sneaky, stealthy_storage, opens_if_worn, /list/params)

add storage to an atom

proc
damage_blunt
(amount)

Does x blunt damage to the atom

proc
damage_cold
(amount)

Does x cold damage to the atom

proc
damage_corrosive
(amount)

Does x corrosive damage to the atom

proc
damage_electricity
(amount)

Does x electricity damage to the atom

proc
damage_heat
(amount)

does x heat damage to the atom

proc
damage_piercing
(amount)

Does x piercing damage to the atom

proc
damage_radiation
(amount)

Does x radiation damage to the atom

proc
damage_slashing
(amount)

Does x slashing damage to the atom

proc
delStatus
(status)

Deletes the given status from the atom.

{status} can either be a reference to a status effect or a status effect ID.

proc
gas_cross
(/turf/target)

Checks whether or not gases can pass through. Called by /turf/gas_cross for all atoms within the turf. Returns: TRUE for allowed pass and FALSE for denied pass.

proc
getStatusDuration
(statusId)

Returns duration of status with given {statusId}, or null if not found.

proc
getStatusList
(statusId, optionalArgs)

Returns a list of all the datum/statusEffect on source atom.

{statusId} optional status ID to match, otherwise matches any status type {optionalArgs} can be passed in for additional checks that are handled in the effects .onCheck proc. Useful if you want to check some custom conditions on status effects.

proc
getStatusPrototype
(statusId)

Returns prototype of status effect from the globalStatusPrototypes list with given {statusId}, or null if not found

proc
get_connected_directions_bitflag
(/list/valid_atoms, /list/exceptions, cross_areas, connect_diagonal)

Return a bitflag that represents all potential connected icon_states

connecting with diagonal tiles require additional bitflags i.e. there is a difference between N & E, and N & E & NE

N, S, E, W, NE, SE, SW, NW

1, 2, 4, 8, 16, 32, 64, 128

connect_diagonals 0 = no diagonal sprites, 1 = diagonal only if both adjacent cardinals are present, 2 = always allow diagonals

proc
get_help_message
(dist, /mob/user)

Override this if you want the alt+doubleclick help message to be dynamic (for example based on the state of deconstruction). For consistency you should always also override help_message at least to a placeholder never-to-be-seen string, this is important for the context menu functionality. Use the HELP_MESSAGE_OVERRIDE macro to do that.

proc
hasStatus
(statusId, optionalArgs)

Returns first status with given {statusId} or null if not found.

{optionalArgs} can be passed in for additional checks that are handled in the effects .onCheck proc. Useful if you want to check some custom conditions on status effects.

proc
help_verb_dynamic
()

Same as help_verb but this one except visible, added dynamically when requested by signals

proc
is_open_container
(input)

Convenience proc to see if a container is open for chemistry handling Takes an argument of whether this openness is for the purpose of pouring something in or not (this should maybe just be a separate flag but we ran out of bits okay) returns true if open, false if closed

proc
material_on_attack_use
(/mob/attacker, /atom/attacked)

Called when an atom is used for an attack a atom for mat effects

proc
material_trigger_on_blob_attacked
(blobPower, situation_modifier)

Called when an atom or someone wearing the material is attacked for mat effects

proc
material_trigger_on_bullet
(/atom/attacked, /obj/projectile/projectile, situation_modifier)

Called when an atom is hit by a bullet for mat effects

proc
material_trigger_on_chems
(chem, amount)

Called when an atom is hit by a bullet for mat effects

proc
material_trigger_on_explosion
(severity)

Called when an atom is caught in an explosion

proc
material_trigger_on_mob_attacked
(/mob/attacker, /mob/attacked, /atom/weapon, situation_modifier)

Called when a mob holding this atom is attacked for mat effects

proc
material_trigger_on_temp
(temperature_applied)

Called when an atom is affected by a heat change

proc
material_trigger_when_attacked
(/atom/attackatom, /mob/attacker, meleeorthrow, situation_modifier)

Called when the item is attacked with another atom for mat effects. If someone is smashed against the item or with hands, the mob itself is expected to be passed as attackatom

proc
onMaterialChanged
()

Called AFTER the material of the object was changed.

proc
removeMaterial
()

Simply removes a material from an object.

proc
remove_storage
()

remove atom's storage

proc
setMaterial
(/datum/material/mat1, appearance, setname, mutable, use_descriptors)

Sets the material of an object. PLEASE USE THIS TO SET MATERIALS UNLESS YOU KNOW WHAT YOU'RE DOING.

proc
setMaterialAppearance
(/datum/material/mat1)

sets the appearance of a material, but does not trigger any tiggerOnAdd or onMaterialChanged behaviour Order of precedence is as follows: if the material is in the list of appearences to ignore, do nothing If an iconstate exists in the icon for iconstate$$materialID, that is chosen If the material has mat_changeappaerance set, then first texture is applied, then color (including alpha)

proc
setMaterialAppearanceForImage
(/image/img, /datum/material/mat)

Applies material icon_state override to an /image based on this atom's material (or the material provided)

proc
setStatus
(statusId, duration, optional)

If atom has status with {statusId}, set it to {duration}.

(The change is absolute, think =)

If atom does not have status, add it with given {duration}.

In both cases {optional} will be passed into either .onAdd or .onChange on the status effect. Useful for custom behaviour.

Returns: The changed/added status effect or null on errors.

proc
set_icon_state
(new_state)

Changes the icon state and returns TRUE if the icon state changed.

proc
set_open_container
(value)

Set a container to be open or closed and handle chemistry reactions that might happen as a result

proc
should_auto_connect
(/turf/T, connect_to, /list/exceptions, cross_areas)

Check a turf and its contents to see if they're a valid auto-connection target

proc
special_desc
(dist, /mob/user)

a proc to completely override the standard formatting for examine text
- to prevent more copy paste

proc
temperature_expose
(/datum/gas_mixture/air, exposed_temperature, exposed_volume, cannot_be_cooled)

Exposes our reagents and material to some temperature, letting them figure out how to react to it.

proc
tri_message
(/atom/second_target, viewer_message, first_message, second_message, blind_message)

Used in messages with three separate parties that should receive different messages second_target - the second individual involved in the interaction, with the source atom being the first individual viewer_message - the message shown to observers that aren't specified targets first_message - the message shown to the atom this proc is called from second_message - the message shown to second_target blind_message (optional) is what blind people will hear, e.g. "You hear something!" Observers in range of either target will see the message, so the proc can be called on either target

proc
try_set_icon_state
(new_state, new_icon)

Checks if the icon state in question exists. If it does it sets it and returns true. Otherwise returns false and doesn't change the icon state. You can supply the new_icon argument to also override src.icon. This will again only be overriden if the icon state + icon combination exists. Not intended for normal use. Current intended use is stuff like src.try_set_icon_state(src.icon_state + "-autumn") for seasonal modifiers etc.

proc
updateStatusUi
()

Stub. Override for objects that need to update their ui with status effect information.

proc
update_icon
(...)

DO NOT CALL THIS PROC - Call UpdateIcon(...) Instead!

Only override this proc!

/atom inherits /datum

Vars

Procs

Var Details

var chat_text – /obj/chat_maptext_holder

var default_material –

var filter_data – /list/list

var gas_impermeable –

var help_message –

var level –

var mat_changeappearance –

var mat_changedesc –

var mat_changename –

var material_applied_appearance –

var open_to_sound –

var pass_unstable – /tmp

var pixel_point –

var pulled_by – /mob

var reagents – /datum/reagents

var rest_mult –

var statusEffects – /list/datum/statusEffect

var storage – /datum/storage

var texture_size –

typeinfo_type –

var uses_default_material_appearance –

var uses_default_material_name –

Proc Details

proc Attackby(/obj/item/W, /mob/user, params, is_special, silent)

proc CheckExit(/atom/movable/mover, /turf/target, do_bump)

proc Cross(/atom/movable/mover)

proc MouseDrop(/atom/over_object, src_location, over_location, src_control, over_control, params)

proc Uncross(/atom/movable/O, do_bump)

proc UpdateIcon(...)

proc _MouseDrop_T(dropped, user, src_location, over_location, src_control, over_control, params)

proc add_fingerprint(/mob/living/M, hidden_only)

proc add_fingerprint_direct(print)

proc add_sm_light(id, /list/rgba, medium, directional)

proc admin_visible_name()

proc attackby(/obj/item/W, /mob/user, params, is_special, silent)

proc blob_act(power)

proc changeStatus(statusId, duration, optional)

proc contains(/atom/A)

proc contents_ui_distance(src_object, /mob/living/user)

proc create_reagents(max_vol)

proc create_storage(storage_type, /list/spawn_contents, /list/can_hold, /list/can_hold_exact, /list/prevent_holding, check_wclass, max_wclass, slots, sneaky, stealthy_storage, opens_if_worn, /list/params)

proc damage_blunt(amount)

proc damage_cold(amount)

proc damage_corrosive(amount)

proc damage_electricity(amount)

proc damage_heat(amount)

proc damage_piercing(amount)

proc damage_radiation(amount)

proc damage_slashing(amount)

proc delStatus(status)

proc gas_cross(/turf/target)

proc getStatusDuration(statusId)

proc getStatusList(statusId, optionalArgs)

proc getStatusPrototype(statusId)

proc get_connected_directions_bitflag(/list/valid_atoms, /list/exceptions, cross_areas, connect_diagonal)

proc get_help_message(dist, /mob/user)

proc hasStatus(statusId, optionalArgs)

proc help_verb_dynamic()

proc is_open_container(input)

proc material_on_attack_use(/mob/attacker, /atom/attacked)

proc material_trigger_on_blob_attacked(blobPower, situation_modifier)

proc material_trigger_on_bullet(/atom/attacked, /obj/projectile/projectile, situation_modifier)

proc material_trigger_on_chems(chem, amount)

proc material_trigger_on_explosion(severity)

proc material_trigger_on_mob_attacked(/mob/attacker, /mob/attacked, /atom/weapon, situation_modifier)

proc material_trigger_on_temp(temperature_applied)

proc material_trigger_when_attacked(/atom/attackatom, /mob/attacker, meleeorthrow, situation_modifier)

proc onMaterialChanged()

proc removeMaterial()

proc remove_storage()

proc setMaterial(/datum/material/mat1, appearance, setname, mutable, use_descriptors)

proc setMaterialAppearance(/datum/material/mat1)

proc setMaterialAppearanceForImage(/image/img, /datum/material/mat)

proc setStatus(statusId, duration, optional)

proc set_icon_state(new_state)

proc set_open_container(value)