movable

Vars
anchored_tabletop_offset	The vertical pixel_z offset applied when the object is anchored on a tile with table Ignored when set to 0 - to avoid shifting directional wall-mounted objects above tables
buckle_sound	The sound this obj makes when something is buckled to it
burning_particles	Particles this obj uses when burning, if any
custom_fire_overlay	Cached custom fire overlay
demolition_mod	A multiplier to an object's force when used against a structure, vehicle, machine, or robot. Use /obj/proc/get_demolition_modifier to get the value.
desc_controls	Extra examine line to describe controls, such as right-clicking, left-clicking, etc.
exposed_wound_bonus	If this attacks a human with no wound armor on the affected body part, add this to the wound mod. Some attacks may be significantly worse at wounding if there's even a slight layer of armor to absorb some of it vs bare flesh
icon_preview	Icon to use as a 32x32 preview in crafting menus and such
id_tag	Map tag for something. Tired of it being used on snowflake items. Moved here for some semblance of a standard. Next pr after the network fix will have me refactor door interactions, so help me god.
no_damage_feedback	The context returned when an attack against this object doesn't deal any traditional damage to the object.
unbuckle_sound	The sound this obj makes when something is unbuckled from it
wound_bonus	How good a given object is at causing wounds on carbons. Higher values equal better shots at creating serious wounds.
Procs
GetExplosionBlock	returns how much the object blocks an explosion. Used by subtypes.
acid_act	// ACID the obj's reaction when touched by acid
acid_melt	called when the obj is destroyed by acid.
atom_deconstruct	Custom behaviour per atom subtype on how they should deconstruct themselves Arguments
atom_destruction	what happens when the obj's integrity reaches zero.
attack_tk_grab	Telekinesis object grab act.
burn	Should be called when the atom is destroyed by fire, comparable to acid_melt() proc
can_be_unfasten_wrench	If we can unwrench this object; returns SUCCESSFUL_UNFASTEN and FAILED_UNFASTEN, which are both TRUE, or CANT_UNFASTEN, which isn't.
check_on_table	Adjusts the vertical pixel_z offset when the object is anchored on a tile with table
custom_fire_overlay	Returns a custom fire overlay, if any
deconstruct	The obj is deconstructed into pieces, whether through careful disassembly or when destroyed. Arguments
default_unfasten_wrench	Try to unwrench an object in a WONDERFUL DYNAMIC WAY
expose_reagents	Handles exposing an object to reagents.
find_and_hang_on_wall
fire_act	/ FIRE Called when the obj is exposed to fire.
freeze	Attempt to freeze this obj if possible. returns TRUE if it succeeded, FALSE otherwise.
gender_reveal	Creates an animation of the item slowly lifting up from the floor with a colored outline, then slowly drifting back down. Arguments:
get_demolition_modifier	Returns modifier to how much damage this object does to a target considered vulnerable to "demolition" (other objects, robots, etc)
handle_deconstruct	The interminate proc between deconstruct() & atom_deconstruct(). By default this delegates deconstruction to atom_deconstruct if NO_DEBRIS_AFTER_DECONSTRUCTION is absent but subtypes can override this to handle NO_DEBRIS_AFTER_DECONSTRUCTION in their own unique way. Override this if for example you want to dump out important content like mobs from the atom before deconstruction regardless if NO_DEBRIS_AFTER_DECONSTRUCTION is present or not Arguments
on_object_saved	A procedure for saving non-standard properties of an object. Examples: Saving material stacks (ie. ore in a silo) Saving variables that can be shown as mapping helpers (ie. welded airlock mapping helper) Saving objects inside of another object (ie. paper inside a noticeboard)
pipe_eject	General proc used to expel a holder's contents through src (for bins holder is also the src).
receive_signal	Proc for reacting to a received `/datum/signal`. To be implemented as needed, does nothing by default.
remove_gender_reveal_fx	Removes the non-animate effects from above proc
remove_single_mat_effect	This proc is called when the material is removed from an object specifically.
set_bounds	Updates the bounds of a rotated object This ensures that the bounds are always correct, even if the object is rotated after init.
unfasten_wrench_check	For the do_after, this checks if unfastening conditions are still valid
unfreeze	Unfreezes this obj if its frozen
zap_act	Called when the obj is hit by a tesla bolt.
zap_buckle_check	Only tesla coils, vehicles, and grounding rods currently call this because mobs are already targeted over all other objects, but this might be useful for more things later.

Var Details

var
anchored_tabletop_offset

The vertical pixel_z offset applied when the object is anchored on a tile with table Ignored when set to 0 - to avoid shifting directional wall-mounted objects above tables

var
buckle_sound

The sound this obj makes when something is buckled to it

var
burning_particles

Particles this obj uses when burning, if any

var
custom_fire_overlay

Cached custom fire overlay

var
demolition_mod

A multiplier to an object's force when used against a structure, vehicle, machine, or robot. Use /obj/proc/get_demolition_modifier to get the value.

var
desc_controls

Extra examine line to describe controls, such as right-clicking, left-clicking, etc.

var
exposed_wound_bonus

If this attacks a human with no wound armor on the affected body part, add this to the wound mod. Some attacks may be significantly worse at wounding if there's even a slight layer of armor to absorb some of it vs bare flesh

var
icon_preview

Icon to use as a 32x32 preview in crafting menus and such

var
id_tag

Map tag for something. Tired of it being used on snowflake items. Moved here for some semblance of a standard. Next pr after the network fix will have me refactor door interactions, so help me god.

var
no_damage_feedback

The context returned when an attack against this object doesn't deal any traditional damage to the object.

var
unbuckle_sound

The sound this obj makes when something is unbuckled from it

var
wound_bonus

How good a given object is at causing wounds on carbons. Higher values equal better shots at creating serious wounds.

Proc Details

proc
GetExplosionBlock
()

returns how much the object blocks an explosion. Used by subtypes.

↑
acid_act
(acidpwr, acid_volume)

// ACID the obj's reaction when touched by acid

proc
acid_melt
()

called when the obj is destroyed by acid.

proc
atom_deconstruct
(disassembled)

Custom behaviour per atom subtype on how they should deconstruct themselves Arguments

disassembled - TRUE means we cleanly took this atom apart using tools. FALSE means this was destroyed in a violent way

↑
atom_destruction
(damage_flag)

what happens when the obj's integrity reaches zero.

proc
attack_tk_grab
(/mob/user)

Telekinesis object grab act.

Called by /obj/attack_tk().
Returns COMPONENT_CANCEL_ATTACK_CHAIN when it performs any action, to further acts on the attack chain.

proc
burn
()

Should be called when the atom is destroyed by fire, comparable to acid_melt() proc

proc
can_be_unfasten_wrench
(/mob/user, silent)

If we can unwrench this object; returns SUCCESSFUL_UNFASTEN and FAILED_UNFASTEN, which are both TRUE, or CANT_UNFASTEN, which isn't.

proc
check_on_table
()

Adjusts the vertical pixel_z offset when the object is anchored on a tile with table

proc
custom_fire_overlay
()

Returns a custom fire overlay, if any

proc
deconstruct
(disassembled)

The obj is deconstructed into pieces, whether through careful disassembly or when destroyed. Arguments

disassembled - TRUE means we cleanly took this atom apart using tools. FALSE means this was destroyed in a violent way

proc
default_unfasten_wrench
(/mob/user, /obj/item/wrench, time)

Try to unwrench an object in a WONDERFUL DYNAMIC WAY

↑
expose_reagents
(/list/reagents, /datum/reagents/source, methods, volume_modifier, show_message)

Handles exposing an object to reagents.

proc
find_and_hang_on_wall
(directional, custom_drop_callback)

Checks object direction and then verifies if there's a wall in that direction. Finally, applies a wall_mounted component to the object.

@param directional If TRUE, will use the direction of the object to determine the wall to attach to. If FALSE, will use the object's loc.
@param custom_drop_callback If set, will use this callback instead of the default deconstruct callback.

↑
fire_act
(exposed_temperature, exposed_volume)

/ FIRE Called when the obj is exposed to fire.

proc
freeze
()

Attempt to freeze this obj if possible. returns TRUE if it succeeded, FALSE otherwise.

proc
gender_reveal
(outline_color, ray_color, anim_time, do_float, do_layer)

Creates an animation of the item slowly lifting up from the floor with a colored outline, then slowly drifting back down. Arguments:

outline_color: Default is between pink and light blue, is the color of the outline filter.
ray_color: Null by default. If not set, just copies outline. Used for the ray filter.
anim_time: Total time of the animation. Split into two different calls.
do_float: Lets you disable the sprite floating up and down.
do_layer: Lets you disable the layering increase.

proc
get_demolition_modifier
(/obj/target)

Returns modifier to how much damage this object does to a target considered vulnerable to "demolition" (other objects, robots, etc)

proc
handle_deconstruct
(disassembled)

The interminate proc between deconstruct() & atom_deconstruct(). By default this delegates deconstruction to atom_deconstruct if NO_DEBRIS_AFTER_DECONSTRUCTION is absent but subtypes can override this to handle NO_DEBRIS_AFTER_DECONSTRUCTION in their own unique way. Override this if for example you want to dump out important content like mobs from the atom before deconstruction regardless if NO_DEBRIS_AFTER_DECONSTRUCTION is present or not Arguments

disassembled - TRUE means we cleanly took this atom apart using tools. FALSE means this was destroyed in a violent way

proc
on_object_saved
()

A procedure for saving non-standard properties of an object. Examples: Saving material stacks (ie. ore in a silo) Saving variables that can be shown as mapping helpers (ie. welded airlock mapping helper) Saving objects inside of another object (ie. paper inside a noticeboard)

proc
pipe_eject
(/obj/holder, direction, throw_em, /turf/target, throw_range, throw_speed)

General proc used to expel a holder's contents through src (for bins holder is also the src).

proc
receive_signal
(/datum/signal/signal)

Proc for reacting to a received /datum/signal. To be implemented as needed, does nothing by default.

proc
remove_gender_reveal_fx
(og_layer)

Removes the non-animate effects from above proc

↑
remove_single_mat_effect
(/datum/material/material, mat_amount, multiplier)

This proc is called when the material is removed from an object specifically.

proc
set_bounds
()

Updates the bounds of a rotated object This ensures that the bounds are always correct, even if the object is rotated after init.

proc
unfasten_wrench_check
(prev_anchored, /mob/user)

For the do_after, this checks if unfastening conditions are still valid

proc
unfreeze
()

Unfreezes this obj if its frozen

↑
zap_act
(power, zap_flags)

Called when the obj is hit by a tesla bolt.

proc
zap_buckle_check
(strength)

Only tesla coils, vehicles, and grounding rods currently call this because mobs are already targeted over all other objects, but this might be useful for more things later.

obj /obj inherits /atom/movable

Vars

Procs

Var Details

var anchored_tabletop_offset

var buckle_sound

var burning_particles

var custom_fire_overlay

var demolition_mod

var desc_controls

var exposed_wound_bonus

var icon_preview

var id_tag

var no_damage_feedback

var unbuckle_sound

var wound_bonus

Proc Details

proc GetExplosionBlock()

↑acid_act(acidpwr, acid_volume)

proc acid_melt()

proc atom_deconstruct(disassembled)

↑atom_destruction(damage_flag)

proc attack_tk_grab(/mob/user)

proc burn()

proc can_be_unfasten_wrench(/mob/user, silent)

proc check_on_table()

proc custom_fire_overlay()

proc deconstruct(disassembled)

proc default_unfasten_wrench(/mob/user, /obj/item/wrench, time)

↑expose_reagents(/list/reagents, /datum/reagents/source, methods, volume_modifier, show_message)

proc find_and_hang_on_wall(directional, custom_drop_callback)

↑fire_act(exposed_temperature, exposed_volume)

proc freeze()

proc gender_reveal(outline_color, ray_color, anim_time, do_float, do_layer)

proc get_demolition_modifier(/obj/target)

proc handle_deconstruct(disassembled)

proc on_object_saved()

proc pipe_eject(/obj/holder, direction, throw_em, /turf/target, throw_range, throw_speed)

proc receive_signal(/datum/signal/signal)

proc remove_gender_reveal_fx(og_layer)

↑remove_single_mat_effect(/datum/material/material, mat_amount, multiplier)

proc set_bounds()

proc unfasten_wrench_check(prev_anchored, /mob/user)

proc unfreeze()

↑zap_act(power, zap_flags)

proc zap_buckle_check(strength)