/atom/movable

Vars
affected_dynamic_lights	Lazylist to keep track on the sources of illumination.
affecting_dynamic_lumi	Highest-intensity light affecting us, which determines our visibility.
blocks_emissive	Either FALSE, EMISSIVE_BLOCK_GENERIC, or EMISSIVE_BLOCK_UNIQUE
can_be_unanchored	Used for the calculate_adjacencies proc for icon smoothing.
contents_pressure_protection	The degree of pressure protection that mobs in list/contents have from the external environment, between 0 and 1
contents_thermal_insulation	The degree of thermal insulation that mobs in list/contents have from the external environment, between 0 and 1
currently_z_moving	is the mob currently ascending or descending through z levels?
demo_last_loc	Last location of the atom for demo recording purposes
em_block	Internal holder for emissive blocker object, do not use directly use blocks_emissive
generic_canpass	If false makes CanPass call CanPassThrough on this type instead of using default behaviour
set_dir_on_move	Whether this atom should have its dir automatically changed when it moves. Setting this to FALSE allows for things such as directional windows to retain dir on moving without snowflake code all of the place.
Procs
CanPassThrough	Returns true or false to allow src to move through the blocker, mover has final say
Moved	Called after a successful Move(). By this point, we've already moved. Arguments:
abstract_move	meant for movement with zero side effects. only use for objects that are supposed to move "invisibly" (like camera mobs or ghosts) if you want something to move onto a tile with a beartrap or recycler or tripmine or mouse without that object knowing about it at all, use this most of the time you want forceMove()
add_blocked_language	Adds a language to the blocked language list. Use this over remove_language in cases where you will give languages back later.
can_speak_language	Checks if atom can speak the language.
can_z_move	Checks if the destination turf is elegible for z movement from the start turf to a given direction and returns it if so. Args:
check_pulling	Checks if the pulling and pulledby should be stopped because they're out of reach. If z_allowed is TRUE, the z level of the pulling will be ignored.This is to allow things to be dragged up and down stairs.
copy_languages	Copies all languages into the supplied atom/language holder. Source should be overridden when you do not want the language overwritten by later atom updates or want to avoid blocked languages.
could_speak_language	Returns the result of tongue specific limitations on spoken languages.
get_language_holder	Gets or creates the relevant language holder. For mindless atoms, gets the local one. For atom with mind, gets the mind one.
get_random_spoken_language	Gets a random spoken language, useful for forced speech and such.
get_random_understood_language	Gets a random understood language, useful for hallucinations and such.
get_selected_language	Returns selected language, if it can be spoken, or finds, sets and returns a new selected language if possible.
get_z_move_affected	Returns a list of movables that should also be affected when src moves through zlevels, and src.
grant_all_languages	Grants every language.
grant_language	Grants the supplied language and sets omnitongue true.
has_language	Checks if atom has the language. If spoken is true, only checks if atom can speak the language.
move_from_pull	Called when src is being moved to a target turf because another movable (puller) is moving around.
onShuttleMove	Called on atoms to move the atom to the new location
on_changed_z_level	zMove already handles whether a pull from another movable should be broken. Called when a movable changes z-levels.
point_at	Point at an atom
remove_all_languages	Removes every language and sets omnitongue false.
remove_blocked_language	Removes a language from the blocked language list.
remove_language	Removes a single language.
setGrabState	Updates the grab state of the movable
set_currently_z_moving	Sets the currently_z_moving variable to a new value. Used to allow some zMovement sources to have precedence over others.
set_light_range_power_color	Helper to change several lighting overlay settings.
set_pulledby	Reports the event of the change in value of the pulledby variable.
shuttleRotate	Base /atom/movable proc
update_atom_languages	Empties out the atom specific languages and updates them according to the current atoms language holder. As a side effect, it also creates missing language holders in the process.
update_dynamic_luminosity	Keeps track of the sources of dynamic luminosity and updates our visibility with the highest.
update_overlays	Any color becomes white. Anything else is black, and it's fully opaque Ought to work

Var Details

var
affected_dynamic_lights
– /list

Lazylist to keep track on the sources of illumination.

var
affecting_dynamic_lumi
–

Highest-intensity light affecting us, which determines our visibility.

var
blocks_emissive
–

Either FALSE, EMISSIVE_BLOCK_GENERIC, or EMISSIVE_BLOCK_UNIQUE

var
can_be_unanchored
–

Used for the calculate_adjacencies proc for icon smoothing.

var
contents_pressure_protection
–

The degree of pressure protection that mobs in list/contents have from the external environment, between 0 and 1

var
contents_thermal_insulation
–

The degree of thermal insulation that mobs in list/contents have from the external environment, between 0 and 1

var
currently_z_moving
–

is the mob currently ascending or descending through z levels?

var
demo_last_loc
– /atom

Last location of the atom for demo recording purposes

var
em_block
– /atom/movable/render_step/emissive_blocker

Internal holder for emissive blocker object, do not use directly use blocks_emissive

var
generic_canpass
–

If false makes CanPass call CanPassThrough on this type instead of using default behaviour

var
set_dir_on_move
–

Whether this atom should have its dir automatically changed when it moves. Setting this to FALSE allows for things such as directional windows to retain dir on moving without snowflake code all of the place.

Proc Details

proc
CanPassThrough
(/atom/blocker, /turf/target, blocker_opinion)

Returns true or false to allow src to move through the blocker, mover has final say

proc
Moved
(/atom/old_loc, movement_dir, forced, /list/old_locs, momentum_change)

Called after a successful Move(). By this point, we've already moved. Arguments:

old_loc is the location prior to the move. Can be null to indicate nullspace.
movement_dir is the direction the movement took place. Can be NONE if it was some sort of teleport.
The forced flag indicates whether this was a forced move, which skips many checks of regular movement.
The old_locs is an optional argument, in case the moved movable was present in multiple locations before the movement.
momentum_change represents whether this movement is due to a "new" force if TRUE or an already "existing" force if FALSE

proc
abstract_move
(/atom/new_loc)

meant for movement with zero side effects. only use for objects that are supposed to move "invisibly" (like camera mobs or ghosts) if you want something to move onto a tile with a beartrap or recycler or tripmine or mouse without that object knowing about it at all, use this most of the time you want forceMove()

proc
add_blocked_language
(language, source)

Adds a language to the blocked language list. Use this over remove_language in cases where you will give languages back later.

proc
can_speak_language
(language)

Checks if atom can speak the language.

proc
can_z_move
(direction, /turf/start, /turf/destination, z_move_flags, /mob/living/rider)

Checks if the destination turf is elegible for z movement from the start turf to a given direction and returns it if so. Args:

direction: the direction to go, UP or DOWN, only relevant if target is null.
start: Each destination has a starting point on the other end. This is it. Most of the times the location of the source.
z_move_flags: bitflags used for various checks. See __DEFINES/movement.dm.
rider: A living mob in control of the movable. Only non-null when a mob is riding a vehicle through z-levels.

proc
check_pulling
(only_pulling, z_allowed)

Checks if the pulling and pulledby should be stopped because they're out of reach. If z_allowed is TRUE, the z level of the pulling will be ignored.This is to allow things to be dragged up and down stairs.

proc
copy_languages
(from_holder, source_override)

Copies all languages into the supplied atom/language holder. Source should be overridden when you do not want the language overwritten by later atom updates or want to avoid blocked languages.

proc
could_speak_language
(language)

Returns the result of tongue specific limitations on spoken languages.

proc
get_language_holder
(get_minds)

Gets or creates the relevant language holder. For mindless atoms, gets the local one. For atom with mind, gets the mind one.

proc
get_random_spoken_language
()

Gets a random spoken language, useful for forced speech and such.

proc
get_random_understood_language
()

Gets a random understood language, useful for hallucinations and such.

proc
get_selected_language
()

Returns selected language, if it can be spoken, or finds, sets and returns a new selected language if possible.

proc
get_z_move_affected
(z_move_flags)

Returns a list of movables that should also be affected when src moves through zlevels, and src.

proc
grant_all_languages
(understood, spoken, grant_omnitongue, source)

Grants every language.

proc
grant_language
(language, understood, spoken, source)

Grants the supplied language and sets omnitongue true.

proc
has_language
(language, spoken)

Checks if atom has the language. If spoken is true, only checks if atom can speak the language.

proc
move_from_pull
(/atom/movable/puller, /turf/target_turf, glide_size_override)

Called when src is being moved to a target turf because another movable (puller) is moving around.

proc
onShuttleMove
(/turf/newT, /turf/oldT, /list/movement_force, move_dir, /obj/docking_port/stationary/old_dock, /obj/docking_port/mobile/moving_dock)

Called on atoms to move the atom to the new location

proc
on_changed_z_level
(/turf/old_turf, /turf/new_turf, same_z_layer, notify_contents)

zMove already handles whether a pull from another movable should be broken. Called when a movable changes z-levels.

Arguments:

old_turf - The previous turf they were on before.
new_turf - The turf they have now entered.
same_z_layer - If their old and new z levels are on the same level of plane offsets or not
notify_contents - Whether or not to notify the movable's contents that their z-level has changed. NOTE, IF YOU SET THIS, YOU NEED TO MANUALLY SET PLANE OF THE CONTENTS LATER

proc
point_at
(/atom/pointed_atom)

Point at an atom

Intended to enable and standardise the pointing animation for all atoms

Not intended as a replacement for the mob verb

proc
remove_all_languages
(source, remove_omnitongue)

Removes every language and sets omnitongue false.

proc
remove_blocked_language
(language, source)

Removes a language from the blocked language list.

proc
remove_language
(language, understood, spoken, source)

Removes a single language.

proc
setGrabState
(newstate)

Updates the grab state of the movable

This exists to act as a hook for behaviour

proc
set_currently_z_moving
(new_z_moving_value, forced)

Sets the currently_z_moving variable to a new value. Used to allow some zMovement sources to have precedence over others.

proc
set_light_range_power_color
(range, power, color)

Helper to change several lighting overlay settings.

proc
set_pulledby
(new_pulledby)

Reports the event of the change in value of the pulledby variable.

↑
shuttleRotate
(rotation, params)

Base /atom/movable proc

proc
update_atom_languages
()

Empties out the atom specific languages and updates them according to the current atoms language holder. As a side effect, it also creates missing language holders in the process.

proc
update_dynamic_luminosity
()

Keeps track of the sources of dynamic luminosity and updates our visibility with the highest.

↑
update_overlays
()

Any color becomes white. Anything else is black, and it's fully opaque Ought to work

/atom/movable

Vars

Procs

Var Details

var affected_dynamic_lights – /list

var affecting_dynamic_lumi –

var blocks_emissive –

var can_be_unanchored –

var contents_pressure_protection –

var contents_thermal_insulation –

var currently_z_moving –

var demo_last_loc – /atom

var em_block – /atom/movable/render_step/emissive_blocker

var generic_canpass –

var set_dir_on_move –

Proc Details

proc CanPassThrough(/atom/blocker, /turf/target, blocker_opinion)

proc Moved(/atom/old_loc, movement_dir, forced, /list/old_locs, momentum_change)

proc abstract_move(/atom/new_loc)

proc add_blocked_language(language, source)

proc can_speak_language(language)

proc can_z_move(direction, /turf/start, /turf/destination, z_move_flags, /mob/living/rider)

proc check_pulling(only_pulling, z_allowed)

proc copy_languages(from_holder, source_override)

proc could_speak_language(language)

proc get_language_holder(get_minds)

proc get_random_spoken_language()

proc get_random_understood_language()

proc get_selected_language()

proc get_z_move_affected(z_move_flags)

proc grant_all_languages(understood, spoken, grant_omnitongue, source)

proc grant_language(language, understood, spoken, source)

proc has_language(language, spoken)

proc move_from_pull(/atom/movable/puller, /turf/target_turf, glide_size_override)

proc onShuttleMove(/turf/newT, /turf/oldT, /list/movement_force, move_dir, /obj/docking_port/stationary/old_dock, /obj/docking_port/mobile/moving_dock)

proc on_changed_z_level(/turf/old_turf, /turf/new_turf, same_z_layer, notify_contents)

proc point_at(/atom/pointed_atom)

proc remove_all_languages(source, remove_omnitongue)

proc remove_blocked_language(language, source)

proc remove_language(language, understood, spoken, source)

proc setGrabState(newstate)

proc set_currently_z_moving(new_z_moving_value, forced)

proc set_light_range_power_color(range, power, color)

proc set_pulledby(new_pulledby)

↑shuttleRotate(rotation, params)

proc update_atom_languages()

proc update_dynamic_luminosity()

↑update_overlays()