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
buckle_lying	Bed-like behaviour, forces mob.lying = buckle_lying if not set to NO_BUCKLE_LYING.
can_be_unanchored	Used for the calculate_adjacencies proc for icon smoothing.
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
face_mouse	Whether a user will face atoms on entering them with a mouse. Despite being a mob variable, it is here for performance
generic_canpass	If false makes CanPass call CanPassThrough on this type instead of using default behaviour
important_recursive_contents	an associative lazylist of relevant nested contents by "channel", the list is of the form: list(channel = list(important nested contents of that type)) each channel has a specific purpose and is meant to replace potentially expensive nested contents iteration do NOT add channels to this for little reason as it can add considerable memory usage.
movement_type	In case you have multiple types, you automatically use the most useful one. IE: Skating on ice, flippers on water, flying over chasm/space, etc. Should only be changed through setMovetype()
pass_flags	Things we can pass through while moving. If any of this matches the thing we're trying to pass's [pass_flags_self], then we can pass through.
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
CanReach	A backwards depth-limited breadth-first-search to see if the target is logically "in" anything adjacent to us.
Crossed	default byond proc that is deprecated for us in lieu of signals. do not call
Process_Spacemove	Called whenever an object moves and by mobs when they attempt to move themselves through space And when an object or action applies a force on src, see newtonian_move
Uncross	`Uncross()` is a default BYOND proc that is called when something is going to exit this atom's turf. It is prefered over `Uncrossed` when you want to deny that movement, such as in the case of border objects, objects that allow you to walk through them in any direction except the one they block (think side windows).
Uncrossed	default byond proc that is normally called on everything inside the previous turf a movable was in after moving to its current turf this is wasteful since the vast majority of objects do not use Uncrossed use connect_loc to register to COMSIG_ATOM_EXITED instead
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.
attacked_by	Called from /obj/item/proc/attack_obj and /obj/item/proc/attack if the attack succeeds
become_area_sensitive	See traits.dm. Use this in place of ADD_TRAIT.
become_hearing_sensitive	allows this movable to hear and adds itself to the important_recursive_contents list of itself and every movable loc its in
can_speak_language	Checks if atom can speak the language.
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.
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.
is_buckle_possible	Simple helper proc that runs a suite of checks to test whether it is possible or not to buckle the target mob to src.
is_user_buckle_possible	Simple helper proc that runs a suite of checks to test whether it is possible or not for user to buckle target mob to src.
newtonian_move	Only moves the object if it's under no gravity
on_changed_z_level	Called when a movable changes z-levels.
on_enter_storage	called when this atom is added into a storage item, which is passed on as S. The loc variable is already set to the storage item.
on_exit_storage	called when this atom is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.
on_virtual_z_change	Called when an atom moves to a different virtual z. Warning, it will pass z-level 0 in new_virtual_z on creation and 0 in previous_virtual_z whenever moved to nullspace
on_z_change	zMove already handles whether a pull from another movable should be broken.
point_at	Point at an atom
relay_container_resist_act	called when a mob resists while inside a container that is itself inside something.
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
setMovetype	Proc to modify the movement_type and hook behavior associated with it changing.
set_anchored	Sets the anchored var and returns if it was sucessfully changed or not.
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.
throw_at	If this returns FALSE then callback will not be called.
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.

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
buckle_lying
–

Bed-like behaviour, forces mob.lying = buckle_lying if not set to NO_BUCKLE_LYING.

var
can_be_unanchored
–

Used for the calculate_adjacencies proc for icon smoothing.

var
demo_last_loc
– /atom

Last location of the atom for demo recording purposes

var
em_block
– /atom/movable/emissive_blocker

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

var
face_mouse
–

Whether a user will face atoms on entering them with a mouse. Despite being a mob variable, it is here for performance

var
generic_canpass
–

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

var
important_recursive_contents
– /list

an associative lazylist of relevant nested contents by "channel", the list is of the form: list(channel = list(important nested contents of that type)) each channel has a specific purpose and is meant to replace potentially expensive nested contents iteration do NOT add channels to this for little reason as it can add considerable memory usage.

var
movement_type
–

In case you have multiple types, you automatically use the most useful one. IE: Skating on ice, flippers on water, flying over chasm/space, etc. Should only be changed through setMovetype()

var
pass_flags
–

Things we can pass through while moving. If any of this matches the thing we're trying to pass's [pass_flags_self], then we can pass through.

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, movement_dir, blocker_opinion)

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

proc
CanReach
(/atom/ultimate_target, /obj/item/tool, view_only)

A backwards depth-limited breadth-first-search to see if the target is logically "in" anything adjacent to us.

Crossed
(/atom/movable/crossed_atom, oldloc)

default byond proc that is deprecated for us in lieu of signals. do not call

proc
Process_Spacemove
(movement_dir)

Called whenever an object moves and by mobs when they attempt to move themselves through space And when an object or action applies a force on src, see newtonian_move

Return 0 to have src start/keep drifting in a no-grav area and 1 to stop/not start drifting

Mobs should return 1 if they should be able to move of their own volition, see /client/Move

Arguments:

movement_dir - 0 when stopping or any dir when trying to move

Uncross
()

Uncross() is a default BYOND proc that is called when something is going to exit this atom's turf. It is prefered over Uncrossed when you want to deny that movement, such as in the case of border objects, objects that allow you to walk through them in any direction except the one they block (think side windows).

While being seemingly harmless, most everything doesn't actually want to use this, meaning that we are wasting proc calls for every single atom on a turf, every single time something exits it, when basically nothing cares.

This overhead caused real problems on Sybil round #159709, where lag attributed to Uncross was so bad that the entire master controller collapsed and people made Among Us lobbies in OOC.

If you want to replicate the old Uncross() behavior, the most apt replacement is [/datum/element/connect_loc] while hooking onto [COMSIG_ATOM_EXIT].

Uncrossed
(/atom/movable/uncrossed_atom)

default byond proc that is normally called on everything inside the previous turf a movable was in after moving to its current turf this is wasteful since the vast majority of objects do not use Uncrossed use connect_loc to register to COMSIG_ATOM_EXITED instead

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
attacked_by
()

Called from /obj/item/proc/attack_obj and /obj/item/proc/attack if the attack succeeds

proc
become_area_sensitive
(trait_source)

See traits.dm. Use this in place of ADD_TRAIT.

proc
become_hearing_sensitive
(trait_source)

allows this movable to hear and adds itself to the important_recursive_contents list of itself and every movable loc its in

proc
can_speak_language
(language)

Checks if atom can speak the language.

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
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
is_buckle_possible
(/mob/living/target, force, check_loc)

Simple helper proc that runs a suite of checks to test whether it is possible or not to buckle the target mob to src.

Returns FALSE if any conditions that should prevent buckling are satisfied. Returns TRUE otherwise. Arguments:

target - Target mob to check against buckling to src.
force - Whether or not the buckle should be forced. If TRUE, ignores src's can_buckle var.
check_loc - Whether to do a proximity check or not. The proximity check looks for target.loc == src.loc.

proc
is_user_buckle_possible
(/mob/living/target, /mob/user, check_loc)

Simple helper proc that runs a suite of checks to test whether it is possible or not for user to buckle target mob to src.

Returns FALSE if any conditions that should prevent buckling are satisfied. Returns TRUE otherwise. Arguments:

target - Target mob to check against buckling to src.
user - The mob who is attempting to buckle the target to src.
check_loc - Whether to do a proximity check or not when calling is_buckle_possible().

proc
newtonian_move
(direction)

Only moves the object if it's under no gravity

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

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
on_enter_storage
(/datum/component/storage/concrete/master_storage)

called when this atom is added into a storage item, which is passed on as S. The loc variable is already set to the storage item.

proc
on_exit_storage
(/datum/component/storage/concrete/master_storage)

called when this atom is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.

proc
on_virtual_z_change
(new_virtual_z, previous_virtual_z)

Called when an atom moves to a different virtual z. Warning, it will pass z-level 0 in new_virtual_z on creation and 0 in previous_virtual_z whenever moved to nullspace

proc
on_z_change
(old_z, new_z)

zMove already handles whether a pull from another movable should be broken.

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
relay_container_resist_act
(/mob/living/user, /obj/O)

called when a mob resists while inside a container that is itself inside something.

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
setMovetype
(newval)

Proc to modify the movement_type and hook behavior associated with it changing.

proc
set_anchored
(anchorvalue)

Sets the anchored var and returns if it was sucessfully changed or not.

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.

proc
throw_at
(/atom/target, range, speed, /mob/thrower, spin, diagonals_first, /datum/callback/callback, force, gentle, quickstart)

If this returns FALSE then callback will not be called.

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.

movable /atom/movable

Vars

Procs

Var Details

var affected_dynamic_lights – /list

var affecting_dynamic_lumi –

var blocks_emissive –

var buckle_lying –

var can_be_unanchored –

var demo_last_loc – /atom

var em_block – /atom/movable/emissive_blocker

var face_mouse –

var generic_canpass –

var important_recursive_contents – /list

var movement_type –

var pass_flags –

var set_dir_on_move –

Proc Details

proc CanPassThrough(/atom/blocker, movement_dir, blocker_opinion)

proc CanReach(/atom/ultimate_target, /obj/item/tool, view_only)

Crossed(/atom/movable/crossed_atom, oldloc)

proc Process_Spacemove(movement_dir)

Uncross()

Uncrossed(/atom/movable/uncrossed_atom)

proc abstract_move(/atom/new_loc)

proc add_blocked_language(language, source)

proc attacked_by()

proc become_area_sensitive(trait_source)

proc become_hearing_sensitive(trait_source)

proc can_speak_language(language)

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 grant_all_languages(understood, spoken, grant_omnitongue, source)

proc grant_language(language, understood, spoken, source)

proc has_language(language, spoken)

proc is_buckle_possible(/mob/living/target, force, check_loc)

proc is_user_buckle_possible(/mob/living/target, /mob/user, check_loc)

proc newtonian_move(direction)

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

proc on_enter_storage(/datum/component/storage/concrete/master_storage)

proc on_exit_storage(/datum/component/storage/concrete/master_storage)

proc on_virtual_z_change(new_virtual_z, previous_virtual_z)

proc on_z_change(old_z, new_z)

proc point_at(/atom/pointed_atom)

proc relay_container_resist_act(/mob/living/user, /obj/O)

proc remove_all_languages(source, remove_omnitongue)

proc remove_blocked_language(language, source)

proc remove_language(language, understood, spoken, source)

proc setGrabState(newstate)

proc setMovetype(newval)

proc set_anchored(anchorvalue)

proc set_light_range_power_color(range, power, color)

proc set_pulledby(new_pulledby)

proc throw_at(/atom/target, range, speed, /mob/thrower, spin, diagonals_first, /datum/callback/callback, force, gentle, quickstart)

proc update_atom_languages()

proc update_dynamic_luminosity()