item

Anything you can pick up and hold.

Vars
actions	list of /datum/action's that this item has.
actions_types	list of paths of action datums to give to the item on New().
allowed	What objects the suit storage can store
alternate_worn_layer	Forced mob worn layer instead of the standard preferred ssize.
armour_penetration	percentage of armour effectiveness to remove
attack_verb_continuous	Used in atom/proc/attackby to say how something was attacked `"[x] has been [z.attack_verb] by [y] with [z]"`
belt_icon_state	Icon state for the belt overlay, if null the normal icon_state will be used.
body_parts_covered	What body parts are covered by the clothing when you wear it
breakouttime	How long it takes to resist out of the item (cuffs and such)
cold_protection	flags which determine which body parts are protected from cold. [See here][HEAD]
dog_fashion	Reference to the datum that determines whether dogs can wear the item: Needs to be in /obj/item because corgis can wear a lot of non-clothing items
drop_sound	Sound uses when dropping the item, or when its thrown.
dye_color	Used as the dye color source in the washing machine only (at the moment). Can be a hex color or a key corresponding to a registry entry, see washing_machine.dm
dying_key	What dye registry should be looked at when dying this item; see washing_machine.dm
embedding	Does it embed and if yes, what kind of embed
equip_delay_other	In deciseconds, how long an item takes to put on another person
equip_delay_self	In deciseconds, how long an item takes to equip; counts only for normal clothing slots, not pockets etc.
equip_sound	Sound used when equipping the item into a valid slot
flags_cover	for flags such as [GLASSESCOVERSEYES]
flags_inv	This flag is used to determine when items in someone's inventory cover others. IE helmets making it so you can't see glasses, etc.
force_string	string form of an item's force. Edit this var only to set a custom force string
gas_transfer_coefficient	Literally does nothing right now
greyscale_config_belt	The config type to use for greyscaled belt overlays. Both this and greyscale_colors must be assigned to work.
greyscale_config_inhand_left	The config type to use for greyscaled left inhand sprites. Both this and greyscale_colors must be assigned to work.
greyscale_config_inhand_right	The config type to use for greyscaled right inhand sprites. Both this and greyscale_colors must be assigned to work.
greyscale_config_worn	The config type to use for greyscaled worn sprites. Both this and greyscale_colors must be assigned to work.
grind_results	Grinder var:A reagent list containing the reagents this item produces when ground up in a grinder - this can be an empty list to allow for reagent transferring only
heat_protection	flags which determine which body parts are protected from heat. [See here][HEAD]
hitsound	Sound played when you hit something with the item
inhand_icon_state	icon state for inhand overlays, if null the normal icon_state will be used.
inhand_x_dimension	Same as for worn_x_dimension but for inhands, uses the lefthand_ and righthand_ file vars
inhand_y_dimension	Same as for worn_y_dimension but for inhands, uses the lefthand_ and righthand_ file vars
interaction_flags_item	flags for what should be done when you click on the item, default is picking it up
item_flags	Item flags for the item
lefthand_file	Icon file for left hand inhand overlays
max_heat_protection_temperature	Set this variable to determine up to which temperature (IN KELVIN) the item protects against heat damage. Keep at null to disable protection. Only protects areas set by heat_protection flags
min_cold_protection_temperature	Set this variable to determine down to which temperature (IN KELVIN) the item protects against cold damage. 0 is NOT an acceptable number due to if(varname) tests!! Keep at null to disable protection. Only protects areas set by cold_protection flags
mob_throw_hit_sound	Used when yate into a mob
mouse_drag_pointer	the icon to indicate this object is being dragged
offensive_notes	Used in obj/item/examine to give additional notes on what the weapon does, separate from the predetermined output variables
override_notes	Used in obj/item/examine to determines whether or not to detail an item's statistics even if it does not meet the force requirements
permeability_coefficient	How likely a disease or chemical is to get through a piece of clothing
pickup_sound	Sound uses when picking the item up (into your hands)
reach	In tiles, how far this weapon can reach; 1 for adjacent, which is default
righthand_file	Icon file for right inhand overlays
sharpness	All items with sharpness of SHARP_EDGED or higher will automatically get the butchering component.
siemens_coefficient	for electrical admittance/conductance (electrocution checks and shit)
slot_equipment_priority	The list of slots by priority. equip_to_appropriate_slot() uses this list. Doesn't matter if a mob type doesn't have a slot. For default list, see /mob/proc/equip_to_appropriate_slot
slot_flags	This is used to determine on which slots an item can fit.
slowdown	How much clothing is slowing you down. Negative values speeds you up
species_exception	list() of species types, if a species cannot put items in a certain slot, but species type is in list, it will be able to wear that item
stealthy_audio	Whether or not we use stealthy audio levels for this item's attack sounds
strip_delay	In deciseconds, how long an item takes to remove from another person
thrownby	A weakref to the mob who threw the item
tk_throw_range	Items can by default thrown up to 10 tiles by TK users
tool_behaviour	How a tool acts when you use it on something, such as wirecutters cutting wires while multitools measure power
toolspeed	How fast does the tool work
transparent_protection	you can see someone's mask through their transparent visor, but you can't reach it
trigger_guard	Determines who can shoot this
undyeable	Whether the item is unaffected by standard dying.
usesound	Played when the item is used, for example tools
w_class	How large is the object, used for stuff like whether it can fit in backpacks or not
weak_against_armour	Whether or not our object is easily hindered by the presence of armor
worn_icon	Icon file for mob worn overlays.
worn_icon_state	Icon state for mob worn overlays, if null the normal icon_state will be used.
worn_x_dimension	Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly
worn_y_dimension	Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly
worn_y_offset	Worn overlay will be shifted by this along y axis
Procs
IsReflect	This proc determines if and at what an object will reflect energy projectiles if it's in l_hand,r_hand or wear_suit
add_weapon_description	Adds the weapon_description element, which shows the 'warning label' for especially dangerous objects. Override this for item types with special notes.
afterattack	Last proc in the /obj/item/proc/melee_attack_chain
afterattack_secondary	Called at the end of the attack chain if the user right-clicked.
attack	Called from [/mob/living/proc/attackby]
attack_obj	The equivalent of the standard version of /obj/item/proc/attack but for object targets.
attack_qdeleted	Called if the target gets deleted by our attack
attack_secondary	The equivalent of /obj/item/proc/attack but for alternate attacks, AKA right clicking
attack_self	Called when the item is in the active hand, and clicked; alternately, there is an 'activate held object' verb or you can hit pagedown.
attack_self_secondary	Called when the item is in the active hand, and right-clicked. Intended for alternate or opposite functions, such as lowering reagent transfer amount. At the moment, there is no verb or hotkey.
cyborg_unequip	Parent proc - triggers when an item/module is unequipped from a cyborg.
disableEmbedding	For when you want to disable an item's embedding capabilities (like transforming weapons and such), this proc will detach any active embed elements from it.
dropped	Called when a mob drops an item.
equipped	Called after an item is placed in an equipment slot.
failedEmbed	In case we want to do something special (like self delete) upon failing to embed in something.
get_belt_overlay	Returns the icon used for overlaying the object on a belt
get_part_rating	Returns a numeric value for sorting items used as parts in machines, so they can be replaced by the rped
get_sechud_job_icon_state	Returns the SecHUD job icon state for whatever this object's ID card is, if it has one.
get_sharpness	Returns the sharpness of src. If you want to get the sharpness of an item use this.
get_temperature	Returns the temperature of src. If you want to know if an item is hot use this proc.
get_worn_offsets	Returns offsets used for equipped item overlays in list(px_offset,py_offset) form.
handle_openspace_click	Called on [/datum/element/openspace_item_click_handler/proc/on_afterattack]. Check the relative file for information.
help_light_cig	Finds a cigarette on another mob to help light.
interact	Research prospects, including boostable nodes and point values. Deliver to a console to know whether the boosts have already been used. Separator between the items on the list Nodes that can be boosted
isEmbedHarmless	Does the current embedding var meet the criteria for being harmless? Namely, does it have a pain multiplier and jostle pain mult of 0? If so, return true.
item_action_slot_check	sometimes we only want to grant the item's action if it's equipped in a specific slot.
melee_attack_chain	This is the proc that handles the order of an item_attack.
mob_can_equip	the mob M is attempting to equip this item into the slot passed through as 'slot'. Return 1 if it can do this and 0 if it can't. if this is being done by a mob other than M, it will include the mob equipper, who is trying to equip the item to mob M. equipper will be null otherwise. If you are making custom procs but would like to retain partial or complete functionality of this one, include a 'return ..()' to where you want this to happen. Arguments:
on_found	called when "found" in pockets and storage items. Returns 1 if the search should end.
on_grind	Called BEFORE the object is ground up - use this to change grind results based on conditions. Use "return -1" to prevent the grinding from occurring
on_thrown	Called by the carbon throw_item() proc. Returns null if the item negates the throw, or a reference to the thing to suffer the throw else.
pickup	called just as an item is picked up (loc is not yet changed)
play_tool_sound	Plays item's usesound, if any.
pre_attack	Called on the item before it hits something
pre_attack_secondary	Called on the item before it hits something, when right clicking.
suicide_act	*Makes cool stuff happen when you suicide with an item
tool_check_callback	Used in a callback that is passed by use_tool into do_after call. Do not override, do not call manually.
tool_start_check	Called before obj/item/proc/use_tool if there is a delay, or by obj/item/proc/use_tool if there isn't. Only ever used by welding tools and stacks, so it's not added on any other obj/item/proc/use_tool checks.
tool_use_check	A check called by /obj/item/proc/tool_start_check once, and by use_tool on every tick of delay.
tryEmbed	tryEmbed() is for when you want to try embedding something without dealing with the damage + hit messages of calling hitby() on the item while targetting the target.
ui_action_click	This proc is executed when someone clicks the on-screen UI button. The default action is attack_self(). Checks before we get to here are: mob is alive, mob is not restrained, stunned, asleep, resting, laying, item is on the mob.
updateEmbedding	For when you want to add/update the embedding on an item. Uses the vars in /obj/item/var/embedding, and defaults to config values for values that aren't set. Will automatically detach previous embed elements on this item.
update_action_buttons	How many mats have we found? You can only be affected by two material datums by default How much of each material is in it? Used to determine if the glass should break The glass shard that is spawned into the source item victim's chest (for cavity implanting the item) Updates all action buttons associated with this item
update_greyscale	Checks if this atom uses the GAGS system and if so updates the worn and inhand icons
use	Generic use proc. Depending on the item, it uses up fuel, charges, sheets, etc. Returns TRUE on success, FALSE on failure.
use_tool	Called when a mob tries to use the item as a tool. Handles most checks.
visual_equipped	To be overwritten to only perform visual tasks; this is directly called instead of `equipped` on visual-only features like human dummies equipping outfits.

Var Details

var
actions
– /list

list of /datum/action's that this item has.

var
actions_types
– /list

list of paths of action datums to give to the item on New().

var
allowed
– /list

What objects the suit storage can store

var
alternate_worn_layer
–

Forced mob worn layer instead of the standard preferred ssize.

var
armour_penetration
–

percentage of armour effectiveness to remove

var
attack_verb_continuous
– /list

Used in atom/proc/attackby to say how something was attacked "[x] has been [z.attack_verb] by [y] with [z]"

var
belt_icon_state
–

Icon state for the belt overlay, if null the normal icon_state will be used.

var
body_parts_covered
–

What body parts are covered by the clothing when you wear it

var
breakouttime
–

How long it takes to resist out of the item (cuffs and such)

var
cold_protection
–

flags which determine which body parts are protected from cold. [See here][HEAD]

var
dog_fashion
– /datum/dog_fashion

Reference to the datum that determines whether dogs can wear the item: Needs to be in /obj/item because corgis can wear a lot of non-clothing items

var
drop_sound
–

Sound uses when dropping the item, or when its thrown.

var
dye_color
–

Used as the dye color source in the washing machine only (at the moment). Can be a hex color or a key corresponding to a registry entry, see washing_machine.dm

var
dying_key
–

What dye registry should be looked at when dying this item; see washing_machine.dm

var
embedding
– /list

Does it embed and if yes, what kind of embed

var
equip_delay_other
–

In deciseconds, how long an item takes to put on another person

var
equip_delay_self
–

In deciseconds, how long an item takes to equip; counts only for normal clothing slots, not pockets etc.

var
equip_sound
–

Sound used when equipping the item into a valid slot

var
flags_cover
–

for flags such as [GLASSESCOVERSEYES]

var
flags_inv
–

This flag is used to determine when items in someone's inventory cover others. IE helmets making it so you can't see glasses, etc.

var
force_string
–

string form of an item's force. Edit this var only to set a custom force string

var
gas_transfer_coefficient
–

Literally does nothing right now

var
greyscale_config_belt
–

The config type to use for greyscaled belt overlays. Both this and greyscale_colors must be assigned to work.

var
greyscale_config_inhand_left
–

The config type to use for greyscaled left inhand sprites. Both this and greyscale_colors must be assigned to work.

var
greyscale_config_inhand_right
–

The config type to use for greyscaled right inhand sprites. Both this and greyscale_colors must be assigned to work.

var
greyscale_config_worn
–

The config type to use for greyscaled worn sprites. Both this and greyscale_colors must be assigned to work.

var
grind_results
– /list

Grinder var:A reagent list containing the reagents this item produces when ground up in a grinder - this can be an empty list to allow for reagent transferring only

var
heat_protection
–

flags which determine which body parts are protected from heat. [See here][HEAD]

var
hitsound
–

Sound played when you hit something with the item

var
inhand_icon_state
–

icon state for inhand overlays, if null the normal icon_state will be used.

var
inhand_x_dimension
–

Same as for worn_x_dimension but for inhands, uses the lefthand_ and righthand_ file vars

var
inhand_y_dimension
–

Same as for worn_y_dimension but for inhands, uses the lefthand_ and righthand_ file vars

var
interaction_flags_item
–

flags for what should be done when you click on the item, default is picking it up

var
item_flags
–

Item flags for the item

var
lefthand_file
–

Icon file for left hand inhand overlays

var
max_heat_protection_temperature
–

Set this variable to determine up to which temperature (IN KELVIN) the item protects against heat damage. Keep at null to disable protection. Only protects areas set by heat_protection flags

var
min_cold_protection_temperature
–

Set this variable to determine down to which temperature (IN KELVIN) the item protects against cold damage. 0 is NOT an acceptable number due to if(varname) tests!! Keep at null to disable protection. Only protects areas set by cold_protection flags

var
mob_throw_hit_sound
–

Used when yate into a mob

mouse_drag_pointer
–

the icon to indicate this object is being dragged

var
offensive_notes
–

Used in obj/item/examine to give additional notes on what the weapon does, separate from the predetermined output variables

var
override_notes
–

Used in obj/item/examine to determines whether or not to detail an item's statistics even if it does not meet the force requirements

var
permeability_coefficient
–

How likely a disease or chemical is to get through a piece of clothing

var
pickup_sound
–

Sound uses when picking the item up (into your hands)

var
reach
–

In tiles, how far this weapon can reach; 1 for adjacent, which is default

var
righthand_file
–

Icon file for right inhand overlays

var
sharpness
–

All items with sharpness of SHARP_EDGED or higher will automatically get the butchering component.

var
siemens_coefficient
–

for electrical admittance/conductance (electrocution checks and shit)

var
slot_equipment_priority
– /list

The list of slots by priority. equip_to_appropriate_slot() uses this list. Doesn't matter if a mob type doesn't have a slot. For default list, see /mob/proc/equip_to_appropriate_slot

var
slot_flags
–

This is used to determine on which slots an item can fit.

var
slowdown
–

How much clothing is slowing you down. Negative values speeds you up

var
species_exception
– /list

list() of species types, if a species cannot put items in a certain slot, but species type is in list, it will be able to wear that item

var
stealthy_audio
–

Whether or not we use stealthy audio levels for this item's attack sounds

var
strip_delay
–

In deciseconds, how long an item takes to remove from another person

var
thrownby
– /datum/weakref

A weakref to the mob who threw the item

↑
tk_throw_range
–

Items can by default thrown up to 10 tiles by TK users

var
tool_behaviour
–

How a tool acts when you use it on something, such as wirecutters cutting wires while multitools measure power

var
toolspeed
–

How fast does the tool work

var
transparent_protection
–

you can see someone's mask through their transparent visor, but you can't reach it

var
trigger_guard
–

Determines who can shoot this

var
undyeable
–

Whether the item is unaffected by standard dying.

var
usesound
–

Played when the item is used, for example tools

var
w_class
–

How large is the object, used for stuff like whether it can fit in backpacks or not

var
weak_against_armour
–

Whether or not our object is easily hindered by the presence of armor

var
worn_icon
– /icon

Icon file for mob worn overlays.

var
worn_icon_state
–

Icon state for mob worn overlays, if null the normal icon_state will be used.

var
worn_x_dimension
–

Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly

var
worn_y_dimension
–

Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly

var
worn_y_offset
–

Worn overlay will be shifted by this along y axis

Proc Details

proc
IsReflect
(def_zone)

This proc determines if and at what an object will reflect energy projectiles if it's in l_hand,r_hand or wear_suit

proc
add_weapon_description
()

Adds the weapon_description element, which shows the 'warning label' for especially dangerous objects. Override this for item types with special notes.

proc
afterattack
(/atom/target, /mob/user, proximity_flag, click_parameters)

Last proc in the /obj/item/proc/melee_attack_chain

Arguments:

atom/target - The thing that was hit
mob/user - The mob doing the hitting
proximity_flag - is 1 if this afterattack was called on something adjacent, in your square, or on your person.
click_parameters - is the params string from byond /atom/proc/Click code, see that documentation.

proc
afterattack_secondary
(/atom/target, /mob/user, proximity_flag, click_parameters)

Called at the end of the attack chain if the user right-clicked.

Arguments:

atom/target - The thing that was hit
mob/user - The mob doing the hitting
proximity_flag - is 1 if this afterattack was called on something adjacent, in your square, or on your person.
click_parameters - is the params string from byond /atom/proc/Click code, see that documentation.

proc
attack
(/mob/living/M, /mob/living/user, params)

Called from [/mob/living/proc/attackby]

Arguments:

mob/living/M - The mob being hit by this item
mob/living/user - The mob hitting with this item
params - Click params of this attack

proc
attack_obj
(/obj/O, /mob/living/user, params)

The equivalent of the standard version of /obj/item/proc/attack but for object targets.

proc
attack_qdeleted
(/atom/target, /mob/user, proximity_flag, click_parameters)

Called if the target gets deleted by our attack

proc
attack_secondary
(/mob/living/victim, /mob/living/user, params)

The equivalent of /obj/item/proc/attack but for alternate attacks, AKA right clicking

proc
attack_self
(/mob/user, modifiers)

Called when the item is in the active hand, and clicked; alternately, there is an 'activate held object' verb or you can hit pagedown.

proc
attack_self_secondary
(/mob/user, modifiers)

Called when the item is in the active hand, and right-clicked. Intended for alternate or opposite functions, such as lowering reagent transfer amount. At the moment, there is no verb or hotkey.

proc
cyborg_unequip
(/mob/user)

Parent proc - triggers when an item/module is unequipped from a cyborg.

proc
disableEmbedding
()

For when you want to disable an item's embedding capabilities (like transforming weapons and such), this proc will detach any active embed elements from it.

proc
dropped
(/mob/user, silent)

Called when a mob drops an item.

proc
equipped
(/mob/user, slot, initial)

Called after an item is placed in an equipment slot.

Note that hands count as slots.

Arguments:

user is mob that equipped it
slot uses the slot_X defines found in setup.dm for items that can be placed in multiple slots
initial is used to indicate whether or not this is the initial equipment (job datums etc) or just a player doing it

proc
failedEmbed
()

In case we want to do something special (like self delete) upon failing to embed in something.

proc
get_belt_overlay
()

Returns the icon used for overlaying the object on a belt

proc
get_part_rating
()

Returns a numeric value for sorting items used as parts in machines, so they can be replaced by the rped

proc
get_sechud_job_icon_state
()

Returns the SecHUD job icon state for whatever this object's ID card is, if it has one.

proc
get_sharpness
()

Returns the sharpness of src. If you want to get the sharpness of an item use this.

proc
get_temperature
()

Returns the temperature of src. If you want to know if an item is hot use this proc.

proc
get_worn_offsets
(isinhands)

Returns offsets used for equipped item overlays in list(px_offset,py_offset) form.

proc
handle_openspace_click
(/turf/target, /mob/user, proximity_flag, click_parameters)

Called on [/datum/element/openspace_item_click_handler/proc/on_afterattack]. Check the relative file for information.

proc
help_light_cig
(/mob/living/M)

Finds a cigarette on another mob to help light.

interact
(/mob/user)

Research prospects, including boostable nodes and point values. Deliver to a console to know whether the boosts have already been used. Separator between the items on the list Nodes that can be boosted

proc
isEmbedHarmless
()

Does the current embedding var meet the criteria for being harmless? Namely, does it have a pain multiplier and jostle pain mult of 0? If so, return true.

proc
item_action_slot_check
(slot, /mob/user)

sometimes we only want to grant the item's action if it's equipped in a specific slot.

proc
melee_attack_chain
(/mob/user, /atom/target, params)

This is the proc that handles the order of an item_attack.

The order of procs called is:

/atom/proc/tool_act on the target. If it returns TOOL_ACT_TOOLTYPE_SUCCESS or TOOL_ACT_SIGNAL_BLOCKING, the chain will be stopped.
/obj/item/proc/pre_attack on src. If this returns TRUE, the chain will be stopped.
/atom/proc/attackby on the target. If it returns TRUE, the chain will be stopped.
/obj/item/proc/afterattack. The return value does not matter.

proc
mob_can_equip
(/mob/living/M, /mob/living/equipper, slot, disable_warning, bypass_equip_delay_self)

the mob M is attempting to equip this item into the slot passed through as 'slot'. Return 1 if it can do this and 0 if it can't. if this is being done by a mob other than M, it will include the mob equipper, who is trying to equip the item to mob M. equipper will be null otherwise. If you are making custom procs but would like to retain partial or complete functionality of this one, include a 'return ..()' to where you want this to happen. Arguments:

disable_warning to TRUE if you wish it to not give you text outputs.
slot is the slot we are trying to equip to
equipper is the mob trying to equip the item
bypass_equip_delay_self for whether we want to bypass the equip delay

proc
on_found
(/mob/finder)

called when "found" in pockets and storage items. Returns 1 if the search should end.

proc
on_grind
()

Called BEFORE the object is ground up - use this to change grind results based on conditions. Use "return -1" to prevent the grinding from occurring

proc
on_thrown
(/mob/living/carbon/user, /atom/target)

Called by the carbon throw_item() proc. Returns null if the item negates the throw, or a reference to the thing to suffer the throw else.

proc
pickup
(/mob/user)

called just as an item is picked up (loc is not yet changed)

proc
play_tool_sound
(/atom/target, volume)

Plays item's usesound, if any.

proc
pre_attack
(/atom/A, /mob/living/user, params)

Called on the item before it hits something

Arguments:

atom/A - The atom about to be hit
mob/living/user - The mob doing the htting
params - click params such as alt/shift etc

See: /obj/item/proc/melee_attack_chain

proc
pre_attack_secondary
(/atom/target, /mob/living/user, params)

Called on the item before it hits something, when right clicking.

Arguments:

atom/target - The atom about to be hit
mob/living/user - The mob doing the htting
params - click params such as alt/shift etc

See: /obj/item/proc/melee_attack_chain

proc
suicide_act
(/mob/user)

*Makes cool stuff happen when you suicide with an item

*Outputs a creative message and then return the damagetype done

Arguments:
- user: The mob that is suiciding

proc
tool_check_callback
(/mob/living/user, amount, /datum/callback/extra_checks)

Used in a callback that is passed by use_tool into do_after call. Do not override, do not call manually.

proc
tool_start_check
(/mob/living/user, amount)

Called before obj/item/proc/use_tool if there is a delay, or by obj/item/proc/use_tool if there isn't. Only ever used by welding tools and stacks, so it's not added on any other obj/item/proc/use_tool checks.

proc
tool_use_check
(/mob/living/user, amount)

A check called by /obj/item/proc/tool_start_check once, and by use_tool on every tick of delay.

proc
tryEmbed
(/atom/target, forced, silent)

tryEmbed() is for when you want to try embedding something without dealing with the damage + hit messages of calling hitby() on the item while targetting the target.

Really, this is used mostly with projectiles with shrapnel payloads, from /datum/element/embed/proc/checkEmbedProjectile, and called on said shrapnel. Mostly acts as an intermediate between different embed elements.

Returns TRUE if it embedded successfully, nothing otherwise

Arguments:

target- Either a body part or a carbon. What are we hitting?
forced- Do we want this to go through 100%?

proc
ui_action_click
(/mob/user, actiontype)

This proc is executed when someone clicks the on-screen UI button. The default action is attack_self(). Checks before we get to here are: mob is alive, mob is not restrained, stunned, asleep, resting, laying, item is on the mob.

proc
updateEmbedding
()

For when you want to add/update the embedding on an item. Uses the vars in /obj/item/var/embedding, and defaults to config values for values that aren't set. Will automatically detach previous embed elements on this item.

proc
update_action_buttons
(status_only, force)

How many mats have we found? You can only be affected by two material datums by default How much of each material is in it? Used to determine if the glass should break The glass shard that is spawned into the source item victim's chest (for cavity implanting the item) Updates all action buttons associated with this item

Arguments:

status_only - Update only current availability status of the buttons to show if they are ready or not to use
force - Force buttons update even if the given button icon state has not changed

↑
update_greyscale
()

Checks if this atom uses the GAGS system and if so updates the worn and inhand icons

proc
use
(used)

Generic use proc. Depending on the item, it uses up fuel, charges, sheets, etc. Returns TRUE on success, FALSE on failure.

proc
use_tool
(/atom/target, /mob/living/user, delay, amount, volume, /datum/callback/extra_checks)

Called when a mob tries to use the item as a tool. Handles most checks.

proc
visual_equipped
(/mob/user, slot, initial)

To be overwritten to only perform visual tasks; this is directly called instead of equipped on visual-only features like human dummies equipping outfits.

This separation exists to prevent things like the monkey sentience helmet from polling ghosts while it's just being equipped as a visual preview for a dummy.

item /obj/item

Vars

Procs

Var Details

var actions – /list

var actions_types – /list

var allowed – /list

var alternate_worn_layer –

var armour_penetration –

var attack_verb_continuous – /list

var belt_icon_state –

var body_parts_covered –

var breakouttime –

var cold_protection –

var dog_fashion – /datum/dog_fashion

var drop_sound –

var dye_color –

var dying_key –

var embedding – /list

var equip_delay_other –

var equip_delay_self –

var equip_sound –

var flags_cover –

var flags_inv –

var force_string –

var gas_transfer_coefficient –

var greyscale_config_belt –

var greyscale_config_inhand_left –

var greyscale_config_inhand_right –

var greyscale_config_worn –

var grind_results – /list

var heat_protection –

var hitsound –

var inhand_icon_state –

var inhand_x_dimension –

var inhand_y_dimension –

var interaction_flags_item –

var item_flags –

var lefthand_file –

var max_heat_protection_temperature –

var min_cold_protection_temperature –

var mob_throw_hit_sound –

mouse_drag_pointer –

var offensive_notes –

var override_notes –

var permeability_coefficient –

var pickup_sound –

var reach –

var righthand_file –

var sharpness –

var siemens_coefficient –

var slot_equipment_priority – /list

var slot_flags –

var slowdown –

var species_exception – /list

var stealthy_audio –

var strip_delay –

var thrownby – /datum/weakref

↑tk_throw_range –

var tool_behaviour –

var toolspeed –

var transparent_protection –

var trigger_guard –

var undyeable –

var usesound –

var w_class –

var weak_against_armour –

var worn_icon – /icon

var worn_icon_state –

var worn_x_dimension –

var worn_y_dimension –

var worn_y_offset –

Proc Details

proc IsReflect(def_zone)

proc add_weapon_description()

proc afterattack(/atom/target, /mob/user, proximity_flag, click_parameters)

proc afterattack_secondary(/atom/target, /mob/user, proximity_flag, click_parameters)

proc attack(/mob/living/M, /mob/living/user, params)

proc attack_obj(/obj/O, /mob/living/user, params)

proc attack_qdeleted(/atom/target, /mob/user, proximity_flag, click_parameters)

item
/obj/item

var
actions
– /list

var
actions_types
– /list

var
allowed
– /list

var
alternate_worn_layer
–

var
armour_penetration
–

var
attack_verb_continuous
– /list

var
belt_icon_state
–

var
body_parts_covered
–

var
breakouttime
–

var
cold_protection
–

var
dog_fashion
– /datum/dog_fashion

var
drop_sound
–

var
dye_color
–

var
dying_key
–

var
embedding
– /list

var
equip_delay_other
–

var
equip_delay_self
–

var
equip_sound
–

var
flags_cover
–

var
flags_inv
–

var
force_string
–

var
gas_transfer_coefficient
–

var
greyscale_config_belt
–

var
greyscale_config_inhand_left
–

var
greyscale_config_inhand_right
–

var
greyscale_config_worn
–

var
grind_results
– /list

var
heat_protection
–

var
hitsound
–

var
inhand_icon_state
–

var
inhand_x_dimension
–

var
inhand_y_dimension
–

var
interaction_flags_item
–

var
item_flags
–

var
lefthand_file
–

var
max_heat_protection_temperature
–

var
min_cold_protection_temperature
–

var
mob_throw_hit_sound
–

mouse_drag_pointer
–

var
offensive_notes
–

var
override_notes
–

var
permeability_coefficient
–

var
pickup_sound
–

var
reach
–

var
righthand_file
–

var
sharpness
–

var
siemens_coefficient
–

var
slot_equipment_priority
– /list

var
slot_flags
–

var
slowdown
–

var
species_exception
– /list

var
stealthy_audio
–

var
strip_delay
–

var
thrownby
– /datum/weakref

↑
tk_throw_range
–

var
tool_behaviour
–

var
toolspeed
–

var
transparent_protection
–

var
trigger_guard
–

var
undyeable
–

var
usesound
–

var
w_class
–

var
weak_against_armour
–

var
worn_icon
– /icon

var
worn_icon_state
–

var
worn_x_dimension
–

var
worn_y_dimension
–

var
worn_y_offset
–

proc
IsReflect
(def_zone)

proc
add_weapon_description
()

proc
afterattack
(/atom/target, /mob/user, proximity_flag, click_parameters)

proc
afterattack_secondary
(/atom/target, /mob/user, proximity_flag, click_parameters)

proc
attack
(/mob/living/M, /mob/living/user, params)

proc
attack_obj
(/obj/O, /mob/living/user, params)

proc
attack_qdeleted
(/atom/target, /mob/user, proximity_flag, click_parameters)

proc
attack_secondary
(/mob/living/victim, /mob/living/user, params)

proc
attack_self
(/mob/user, modifiers)

proc
attack_self_secondary
(/mob/user, modifiers)

proc
cyborg_unequip
(/mob/user)