movable

Vars
blocks_emissive	Either FALSE, EMISSIVE_BLOCK_GENERIC, or EMISSIVE_BLOCK_UNIQUE
can_be_z_moved	Used for space ztransit stuff
client_mobs_in_contents	contains every client mob corresponding to every client eye in this container. lazily updated by SSparallax and is sparse: only the last container of a client eye has this list assuming no movement since SSparallax's last fire
em_block	Internal holder for emissive blocker object, do not use directly use blocks_emissive
floating_need_update	If we were without gravity and another animation happened, the bouncing will stop, and we need to restart it in next life().
generic_canpass	If false makes CanPass call CanPassThrough on this type instead of using default behaviour
initial_language_holder	What language holder type to init as
language_holder	Holds all languages this mob can speak and understand
last_yell	last time we yelled
move_packet	Holds information about any movement loops currently running/waiting to run on the movable. Lazy, will be null if nothing's going on
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. I reccomend you use the movetype_handler system and not modify this directly, especially for living mobs.
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.
spatial_grid_key	String representing the spatial grid groups we want to be held in. acts as a key to the list of spatial grid contents types we exist in via SSspatial_grid.spatial_grid_categories. We do it like this to prevent people trying to mutate them and to save memory on holding the lists ourselves
tooltips	Should we use tooltips, if the thing does not have the code implemented `get_tooltip_data()`, it will default to examine(src)
yell_power	How loudly we yell
Procs
CanPassThrough	Returns true or false to allow src to move through the blocker, mover has final say
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
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.
admin_teleport	Proc to hook user-enacted teleporting behavior and keep logging of the event.
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.
forceMove	FORCED MOVEMENT
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_tooltip_data	If set, will return a list for the tooltip (that will also be put together in a `Join()`) However, if returning `null`, the tooltip will not be shown as #14942 changed it.
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.
keybind_face_direction	A wrapper for setDir that should only be able to fail by living mobs.
mouse_buckle_handling	Does some typechecks and then calls user_buckle_mob
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.
point_at	Point at an atom
quoteless_say_quote	Quirky citadel proc for our custom sayverbs to strip the verb out. Snowflakey as hell, say rewrite 3.0 when?
recursive_pulled_glidesize_update	Recursively set glide size for atom's pulled things
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.
say_emphasis	Scans the input sentence for speech emphasis modifiers, notably \|italics\|, +bold+, and underline -mothblocks
setGrabState	Updates the grab state of the movable
setMovetype	Proc to modify the movement_type and hook behavior associated with it changing.
set_active_language	Sets the passed path as the active language Returns the currently selected language if successful, if the language was not valid, returns null
set_anchored	Sets the anchored var and returns if it was sucessfully changed or not.
set_bark	Sets the vocal bark for the atom, using the bark's ID
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.

Var Details

var
blocks_emissive
–

Either FALSE, EMISSIVE_BLOCK_GENERIC, or EMISSIVE_BLOCK_UNIQUE

var
can_be_z_moved
–

Used for space ztransit stuff

var
client_mobs_in_contents
– /list

contains every client mob corresponding to every client eye in this container. lazily updated by SSparallax and is sparse: only the last container of a client eye has this list assuming no movement since SSparallax's last fire

var
em_block
– /atom/movable/emissive_blocker

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

var
floating_need_update
–

If we were without gravity and another animation happened, the bouncing will stop, and we need to restart it in next life().

var
generic_canpass
–

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

var
initial_language_holder
–

What language holder type to init as

var
language_holder
– /datum/language_holder

Holds all languages this mob can speak and understand

var
last_yell
–

last time we yelled

var
move_packet
– /datum/movement_packet

Holds information about any movement loops currently running/waiting to run on the movable. Lazy, will be null if nothing's going on

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. I reccomend you use the movetype_handler system and not modify this directly, especially for living mobs.

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

String representing the spatial grid groups we want to be held in. acts as a key to the list of spatial grid contents types we exist in via SSspatial_grid.spatial_grid_categories. We do it like this to prevent people trying to mutate them and to save memory on holding the lists ourselves

var
tooltips
–

Should we use tooltips, if the thing does not have the code implemented get_tooltip_data(), it will default to examine(src)

var
yell_power
–

How loudly we yell

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
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 FALSE to have src start/keep drifting in a no-grav area and 1 to stop/not start drifting

Mobs should return TRUE if they should be able to move of their own volition, see [/client/proc/Move]

Arguments:

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

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
admin_teleport
(/atom/new_location, message)

Proc to hook user-enacted teleporting behavior and keep logging of the event.

proc
can_speak_language
(language)

Checks if atom can speak the language.

proc
copy_languages
(/datum/language_holder/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
forceMove
(/atom/destination)

FORCED MOVEMENT

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.

If set, will return a list for the tooltip (that will also be put together in a Join()) However, if returning null, the tooltip will not be shown as #14942 changed it.

Though no tooltips will be created for atoms that have tooltips = FALSE

proc
grant_all_languages
(language_flags, grant_omnitongue, source)

Grants every language.

proc
grant_language
(language, language_flags, source)

Grants the supplied language and sets omnitongue true.

proc
has_language
(language, flags_to_check)

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

proc
keybind_face_direction
(direction)

A wrapper for setDir that should only be able to fail by living mobs.

Called from [/atom/movable/proc/keyLoop], this exists to be overwritten by living mobs with a check to see if we're actually alive enough to change directions

proc
mouse_buckle_handling
(/mob/living/M, /mob/living/user)

Does some typechecks and then calls user_buckle_mob

Arguments: M - The mob being buckled to src user - The mob buckling M to src

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/S)

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/S)

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
point_at
(/atom/pointed_atom, params)

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
quoteless_say_quote
(input, /list/spans, message_mode)

Quirky citadel proc for our custom sayverbs to strip the verb out. Snowflakey as hell, say rewrite 3.0 when?

proc
recursive_pulled_glidesize_update
()

Recursively set glide size for atom's pulled things

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, language_flags, source)

Removes a single language.

proc
say_emphasis
(input)

Scans the input sentence for speech emphasis modifiers, notably |italics|, +bold+, and underline -mothblocks

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_active_language
(language_path)

Sets the passed path as the active language Returns the currently selected language if successful, if the language was not valid, returns null

proc
set_anchored
(anchorvalue)

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

proc
set_bark
(id)

Sets the vocal bark for the atom, using the bark's ID

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.

movable /atom/movable

Vars

Procs

Var Details

var blocks_emissive –

var can_be_z_moved –

var client_mobs_in_contents – /list

var em_block – /atom/movable/emissive_blocker

var floating_need_update –

var generic_canpass –

var initial_language_holder –

var language_holder – /datum/language_holder

var last_yell –

var move_packet – /datum/movement_packet

var movement_type –

var pass_flags –

var spatial_grid_key –

var tooltips –

var yell_power –

Proc Details

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

proc Process_Spacemove(movement_dir)

proc abstract_move(/atom/new_loc)

proc add_blocked_language(language, source)

proc admin_teleport(/atom/new_location, message)

proc can_speak_language(language)

proc copy_languages(/datum/language_holder/from_holder, source_override)

proc could_speak_language(language)

proc forceMove(/atom/destination)

proc get_language_holder(get_minds)

proc get_random_spoken_language()

proc get_random_understood_language()

proc get_selected_language()

proc get_tooltip_data()

proc grant_all_languages(language_flags, grant_omnitongue, source)

proc grant_language(language, language_flags, source)

proc has_language(language, flags_to_check)

proc keybind_face_direction(direction)

proc mouse_buckle_handling(/mob/living/M, /mob/living/user)

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/S)

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

proc point_at(/atom/pointed_atom, params)

proc quoteless_say_quote(input, /list/spans, message_mode)

proc recursive_pulled_glidesize_update()

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, language_flags, source)

proc say_emphasis(input)

proc setGrabState(newstate)

proc setMovetype(newval)

proc set_active_language(language_path)

proc set_anchored(anchorvalue)

proc set_bark(id)

proc set_pulledby(new_pulledby)

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