movable

Vars
active_movement	A list containing arguments for Moved().
blocks_emissive	Either FALSE, [EMISSIVE_BLOCK_GENERIC], or EMISSIVE_BLOCK_UNIQUE
buckle_lying	Bed-like behaviour, forces the mob to lie down if buckle_lying != -1
buckle_offset	The Pixel_y to offset the buckled mob by
buckle_prevents_pull	Can we pull the mob while they're buckled. Currently set to false on every movable
buckle_requires_restraints	Require people to be handcuffed before being able to buckle. eg: pipes
buckled_mobs	Lazylist of the mobs buckled to this object.
can_be_unanchored	Used for icon smoothing. Won't smooth if it ain't anchored and can be unanchored. Only set to true on windows
em_block	Internal holder for emissive blocker object, do not use directly use blocks_emissive
face_while_pulling	Face towards the atom while pulling it
inertia_move_delay	Delay in deciseconds between inertia based movement
inertia_moving	Are we moving with inertia? Mostly used as an optimization
last_pushoff	The last time we pushed off something This is a hack to get around dumb him him me scenarios
max_buckled_mobs	The max amount of mobs that can be buckled to this object. Currently set to 1 on every movable
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
moving_from_pull	attempt to resume grab after moving instead of before.
orbiting_uid	UID for the atom which the current atom is orbiting
scatter_distance	How far (in pixels) should this atom scatter when created/dropped/etc. Does not apply to mapped-in items.
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. PARA: Doesn't set this currently to maintain current behavior for pulling items around, because modifying direction on pull is expected.
thought_bubble_image	Icon state for thought bubbles. Normally set by mobs.
Procs
Crossed	default byond proc that is deprecated for us in lieu of signals. do not call
Moved	Called after a successful Move(). By this point, we've already moved. Arguments:
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][/atom/movable/proc/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()].
admin_Freeze	Created here as a base proc. Override as needed for any type of object or mob you want able to be frozen.
can_reach	A backwards depth-limited breadth-first-search to see if the target is logically "in" anything adjacent to us.
can_reach_nested_adjacent	A backwards depth-limited breadth-first-search to see if the target is logically "in" anything adjacent to us.
create_point_bubble	Create a bubble pointing at a particular icon and icon state. See args for create_point_bubble_from_atom.
create_point_bubble_from_atom	Create a point bubble towards a given item.
create_point_bubble_from_icons	Create a point bubble towards a given item, from an icon/icon state.
create_point_bubble_from_path	See above, this uses an uninstantiated path.
deadchat_plays	Adds the deadchat_plays component to this atom with simple movement commands.
end_throw	called after an items throw is ended.
fall_and_crush	Tip over this atom onto a turf, crushing things in its path.
key_loop	Key loop to check for movement keys held and move in the desired direction.
move_from_pull	Called when src is being moved to a target turf because another movable (puller) is moving around.
on_changed_z_level	Called when a movable changes z-levels.
on_crush_thing	useful callback for things that want special behavior on crush
orbit	Set an atom to orbit around another one. This atom will follow the base atom's movement and rotate around it.
point_at	Point at an atom
scatter_atom	Used to scatter atoms so that multiple copies aren't all at the exact same spot.
set_glide_size	This proc is recursive, and calls itself to constantly set the glide size of an atom/movable
set_loc	Used in shuttle movement and camera eye stuff. Primarily used to notify objects being moved by a shuttle/bluespace fuckup.
shove_impact	called when a mob gets shoved into an items turf. false means the mob will be shoved backwards normally, true means the mob will not be moved by the disarm proc.
stop_deadchat_plays	Easy way to remove the component when the fun has been played out
stop_orbit	Stop this atom from orbiting whatever it's orbiting.
tilt_over	Tip over an atom without too much fuss. This won't cause damage to anything, and just rotates the thing and (optionally) adds the component.
untilt	Untilt a tilted object.

Var Details

var
active_movement
– /tmp/list

A list containing arguments for Moved().

var
blocks_emissive
–

Either FALSE, [EMISSIVE_BLOCK_GENERIC], or EMISSIVE_BLOCK_UNIQUE

var
buckle_lying
–

Bed-like behaviour, forces the mob to lie down if buckle_lying != -1

var
buckle_offset
–

The Pixel_y to offset the buckled mob by

var
buckle_prevents_pull
–

Can we pull the mob while they're buckled. Currently set to false on every movable

var
buckle_requires_restraints
–

Require people to be handcuffed before being able to buckle. eg: pipes

var
buckled_mobs
– /list

Lazylist of the mobs buckled to this object.

var
can_be_unanchored
–

Used for icon smoothing. Won't smooth if it ain't anchored and can be unanchored. Only set to true on windows

var
em_block
– /atom/movable/emissive_blocker

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

var
face_while_pulling
–

Face towards the atom while pulling it

var
inertia_move_delay
–

Delay in deciseconds between inertia based movement

var
inertia_moving
–

Are we moving with inertia? Mostly used as an optimization

var
last_pushoff
–

The last time we pushed off something This is a hack to get around dumb him him me scenarios

var
max_buckled_mobs
–

The max amount of mobs that can be buckled to this object. Currently set to 1 on every movable

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
moving_from_pull
– /atom/movable

attempt to resume grab after moving instead of before.

var
orbiting_uid
–

UID for the atom which the current atom is orbiting

var
scatter_distance
–

How far (in pixels) should this atom scatter when created/dropped/etc. Does not apply to mapped-in items.

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. PARA: Doesn't set this currently to maintain current behavior for pulling items around, because modifying direction on pull is expected.

var
thought_bubble_image
–

Icon state for thought bubbles. Normally set by mobs.

Proc Details

Crossed
(/atom/movable/crossed_atom, oldloc)

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

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
Process_Spacemove
(movement_dir, continuous_move)

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][/atom/movable/proc/newtonian_move]

Return FALSE to have src start/keep drifting in a no-grav area and TRUE 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
continuous_move - If this check is coming from something in the context of already drifting

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.

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
admin_Freeze
(/client/admin)

Created here as a base proc. Override as needed for any type of object or mob you want able to be frozen.

proc
can_reach
(/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.

proc
can_reach_nested_adjacent
(/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.

Arguments:

ultimate_target - the specific item we're attempting to reach.
tool - if present, checked to see if the tool can reach the target via /obj/item/var/reach.
view_only - if TRUE, only considers locations in atoms visible to us, as opposed to nested inventories.

proc
create_point_bubble
(/mutable_appearance/pointed_atom_appearance, include_arrow)

Create a bubble pointing at a particular icon and icon state. See args for create_point_bubble_from_atom.

proc
create_point_bubble_from_atom
(/atom/pointed_atom, include_arrow)

Create a point bubble towards a given item.

Arguments:

pointed_atom - Atom to show in the bubble.
include_arrow - If true, show an arrow pointing downwards.

proc
create_point_bubble_from_icons
(icon, icon_state, include_arrow)

Create a point bubble towards a given item, from an icon/icon state.

Arguments:

icon - Icon source for the bubble's icon.
icon_state - Icon state for the bubble's icon.
include_arrow - If true, show an arrow pointing downwards.

proc
create_point_bubble_from_path
(/atom/pointed_atom_path, include_arrow)

See above, this uses an uninstantiated path.

proc
deadchat_plays
(mode, cooldown)

Adds the deadchat_plays component to this atom with simple movement commands.

Returns the component added. Arguments:

mode - Either DEADCHAT_ANARCHY_MODE or DEADCHAT_DEMOCRACY_MODE passed to the deadchat_control component. See /datum/component/deadchat_control for more info.
cooldown - The cooldown between command inputs passed to the deadchat_control component. See /datum/component/deadchat_control for more info.

proc
end_throw
()

called after an items throw is ended.

proc
fall_and_crush
(/turf/target_turf, crush_damage, should_crit, crit_damage_factor, /datum/tilt_crit/forced_crit, weaken_time, knockdown_time, ignore_gravity, should_rotate, angle, rightable, block_interactions_until_righted, crush_dir)

Tip over this atom onto a turf, crushing things in its path.

Arguments:

target_turf - The turf to fall onto.
should_crit - If true, we'll try to crit things that we crush.
crit_damage_factor - If a crit is rolled, crush_damage will be multiplied by this amount.
forced_crit - If passed, this crit will be applied to everything it crushes.
weaken_time - The amount of time that weaken will be applied to crushed mobs.
knockdown_time - The amount of time that knockdown will be applied to crushed mobs.
ignore_gravity - If false, we won't fall over in zero G.
should_rotate - If false, we won't rotate when we fall.
angle - The angle by which we'll rotate. If this is null/0, we'll randomly rotate 90 degrees clockwise or counterclockwise.
rightable - If true, the tilted component will be applied, allowing people to alt-click to right it.
block_interactions_until_righted - If true, interactions with the object will be blocked until it's righted.
crush_dir - An override on the cardinal direction we're crushing.

key_loop
(/client/C)

Key loop to check for movement keys held and move in the desired direction.

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

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

proc
on_changed_z_level
(/turf/old_turf, /turf/new_turf, 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.
notify_contents - Whether or not to notify the movable's contents that their z-level has changed.

proc
on_crush_thing
(/atom/thing)

useful callback for things that want special behavior on crush

proc
orbit
(/atom/A, radius, clockwise, rotation_speed, rotation_segments, pre_rotation, lock_in_orbit, force_move, orbit_layer)

Set an atom to orbit around another one. This atom will follow the base atom's movement and rotate around it.

orbiter: atom which will be doing the orbiting radius: range to orbit at, radius of the circle formed by orbiting clockwise: whether you orbit clockwise or anti clockwise rotation_speed: how fast to rotate rotation_segments: the resolution of the orbit circle, less = a more block circle, this can be used to produce hexagons (6 segments) triangles (3 segments), and so on, 36 is the best default. pre_rotation: Chooses to rotate src 90 degress towards the orbit dir (clockwise/anticlockwise), useful for things to go "head first" like ghosts lock_in_orbit: Forces src to always be on A's turf, otherwise the orbit cancels when src gets too far away (eg: ghosts) force_move: If true, ghosts will be ForceMoved instead of having their .loc updated directly. orbit_layer: layer that the orbiter should be on. The original layer will be restored on orbit end.

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
scatter_atom
(x_offset, y_offset)

Used to scatter atoms so that multiple copies aren't all at the exact same spot.

proc
set_glide_size
(target)

This proc is recursive, and calls itself to constantly set the glide size of an atom/movable

proc
set_loc
(T, teleported)

Used in shuttle movement and camera eye stuff. Primarily used to notify objects being moved by a shuttle/bluespace fuckup.

proc
shove_impact
(/mob/living/target, /mob/living/attacker)

called when a mob gets shoved into an items turf. false means the mob will be shoved backwards normally, true means the mob will not be moved by the disarm proc.

proc
stop_deadchat_plays
()

Easy way to remove the component when the fun has been played out

proc
stop_orbit
()

Stop this atom from orbiting whatever it's orbiting.

proc
tilt_over
(/turf/target, rotation_angle, should_rotate, rightable, block_interactions_until_righted)

Tip over an atom without too much fuss. This won't cause damage to anything, and just rotates the thing and (optionally) adds the component.

Arguments:

target - The turf to tilt over onto
rotation_angle - The angle to rotate by. If not given, defaults to random rotating by 90 degrees clockwise or counterclockwise
should_rotate - Whether or not we should rotate at all
rightable - Whether or not this object should be rightable, attaching the tilted component to it
block_interactions_until_righted - If true, this object will need to be righted before it can be interacted with

proc
untilt
(/mob/living/user, duration)

Untilt a tilted object.

movable /atom/movable

Vars

Procs

Var Details

var active_movement – /tmp/list

var blocks_emissive –

var buckle_lying –

var buckle_offset –

var buckle_prevents_pull –

var buckle_requires_restraints –

var buckled_mobs – /list

var can_be_unanchored –

var em_block – /atom/movable/emissive_blocker

var face_while_pulling –

var inertia_move_delay –

var inertia_moving –

var last_pushoff –

var max_buckled_mobs –

var move_packet – /datum/movement_packet

var moving_from_pull – /atom/movable

var orbiting_uid –

var scatter_distance –

var set_dir_on_move –

var thought_bubble_image –

Proc Details

Crossed(/atom/movable/crossed_atom, oldloc)

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

proc Process_Spacemove(movement_dir, continuous_move)

Uncross()

Uncrossed(/atom/movable/uncrossed_atom)

proc abstract_move(/atom/new_loc)

proc admin_Freeze(/client/admin)

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

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

proc create_point_bubble(/mutable_appearance/pointed_atom_appearance, include_arrow)

proc create_point_bubble_from_atom(/atom/pointed_atom, include_arrow)

proc create_point_bubble_from_icons(icon, icon_state, include_arrow)

proc create_point_bubble_from_path(/atom/pointed_atom_path, include_arrow)

proc deadchat_plays(mode, cooldown)

proc end_throw()

proc fall_and_crush(/turf/target_turf, crush_damage, should_crit, crit_damage_factor, /datum/tilt_crit/forced_crit, weaken_time, knockdown_time, ignore_gravity, should_rotate, angle, rightable, block_interactions_until_righted, crush_dir)

key_loop(/client/C)

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

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

proc on_crush_thing(/atom/thing)

proc orbit(/atom/A, radius, clockwise, rotation_speed, rotation_segments, pre_rotation, lock_in_orbit, force_move, orbit_layer)

proc point_at(/atom/pointed_atom)

proc scatter_atom(x_offset, y_offset)

proc set_glide_size(target)

proc set_loc(T, teleported)

proc shove_impact(/mob/living/target, /mob/living/attacker)

proc stop_deadchat_plays()

proc stop_orbit()

proc tilt_over(/turf/target, rotation_angle, should_rotate, rightable, block_interactions_until_righted)

proc untilt(/mob/living/user, duration)

movable
/atom/movable

var
active_movement
– /tmp/list

var
blocks_emissive
–

var
buckle_lying
–

var
buckle_offset
–

var
buckle_prevents_pull
–

var
buckle_requires_restraints
–

var
buckled_mobs
– /list

var
can_be_unanchored
–

var
em_block
– /atom/movable/emissive_blocker

var
face_while_pulling
–

var
inertia_move_delay
–

var
inertia_moving
–

var
last_pushoff
–

var
max_buckled_mobs
–

var
move_packet
– /datum/movement_packet

var
moving_from_pull
– /atom/movable

var
orbiting_uid
–

var
scatter_distance
–

var
set_dir_on_move
–

var
thought_bubble_image
–

Crossed
(/atom/movable/crossed_atom, oldloc)

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

proc
Process_Spacemove
(movement_dir, continuous_move)

Uncross
()

Uncrossed
(/atom/movable/uncrossed_atom)

proc
abstract_move
(/atom/new_loc)

proc
admin_Freeze
(/client/admin)

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

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

proc
create_point_bubble
(/mutable_appearance/pointed_atom_appearance, include_arrow)

proc
create_point_bubble_from_atom
(/atom/pointed_atom, include_arrow)

proc
create_point_bubble_from_icons
(icon, icon_state, include_arrow)

proc
create_point_bubble_from_path
(/atom/pointed_atom_path, include_arrow)

proc
deadchat_plays
(mode, cooldown)

proc
end_throw
()

proc
fall_and_crush
(/turf/target_turf, crush_damage, should_crit, crit_damage_factor, /datum/tilt_crit/forced_crit, weaken_time, knockdown_time, ignore_gravity, should_rotate, angle, rightable, block_interactions_until_righted, crush_dir)

key_loop
(/client/C)

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

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

proc
on_crush_thing
(/atom/thing)

proc
orbit
(/atom/A, radius, clockwise, rotation_speed, rotation_segments, pre_rotation, lock_in_orbit, force_move, orbit_layer)

proc
point_at
(/atom/pointed_atom)

proc
scatter_atom
(x_offset, y_offset)

proc
set_glide_size
(target)

proc
set_loc
(T, teleported)

proc
shove_impact
(/mob/living/target, /mob/living/attacker)

proc
stop_deadchat_plays
()

proc
stop_orbit
()

proc
tilt_over
(/turf/target, rotation_angle, should_rotate, rightable, block_interactions_until_righted)

proc
untilt
(/mob/living/user, duration)