obj
Vars | |
| custom_fire_overlay | Custom fire overlay icon |
|---|---|
| desc_controls | Extra examine line to describe controls, such as right-clicking, left-clicking, etc. |
| 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. |
| w_class | How large is the object, used for stuff like whether it can fit in backpacks or not |
Procs | |
| acid_act | the obj's reaction when touched by acid |
| acid_melt | called when the obj is destroyed by acid. |
| airflow_hit_act | Heheheh |
| atom_destruction | what happens when the obj's integrity reaches zero. |
| attack_tk_grab | Telekinesis object grab act. |
| burn | called when the obj is destroyed by fire |
| check_reskin_menu | Checks if we are allowed to interact with a radial menu for reskins |
| deconstruct | the obj is deconstructed into pieces, whether through careful disassembly or when destroyed. |
| expose_reagents | Handles exposing an object to reagents. |
| extinguish | Called when the obj is no longer on fire. |
| fire_act | / FIRE Called when the obj is exposed to fire. |
| flick_emote_popup_on_obj | A proc type that, when called, causes a image/sprite to appear above whatever entity it is called on. |
| freeze | attempt to freeze this obj if possible. returns TRUE if it succeeded, FALSE otherwise. |
| lose_block_z_out | Removes a BLOCK_Z_OUT_* flag, and then tries to get every movable in the turf to fall. |
| pipe_eject | General proc used to expel a holder's contents through src (for bins holder is also the src). |
| remove_emote_popup_on_obj | A proc that is automatically called whenever flick_emote_popup_on_obj's addtimer expires, and removes the popup. |
| reskin_obj | Reskins object based on a user's choice |
| 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
custom_fire_overlay
Custom fire overlay icon
desc_controls
Extra examine line to describe controls, such as right-clicking, left-clicking, etc.
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.
w_class
How large is the object, used for stuff like whether it can fit in backpacks or not
Proc Details
acid_act
the obj's reaction when touched by acid
acid_melt
called when the obj is destroyed by acid.
airflow_hit_act
Heheheh
atom_destruction
what happens when the obj's integrity reaches zero.
attack_tk_grab
Telekinesis object grab act.
- Called by
/obj/attack_tk(). - Returns
COMPONENT_CANCEL_ATTACK_CHAINwhen it performs any action, to further acts on the attack chain.
burn
called when the obj is destroyed by fire
check_reskin_menu
Checks if we are allowed to interact with a radial menu for reskins
Arguments:
- user The mob interacting with the menu
deconstruct
the obj is deconstructed into pieces, whether through careful disassembly or when destroyed.
expose_reagents
Handles exposing an object to reagents.
extinguish
Called when the obj is no longer on fire.
fire_act
/ FIRE Called when the obj is exposed to fire.
flick_emote_popup_on_obj
A proc type that, when called, causes a image/sprite to appear above whatever entity it is called on.
There are two types: on_mob and on_obj, they can only be called on their respective typepaths.
Arguments:
- state -- The icon_state of whatever .dmi file you're attempting to use for the sprite, in "" format. Ex. "combat", not combat.dmi.
- time -- The amount of time the sprite remains before remove_emote_popup_on_obj is called. Is used in the addtimer.
freeze
attempt to freeze this obj if possible. returns TRUE if it succeeded, FALSE otherwise.
lose_block_z_out
Removes a BLOCK_Z_OUT_* flag, and then tries to get every movable in the turf to fall.
pipe_eject
General proc used to expel a holder's contents through src (for bins holder is also the src).
remove_emote_popup_on_obj
A proc that is automatically called whenever flick_emote_popup_on_obj's addtimer expires, and removes the popup.
Arguments:
- emote_overlay -- Inherits state from the preceding proc.
reskin_obj
Reskins object based on a user's choice
Arguments:
- M The mob choosing a reskin option
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.