movable

Vars
acid_level	How much acid is on this object?
being_shocked	Is this object currently being zapped by lightning?
custom_fire_overlay	If provided, a custom overlay representing being the object being on fire.
damage_deflection	Damage under this value will be completely ignored.
damtype	What type of damage does this object deal?
emagged	Is this object emagged?
force	How much damage this object does in melee.
icon_preview	Icon to use as a 32x32 preview in crafting menus and such
in_use	If we have a user using us, this will become `TRUE`. We will check if the user has stopped using us, and thus stop updating and LAGGING EVERYTHING!
integrity_failure	Health threshold below which the object will break. Defaults to 0 for no special broken behavior.
max_integrity	Maximum health of the object, and default value of `obj_integrity`.
multitool_menu_type	Typepath of a datum/multitool_menu subtype or null.
obj_integrity	Health of the object. If unspecified, defaults to `max_integrity`.
on_blueprints	Are we visible on the station blueprints at roundstart?
origin_tech	Used by R&D to determine what research bonuses it grants.
pull_push_slowdown	Amount of multiplicative slowdown applied if pulled/pushed. >1 makes you slower, <1 makes you faster.
req_access	List of accesses needed to use this object: The user must possess all accesses in this list in order to use the object. Example: If req_access = list(ACCESS_ENGINE, ACCESS_CE)- then the user must have both ACCESS_ENGINE and ACCESS_CE in order to use the object.
resistance_flags	Flags that make this object harder to destroy, e.g. [ACID_PROOF], [FIRE_PROOF], [INDESTRUCTIBLE].
sharp	Can this object cut?
speed_process	Should this object speed process? Greatly increases the frequency of process events (5 times more frequent).
suicidal_hands	Does this object require you to hold it to commit suicide with it?
Procs
acid_act	The obj's reaction when touched by acid
acid_melt	Called when the obj is destroyed by acid.
acid_processing	The proc called by the acid subsystem to process the acid that's on the obj
burn	Called when the obj is destroyed by fire
deconstruct	The obj is deconstructed into pieces, whether through careful disassembly or when destroyed.
extinguish	Called when the obj is no longer on fire.
get_integrity	This mostly exists to keep obj_integrity private. Might be useful in the future.
get_integrity_percentage	Similar to get_integrity, but returns the percentage as [0-1] instead.
interact	Hidden uplink interaction proc. Gathers a list of items purchasable from the paren't uplink and displays it. It also adds a lock button.
modify_max_integrity	Changes max_integrity while retaining current health percentage, returns TRUE if the obj got broken.
obj_break	What happens when the obj's health is below integrity_failure level.
obj_destruction	What happens when the obj's integrity reaches zero.
on_update_integrity	Handle updates to your obj's integrity
pipe_eject	General proc used to expel a holder's contents through src (for bins holder is also the src).
play_attack_sound	The sound played when the obj is damaged.
repair_damage	Proc for recovering atom_integrity. Returns the amount repaired by
run_obj_armor	Returns the damage value of the attack after processing the obj's various armor protections
set_sharpness	Set whether the item should be sharp or not
take_damage	The essential proc to call when an obj must receive damage of any kind.
ui_login_act	Call this from a proc that is called in ui_act() to process login actions
ui_login_attackby	Convenience function to perform login actions when the source object is hit by specific items.
ui_login_data	Appends login state data.
ui_login_eject	Attempts to eject the inserted ID.
ui_login_get	Returns (or creates) the login state for the source object.
ui_login_insert	Attempts to insert an object as an ID.
ui_login_login	Attempts to log in with the given login type.
ui_login_logout	Attempts to log out.
ui_login_on_login	Called on successful login.
ui_login_on_logout	Called on successful logout.
update_integrity	Handles the integrity of an obj changing. This must be called instead of changing integrity directly.
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
acid_level
–

How much acid is on this object?

var
being_shocked
–

Is this object currently being zapped by lightning?

var
custom_fire_overlay
–

If provided, a custom overlay representing being the object being on fire.

var
damage_deflection
–

Damage under this value will be completely ignored.

var
damtype
–

What type of damage does this object deal?

var
emagged
–

Is this object emagged?

var
force
–

How much damage this object does in melee.

var
icon_preview
–

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

var
in_use
–

If we have a user using us, this will become TRUE. We will check if the user has stopped using us, and thus stop updating and LAGGING EVERYTHING!

var
integrity_failure
–

Health threshold below which the object will break. Defaults to 0 for no special broken behavior.

var
max_integrity
–

Maximum health of the object, and default value of obj_integrity.

var
multitool_menu_type
–

Typepath of a datum/multitool_menu subtype or null.

var
obj_integrity
–

Health of the object. If unspecified, defaults to max_integrity.

var
on_blueprints
–

Are we visible on the station blueprints at roundstart?

var
origin_tech
–

Used by R&D to determine what research bonuses it grants.

var
pull_push_slowdown
–

Amount of multiplicative slowdown applied if pulled/pushed. >1 makes you slower, <1 makes you faster.

var
req_access
– /list

List of accesses needed to use this object: The user must possess all accesses in this list in order to use the object. Example: If req_access = list(ACCESS_ENGINE, ACCESS_CE)- then the user must have both ACCESS_ENGINE and ACCESS_CE in order to use the object.

var
resistance_flags
–

Flags that make this object harder to destroy, e.g. [ACID_PROOF], [FIRE_PROOF], [INDESTRUCTIBLE].

var
sharp
–

Can this object cut?

var
speed_process
–

Should this object speed process? Greatly increases the frequency of process events (5 times more frequent).

var
suicidal_hands
–

Does this object require you to hold it to commit suicide with it?

Proc Details

↑
acid_act
(acidpwr, acid_volume)

The obj's reaction when touched by acid

proc
acid_melt
()

Called when the obj is destroyed by acid.

proc
acid_processing
()

The proc called by the acid subsystem to process the acid that's on the obj

proc
burn
()

Called when the obj is destroyed by fire

proc
deconstruct
(disassembled)

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

proc
extinguish
()

Called when the obj is no longer on fire.

proc
get_integrity
()

This mostly exists to keep obj_integrity private. Might be useful in the future.

proc
get_integrity_percentage
()

Similar to get_integrity, but returns the percentage as [0-1] instead.

proc
interact
(/mob/user)

Hidden uplink interaction proc. Gathers a list of items purchasable from the paren't uplink and displays it. It also adds a lock button.

Arguments:

user - who interacts with uplink.

proc
modify_max_integrity
(new_max, can_break, damage_type, new_failure_integrity)

Changes max_integrity while retaining current health percentage, returns TRUE if the obj got broken.

proc
obj_break
(damage_flag)

What happens when the obj's health is below integrity_failure level.

proc
obj_destruction
(damage_flag)

What happens when the obj's integrity reaches zero.

proc
on_update_integrity
(old_value, new_value)

Handle updates to your obj's integrity

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
play_attack_sound
(damage_amount, damage_type, damage_flag)

The sound played when the obj is damaged.

proc
repair_damage
(amount)

Proc for recovering atom_integrity. Returns the amount repaired by

proc
run_obj_armor
(damage_amount, damage_type, damage_flag, attack_dir, armour_penetration)

Returns the damage value of the attack after processing the obj's various armor protections

proc
set_sharpness
(new_sharp_val)

Set whether the item should be sharp or not

proc
take_damage
(damage_amount, damage_type, damage_flag, sound_effect, attack_dir, armour_penetration)

The essential proc to call when an obj must receive damage of any kind.

proc
ui_login_act
(action, params)

Call this from a proc that is called in ui_act() to process login actions

Arguments:

action - The called action
params - The params to the action

proc
ui_login_attackby
(/obj/item/O, /mob/user)

Convenience function to perform login actions when the source object is hit by specific items.

Arguments:

O - The object
user - The user

proc
ui_login_data
(/list/data, /mob/user, /datum/ui_login/state)

Appends login state data.

Arguments:

data - The data list to be returned
user - The user calling ui_data()
state - The current login state

proc
ui_login_eject
(/datum/ui_login/state)

Attempts to eject the inserted ID.

Arguments:

state - The current login state

proc
ui_login_get
()

Returns (or creates) the login state for the source object.

Arguments:

state - The current login state

proc
ui_login_insert
(/obj/item/O, /datum/ui_login/state)

Attempts to insert an object as an ID.

Arguments:

O - The object to try inserting
state - The current login state

proc
ui_login_login
(login_type, /datum/ui_login/state)

Attempts to log in with the given login type.

Arguments:

login_type - The login type: LOGIN_TYPE_NORMAL (checks for inserted ID), LOGIN_TYPE_AI, LOGIN_TYPE_ROBOT and LOGIN_TYPE_ADMIN
state - The current login state

proc
ui_login_logout
(/datum/ui_login/state)

Attempts to log out.

Arguments:

state - The current login state

proc
ui_login_on_login
(/datum/ui_login/state)

Called on successful login.

Arguments:

state - The current login state

proc
ui_login_on_logout
(/datum/ui_login/state)

Called on successful logout.

Arguments:

state - The current login state

proc
update_integrity
(new_value, damage_flag)

Handles the integrity of an obj changing. This must be called instead of changing integrity directly.

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

var being_shocked –

var custom_fire_overlay –

var damage_deflection –

var damtype –

var emagged –

var force –

var icon_preview –

var in_use –

var integrity_failure –

var max_integrity –

var multitool_menu_type –

var obj_integrity –

var on_blueprints –

var origin_tech –

var pull_push_slowdown –

var req_access – /list

var resistance_flags –

var sharp –

var speed_process –

var suicidal_hands –

Proc Details

↑acid_act(acidpwr, acid_volume)

proc acid_melt()

proc acid_processing()

proc burn()

proc deconstruct(disassembled)

proc extinguish()

proc get_integrity()

proc get_integrity_percentage()

proc interact(/mob/user)

proc modify_max_integrity(new_max, can_break, damage_type, new_failure_integrity)

proc obj_break(damage_flag)

proc obj_destruction(damage_flag)

proc on_update_integrity(old_value, new_value)

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

proc play_attack_sound(damage_amount, damage_type, damage_flag)

proc repair_damage(amount)

proc run_obj_armor(damage_amount, damage_type, damage_flag, attack_dir, armour_penetration)

proc set_sharpness(new_sharp_val)

proc take_damage(damage_amount, damage_type, damage_flag, sound_effect, attack_dir, armour_penetration)

proc ui_login_act(action, params)

proc ui_login_attackby(/obj/item/O, /mob/user)

proc ui_login_data(/list/data, /mob/user, /datum/ui_login/state)

proc ui_login_eject(/datum/ui_login/state)

proc ui_login_get()

proc ui_login_insert(/obj/item/O, /datum/ui_login/state)

proc ui_login_login(login_type, /datum/ui_login/state)

proc ui_login_logout(/datum/ui_login/state)

proc ui_login_on_login(/datum/ui_login/state)

proc ui_login_on_logout(/datum/ui_login/state)

proc update_integrity(new_value, damage_flag)

zap_act(power, zap_flags)

proc zap_buckle_check(strength)

obj
/obj
inherits /atom/movable

var
acid_level
–

var
being_shocked
–

var
custom_fire_overlay
–

var
damage_deflection
–

var
damtype
–

var
emagged
–

var
force
–

var
icon_preview
–

var
in_use
–

var
integrity_failure
–

var
max_integrity
–

var
multitool_menu_type
–

var
obj_integrity
–

var
on_blueprints
–

var
origin_tech
–

var
pull_push_slowdown
–

var
req_access
– /list

var
resistance_flags
–

var
sharp
–

var
speed_process
–

var
suicidal_hands
–

↑
acid_act
(acidpwr, acid_volume)

proc
acid_melt
()

proc
acid_processing
()

proc
burn
()

proc
deconstruct
(disassembled)

proc
extinguish
()

proc
get_integrity
()

proc
get_integrity_percentage
()

proc
interact
(/mob/user)

proc
modify_max_integrity
(new_max, can_break, damage_type, new_failure_integrity)

proc
obj_break
(damage_flag)

proc
obj_destruction
(damage_flag)

proc
on_update_integrity
(old_value, new_value)

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

proc
play_attack_sound
(damage_amount, damage_type, damage_flag)

proc
repair_damage
(amount)

proc
run_obj_armor
(damage_amount, damage_type, damage_flag, attack_dir, armour_penetration)

proc
set_sharpness
(new_sharp_val)

proc
take_damage
(damage_amount, damage_type, damage_flag, sound_effect, attack_dir, armour_penetration)

proc
ui_login_act
(action, params)

proc
ui_login_attackby
(/obj/item/O, /mob/user)

proc
ui_login_data
(/list/data, /mob/user, /datum/ui_login/state)

proc
ui_login_eject
(/datum/ui_login/state)

proc
ui_login_get
()

proc
ui_login_insert
(/obj/item/O, /datum/ui_login/state)

proc
ui_login_login
(login_type, /datum/ui_login/state)

proc
ui_login_logout
(/datum/ui_login/state)

proc
ui_login_on_login
(/datum/ui_login/state)

proc
ui_login_on_logout
(/datum/ui_login/state)

proc
update_integrity
(new_value, damage_flag)

zap_act
(power, zap_flags)

proc
zap_buckle_check
(strength)