item

Vars
action_icon	list of icons-sheets for a given action to override the icon.
action_icon_state	list of icon states for a given action to override the icon_state.
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	suit storage stuff.
armour_penetration	percentage of armour effectiveness to remove
attack_effect_override	Allows you to override the attack animation with an attack effect
attack_speed	The click cooldown given after attacking. Lower numbers means faster attacks
attack_verb	Used in attackby() to say how something was attacked "[x] has been [z.attack_verb] by [y] with [z]".
body_parts_covered	see setup.dm for appropriate bit flags
cold_protection	flags which determine which body parts are protected from cold. Use the HEAD, UPPER_TORSO, LOWER_TORSO, etc. flags. See setup.dm
drop_sound	Sound used when dropping the item. May contain a list of sounds to pick from instead of a single path.
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
embed_chance	So items can have custom embedd values Because customisation is king
embedded_fall_pain_multiplier	The coefficient of multiplication for the damage this item does when falling out of a limb (this*w_class)
embedded_impact_pain_multiplier	The coefficient of multiplication for the damage this item does when first embedded (this*w_class)
embedded_pain_multiplier	The coefficient of multiplication for the damage this item does while embedded (this*w_class)
embedded_unsafe_removal_pain_multiplier	The coefficient of multiplication for the damage removing this without surgery causes (this*w_class)
embedded_unsafe_removal_time	A time in ticks, multiplied by the w_class.
enchant_type	What's the type on enchantment on it? 0
enchants	List(datum)
equip_delay_self	In deciseconds, how long an item takes to equip/unequip; counts only for normal clothing slots, not pockets, hands etc.
equip_sound	Sound used when equipping the item into a valid slot. May contain a list of sounds to pick from instead of a single path.
flags_cover	Special cover flags used for protection calculations.
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.
flags_inv_transparent	These flags will be added/removed (^=) to/from flags_inv in [/proc/check_obscured_slots()] if check_transparent argument is set to `TRUE`. Used in carbon's update icons shenanigans. Example: you can see someone's mask through their transparent visor, but you cannot reach it
gas_transfer_coefficient	0 prevents all transfers, 1 is invisible for leaking gas from turf to mask and vice-versa (for masks right now, but at some point, i'd like to include space helmets)
ground_offset_x	How much to offset the item randomly either way alongside X visually
ground_offset_y	How much to offset the item randomly either way alongside Y visually
has_speed_harvest	Used in butchering of animals, set to TRUE for near instant butchering
heat_protection	flags which determine which body parts are protected from heat. Use the HEAD, UPPER_TORSO, LOWER_TORSO, etc. flags. See setup.dm
hidden_uplink	All items can have an uplink hidden inside, just remember to add the triggers.
hit_reaction_chance	If you want to have something unrelated to blocking/armour piercing etc. Maybe not needed, but trying to think ahead/allow more freedom
hitsound	Sound played when you hit something with the item.
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
item_flags	Flags only used with items.
item_pixel_shift	Datum used in item pixel shift TGUI
item_state_color	if you want to color icon in hands, but not a icon of item
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.
move_resist	Set in the Initialise depending on the item size. Unless it's overriden by a specific item
needs_permit	Used by security bots to determine if this item is safe for public use.
onmob_sheets	Sprite sheets used to render clothing, if none of sprite_sheets are used
outline_filter	Holder var for the item outline filter, null when no outline filter on the item.
permeability_coefficient	for chemicals/diseases
pickup_sound	Sound used when picking the item up (into your hands). May contain a list of sounds to pick from instead of a single path.
shields_penetration	amount by which block_chance decreases
siemens_coefficient	for electrical admittance/conductance (electrocution checks and shit)
slot_flags	This is used to determine on which slots an item can fit.
slot_flags_2	Additional slot flags, mostly used by humans.
slowdown	How much clothing is slowing you down. Negative values speeds you up
sound_cooldown	Used for hit sound cooldown
sprite_sheets	Sprite sheets to render species clothing, takes priority over "onmob_sheets" var, but only takes one dmi
sprite_sheets_inhand	Used to override inhand items. Use a single .dmi and suffix the icon states inside with _l and _r for each hand.
stealthy_audio	Whether or not we use stealthy audio levels for this item's attack sounds
thrownby	UID of a /mob that threw the item.
tool_behaviour	What kind of tool are we?
tool_enabled	If we can turn on or off, are we currently active? Mostly for welders and this will normally be TRUE
tool_mode	For tools that have an extra mode.
tool_volume	How loud are we when we use our tool?
toolbox_radial_menu_compatibility	For tools that can be used from toolbox via radial menu
toolspeed	If this item is a tool, the speed multiplier
undyeable	Whether the item is unaffected by standard dying.
usesound	Played when the item is used, for example tools.
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
Procs
Adjacent	This is necessary for storage items not on your person.
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
active_uplink_check	I placed this here because of how relevant it is. You place this in your uplinkable item to check if an uplink is active or not. If it is, it will display the uplink menu and return `TRUE`, else it'll return `FALSE`. If it returns true, I recommend closing the item's normal menu with "user << browse(null, "window=name")"
allow_attack_hand_drop	If we want to stop manual unequipping of item by hands, but only for user himself (almost NODROP)
allowed_for_alien	If xenos can manipulate with this item.
attack	Called from [/mob/living/proc/attackby]
attack_obj	The equivalent of the standard version of /obj/item/proc/attack but for object targets.
camera_upgrade	Camera upgrading stuff.
can_enter_storage	Called to check if this item can be put into a storage item.
carbon_skip_catch_check	Individual check for items to skip catching.
dropped	When item is officially left user
dye_item	Updates an item's appearance to mimic the appearance of another item in the dye_registry's dictionary what types of items (beanie, jumpsuit, shoes, etc) src is dyed into depends on the dye_key unless an overidden dye_key is specified. For example if our dye_key is DYE_REGISTRY_UNDER and we specify to dye to DYE_RED, our item's appearance would then mimic /obj/item/clothing/under/color/red; see [code/_globalvars/lists/dye_registry.dm] for this dictionary
equip_to_best_slot	Puts item into best inventory slot. If all slots are filled, item attempts to move in storage: container in offhand, belt, backpack. Proc is a real action after mob's client quick_equip hotkey is pressed. You can override it for diferent behavior.
equipped	Called after an item is placed in an equipment slot. Note that hands count as slots.
forceMove_turf	Simple helper we need to call before putting any item in hands, to allow fancy animation. Item will be forceMoved() to turf below its holder.
get_clamped_volume	Return sound volumet between 10 and 100, depending on the item weight class
get_heat	Generic get_heat proc. Returns 0 or number amount of heat an item gives.
give_item_action	Gives one of our item actions to a mob, when equipped to a certain slot
handle_openspace_click	Called on [/datum/element/openspace_item_click_handler/proc/on_afterattack]. Check the relative file for information.
is_crutch	Returns an effectiveness of an item as a crunch, which allow mobs to stand if they are missing a leg/foot?
is_equipped	Returns `TRUE` if the item is equipped by a mob, `FALSE` otherwise. This might need some error trapping, not sure if get_equipped_items() is safe for non-human mobs.
is_equivalent	Check used for telekinesis grabs
is_on_user	Proc that checks if item is on user
item_action_slot_check	Some items only give their actions buttons when in a specific slot.
mark_target	Used to mark a target for the demo system during a melee attack chain, call this before return
melee_attack_chain	This is the proc that handles the order of an item_attack.
mob_can_equip	Mob 'M' is attempting to equip this item into the slot passed through as 'slot'. Return `TRUE` if it can do this and `FALSE` 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.
on_enter_storage	Called when this item is added into a storage item, which is passed on as S. The loc variable is already set to the storage item.
on_exit_storage	Called when this item is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.
on_found	Called when "found" in pockets and storage items. Returns 1 if the search should end.
on_give	Called when the giver gives it to the receiver.
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)
pre_attackby	Called on the item before it hits something
remove_item_from_storage	please use this if you're going to snowflake an item out of a obj/item/storage
run_drop_held_item	This proc is called whenever mob's client presses 'drop_held_object' hotkey Not for robots since they have their own key in [keybindinds/robot.dm] You can easily overriride it for different behavior on other items.
select_skin	Global item proc for all of your unique item skin needs. Works with any item, and will change the skin to whatever you specify here. You can also manually override the icon with a unique skin if wanted, for the outlier cases. Override_icon_state should be a list. Generally requires NO_GAMEMODE_SKIN to not be set for changes to be applied.
separate_worn_overlays	worn_overlays to use when you'd want to use KEEP_APART. Don't use KEEP_APART neither there nor here, as it would break floating overlays
sharpen_act	Default item sharpening effect. Return `FALSE` to stop sharpening.
tool_attack_chain	Called on the item to check if it has any of the tool's behavior
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, paralyzed, asleep, resting, laying, item is on the mob.
use_tool	Called when a mob tries to use the item as a tool. Handles most checks.
used_for_ventcrawling	Conditional proc that allows ventcrawling with an item, if it has trait TRAIT_VENTCRAWLER_ITEM_BASED.
user_can_equip	Additional can equip checks when equipping is done by the user, and not by the code: /mob/verb/quick_equip
worn_overlays	Overlays for the worn overlay so you can overlay while you overlay eg: ammo counters, primed grenade flashing, etc. "icon_file" is used automatically for inhands etc. to make sure it gets the right inhand file

Var Details

var
action_icon
– /list

list of icons-sheets for a given action to override the icon.

var
action_icon_state
– /list

list of icon states for a given action to override the icon_state.

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

suit storage stuff.

var
armour_penetration
–

percentage of armour effectiveness to remove

var
attack_effect_override
–

Allows you to override the attack animation with an attack effect

var
attack_speed
–

The click cooldown given after attacking. Lower numbers means faster attacks

var
attack_verb
– /list

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

var
body_parts_covered
–

see setup.dm for appropriate bit flags

var
cold_protection
–

flags which determine which body parts are protected from cold. Use the HEAD, UPPER_TORSO, LOWER_TORSO, etc. flags. See setup.dm

var
drop_sound
–

Sound used when dropping the item. May contain a list of sounds to pick from instead of a single path.

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

So items can have custom embedd values Because customisation is king

var
embedded_fall_pain_multiplier
–

The coefficient of multiplication for the damage this item does when falling out of a limb (this*w_class)

var
embedded_impact_pain_multiplier
–

The coefficient of multiplication for the damage this item does when first embedded (this*w_class)

var
embedded_pain_multiplier
–

The coefficient of multiplication for the damage this item does while embedded (this*w_class)

var
embedded_unsafe_removal_pain_multiplier
–

The coefficient of multiplication for the damage removing this without surgery causes (this*w_class)

var
embedded_unsafe_removal_time
–

A time in ticks, multiplied by the w_class.

var
enchant_type
–

What's the type on enchantment on it? 0

var
enchants
– /list

List(datum)

var
equip_delay_self
–

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

var
equip_sound
–

Sound used when equipping the item into a valid slot. May contain a list of sounds to pick from instead of a single path.

var
flags_cover
–

Special cover flags used for protection calculations.

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

These flags will be added/removed (^=) to/from flags_inv in [/proc/check_obscured_slots()] if check_transparent argument is set to TRUE. Used in carbon's update icons shenanigans. Example: you can see someone's mask through their transparent visor, but you cannot reach it

var
gas_transfer_coefficient
–

0 prevents all transfers, 1 is invisible for leaking gas from turf to mask and vice-versa (for masks right now, but at some point, i'd like to include space helmets)

var
ground_offset_x
–

How much to offset the item randomly either way alongside X visually

var
ground_offset_y
–

How much to offset the item randomly either way alongside Y visually

var
has_speed_harvest
–

Used in butchering of animals, set to TRUE for near instant butchering

var
heat_protection
–

flags which determine which body parts are protected from heat. Use the HEAD, UPPER_TORSO, LOWER_TORSO, etc. flags. See setup.dm

var
hidden_uplink
– /obj/item/uplink/hidden

All items can have an uplink hidden inside, just remember to add the triggers.

var
hit_reaction_chance
–

If you want to have something unrelated to blocking/armour piercing etc. Maybe not needed, but trying to think ahead/allow more freedom

var
hitsound
–

Sound played when you hit something with the item.

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

Flags only used with items.

var
item_pixel_shift
– /datum/ui_module/item_pixel_shift

Datum used in item pixel shift TGUI

var
item_state_color
–

if you want to color icon in hands, but not a icon of item

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.

move_resist
–

Set in the Initialise depending on the item size. Unless it's overriden by a specific item

var
needs_permit
–

Used by security bots to determine if this item is safe for public use.

var
onmob_sheets
– /list

Sprite sheets used to render clothing, if none of sprite_sheets are used

var
outline_filter
–

Holder var for the item outline filter, null when no outline filter on the item.

var
permeability_coefficient
–

for chemicals/diseases

var
pickup_sound
–

Sound used when picking the item up (into your hands). May contain a list of sounds to pick from instead of a single path.

var
shields_penetration
–

amount by which block_chance decreases

var
siemens_coefficient
–

for electrical admittance/conductance (electrocution checks and shit)

var
slot_flags
–

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

var
slot_flags_2
–

Additional slot flags, mostly used by humans.

var
slowdown
–

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

var
sound_cooldown
–

Used for hit sound cooldown

var
sprite_sheets
– /list

Sprite sheets to render species clothing, takes priority over "onmob_sheets" var, but only takes one dmi

var
sprite_sheets_inhand
– /list

Used to override inhand items. Use a single .dmi and suffix the icon states inside with _l and _r for each hand.

var
stealthy_audio
–

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

var
thrownby
–

UID of a /mob that threw the item.

var
tool_behaviour
–

What kind of tool are we?

var
tool_enabled
–

If we can turn on or off, are we currently active? Mostly for welders and this will normally be TRUE

var
tool_mode
–

For tools that have an extra mode.

var
tool_volume
–

How loud are we when we use our tool?

var
toolbox_radial_menu_compatibility
–

For tools that can be used from toolbox via radial menu

var
toolspeed
–

If this item is a tool, the speed multiplier

var
undyeable
–

Whether the item is unaffected by standard dying.

var
usesound
–

Played when the item is used, for example tools.

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

Proc Details

↑
Adjacent
(/atom/neighbor, /atom/target, /atom/movable/mover, recurse)

This is necessary for storage items not on your person.

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
active_uplink_check
(/mob/user)

I placed this here because of how relevant it is. You place this in your uplinkable item to check if an uplink is active or not. If it is, it will display the uplink menu and return TRUE, else it'll return FALSE. If it returns true, I recommend closing the item's normal menu with "user << browse(null, "window=name")"

proc
allow_attack_hand_drop
(/mob/user)

If we want to stop manual unequipping of item by hands, but only for user himself (almost NODROP)

proc
allowed_for_alien
()

If xenos can manipulate with this item.

proc
attack
(/mob/living/target, /mob/living/user, params, def_zone, skip_attack_anim)

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

Arguments:

mob/living/target - The mob being hit by this item
mob/living/user - The mob hitting with this item
params - Click params of this attack
def_zone - Bodypart zone, targeted by the wielder of this item
skip_attack_anim - If TRUE will not animate hitting mob's attack

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

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

proc
camera_upgrade
(/obj/machinery/camera/target, power_use_update)

Camera upgrading stuff.

proc
can_enter_storage
(/obj/item/storage/S, /mob/user)

Called to check if this item can be put into a storage item.

Return FALSE if src can't be inserted, and TRUE if it can. Arguments:

S - The /obj/item/storage that src is being inserted into.
user - The mob trying to insert the item.

proc
carbon_skip_catch_check
(/mob/living/carbon/user)

Individual check for items to skip catching.

proc
dropped
(/mob/user, slot, silent)

When item is officially left user

proc
dye_item
(dye_color, dye_key_override)

Updates an item's appearance to mimic the appearance of another item in the dye_registry's dictionary what types of items (beanie, jumpsuit, shoes, etc) src is dyed into depends on the dye_key unless an overidden dye_key is specified. For example if our dye_key is DYE_REGISTRY_UNDER and we specify to dye to DYE_RED, our item's appearance would then mimic /obj/item/clothing/under/color/red; see [code/_globalvars/lists/dye_registry.dm] for this dictionary

once everything is updated, the target type path that we dyed the item into is returned

Arguments:

dye_color: the DYE_COLOR specifies which dye color we look up to copy apearances from in the dye_registry; cannot be null
dye_key_override: this overrides the items dyeing_key which allows you to force the proc to use a specific lookup key for the dye_registry; this can be null

proc
equip_to_best_slot
(/mob/user, force, drop_on_fail, qdel_on_fail, silent)

Puts item into best inventory slot. If all slots are filled, item attempts to move in storage: container in offhand, belt, backpack. Proc is a real action after mob's client quick_equip hotkey is pressed. You can override it for diferent behavior.

Arguments:

'force' - set to TRUE if you want to ignore equip delay and clothing obscuration.
'drop_on_fail' - set to TRUE if item should be dropped on equip fail.
'qdel_on_fail' - set to TRUE if item should be deleted on equip fail.
'silent' - set to TRUE if you want no warning messages on fail.

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
forceMove_turf
()

Simple helper we need to call before putting any item in hands, to allow fancy animation. Item will be forceMoved() to turf below its holder.

proc
get_clamped_volume
()

Return sound volumet between 10 and 100, depending on the item weight class

proc
get_heat
()

Generic get_heat proc. Returns 0 or number amount of heat an item gives.

proc
give_item_action
(slot, /mob/user, /datum/action/action)

Gives one of our item actions to a mob, when equipped to a certain slot

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
is_crutch
()

Returns an effectiveness of an item as a crunch, which allow mobs to stand if they are missing a leg/foot?

proc
is_equipped
(include_pockets, include_hands)

Returns TRUE if the item is equipped by a mob, FALSE otherwise. This might need some error trapping, not sure if get_equipped_items() is safe for non-human mobs.

proc
is_equivalent
(/obj/item/I)

Check used for telekinesis grabs

proc
is_on_user
(/mob/living/user)

Proc that checks if item is on user

proc
item_action_slot_check
(slot, /mob/user, /datum/action/action)

Some items only give their actions buttons when in a specific slot.

proc
mark_target
(/atom/target)

Used to mark a target for the demo system during a melee attack chain, call this before return

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_attack_chain]
/obj/item/proc/pre_attackby
/atom/proc/attackby
[/obj/item/proc/afterattack]

All the procs in the attack chain SHOULD return one of the two core bitflags:

ATTACK_CHAIN_PROCEED - to proceed into the next step
ATTACK_CHAIN_BLOCKED - to stop attack chain on the current step (will not affect afterattack, since it has a separate flag)

Optional bitflags:

ATTACK_CHAIN_SUCCESS - indicates that something meaningful was done on one of the previous steps; basically additional to ATTACK_CHAIN_BLOCKED flag, we are checking to proceed, in some of the children overrides
ATTACK_CHAIN_NO_AFTERATTACK - completely skips afterattack

Returns a combination of all the bitflags we get on every step of the chain.

proc
mob_can_equip
(/mob/M, slot, disable_warning, bypass_equip_delay_self, bypass_obscured, bypass_incapacitated)

Mob 'M' is attempting to equip this item into the slot passed through as 'slot'. Return TRUE if it can do this and FALSE 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' set to TRUE if you wish no text outputs
'slot' is the slot we are trying to equip to
'bypass_equip_delay_self' for whether we want to bypass the equip delay
'bypass_obscured' for whether we want to ignore clothing obscuration
'bypass_incapacitated' wheter we are ignoring user's incapacitated status (uded only for hands currently)

proc
on_enter_storage
(/obj/item/storage/S)

Called when this item is added into a storage item, which is passed on as S. The loc variable is already set to the storage item.

proc
on_exit_storage
(/obj/item/storage/S)

Called when this item is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.

proc
on_found
(/mob/finder)

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

proc
on_give
(/mob/living/carbon/giver, /mob/living/carbon/receiver)

Called when the giver gives it to the receiver.

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
pre_attackby
(/atom/target, /mob/living/user, params)

Called on the item before it hits something

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
remove_item_from_storage
(/atom/newLoc)

please use this if you're going to snowflake an item out of a obj/item/storage

proc
run_drop_held_item
(/mob/user)

This proc is called whenever mob's client presses 'drop_held_object' hotkey Not for robots since they have their own key in [keybindinds/robot.dm] You can easily overriride it for different behavior on other items.

proc
select_skin
(new_skin)

Global item proc for all of your unique item skin needs. Works with any item, and will change the skin to whatever you specify here. You can also manually override the icon with a unique skin if wanted, for the outlier cases. Override_icon_state should be a list. Generally requires NO_GAMEMODE_SKIN to not be set for changes to be applied.

Returns whether changes were applied.

proc
separate_worn_overlays
(/mutable_appearance/standing, /mutable_appearance/draw_target, isinhands, icon_file)

worn_overlays to use when you'd want to use KEEP_APART. Don't use KEEP_APART neither there nor here, as it would break floating overlays

proc
sharpen_act
(/obj/item/whetstone/whetstone, /mob/user)

Default item sharpening effect. Return FALSE to stop sharpening.

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

Called on the item to check if it has any of the tool's behavior

Arguments:

mob/user - The mob holding the tool
atom/target - The atom about to be tooled
params - click params such as alt/shift etc

See: /obj/item/proc/melee_attack_chain

proc
ui_action_click
(/mob/user, /datum/action/action, leftclick)

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, paralyzed, asleep, resting, laying, item is on the mob.

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
used_for_ventcrawling
(/mob/living/user, provide_feedback)

Conditional proc that allows ventcrawling with an item, if it has trait TRAIT_VENTCRAWLER_ITEM_BASED.

proc
user_can_equip
(/mob/user, silent)

Additional can equip checks when equipping is done by the user, and not by the code: /mob/verb/quick_equip

proc
worn_overlays
(/mutable_appearance/standing, isinhands, icon_file)

Overlays for the worn overlay so you can overlay while you overlay eg: ammo counters, primed grenade flashing, etc. "icon_file" is used automatically for inhands etc. to make sure it gets the right inhand file

item /obj/item

Vars

Procs

Var Details

var action_icon – /list

var action_icon_state – /list

var actions – /list

var actions_types – /list

var allowed – /list

var armour_penetration –

var attack_effect_override –

var attack_speed –

var attack_verb – /list

var body_parts_covered –

var cold_protection –

var drop_sound –

var dye_color –

var dying_key –

var embed_chance –

var embedded_fall_pain_multiplier –

var embedded_impact_pain_multiplier –

var embedded_pain_multiplier –

var embedded_unsafe_removal_pain_multiplier –

var embedded_unsafe_removal_time –

var enchant_type –

var enchants – /list

var equip_delay_self –

var equip_sound –

var flags_cover –

var flags_inv –

var flags_inv_transparent –

var gas_transfer_coefficient –

var ground_offset_x –

var ground_offset_y –

var has_speed_harvest –

var heat_protection –

var hidden_uplink – /obj/item/uplink/hidden

var hit_reaction_chance –

var hitsound –

var inhand_x_dimension –

var inhand_y_dimension –

var item_flags –

var item_pixel_shift – /datum/ui_module/item_pixel_shift

var item_state_color –

var max_heat_protection_temperature –

var min_cold_protection_temperature –

var mob_throw_hit_sound –

move_resist –

var needs_permit –

var onmob_sheets – /list

var outline_filter –

var permeability_coefficient –

var pickup_sound –

var shields_penetration –

var siemens_coefficient –

var slot_flags –

var slot_flags_2 –

var slowdown –

var sound_cooldown –

var sprite_sheets – /list

var sprite_sheets_inhand – /list

var stealthy_audio –

var thrownby –

var tool_behaviour –

var tool_enabled –

var tool_mode –

var tool_volume –

var toolbox_radial_menu_compatibility –

var toolspeed –

var undyeable –

var usesound –

var worn_x_dimension –

var worn_y_dimension –

Proc Details

↑Adjacent(/atom/neighbor, /atom/target, /atom/movable/mover, recurse)

proc IsReflect(def_zone)

proc active_uplink_check(/mob/user)

proc allow_attack_hand_drop(/mob/user)

proc allowed_for_alien()

proc attack(/mob/living/target, /mob/living/user, params, def_zone, skip_attack_anim)

item
/obj/item

var
action_icon
– /list

var
action_icon_state
– /list

var
actions
– /list

var
actions_types
– /list

var
allowed
– /list

var
armour_penetration
–

var
attack_effect_override
–

var
attack_speed
–

var
attack_verb
– /list

var
body_parts_covered
–

var
cold_protection
–

var
drop_sound
–

var
dye_color
–

var
dying_key
–

var
embed_chance
–

var
embedded_fall_pain_multiplier
–

var
embedded_impact_pain_multiplier
–

var
embedded_pain_multiplier
–

var
embedded_unsafe_removal_pain_multiplier
–

var
embedded_unsafe_removal_time
–

var
enchant_type
–

var
enchants
– /list

var
equip_delay_self
–

var
equip_sound
–

var
flags_cover
–

var
flags_inv
–

var
flags_inv_transparent
–

var
gas_transfer_coefficient
–

var
ground_offset_x
–

var
ground_offset_y
–

var
has_speed_harvest
–

var
heat_protection
–

var
hidden_uplink
– /obj/item/uplink/hidden

var
hit_reaction_chance
–

var
hitsound
–

var
inhand_x_dimension
–

var
inhand_y_dimension
–

var
item_flags
–

var
item_pixel_shift
– /datum/ui_module/item_pixel_shift

var
item_state_color
–

var
max_heat_protection_temperature
–

var
min_cold_protection_temperature
–

var
mob_throw_hit_sound
–

move_resist
–

var
needs_permit
–

var
onmob_sheets
– /list

var
outline_filter
–

var
permeability_coefficient
–

var
pickup_sound
–

var
shields_penetration
–

var
siemens_coefficient
–

var
slot_flags
–

var
slot_flags_2
–

var
slowdown
–

var
sound_cooldown
–

var
sprite_sheets
– /list

var
sprite_sheets_inhand
– /list

var
stealthy_audio
–

var
thrownby
–

var
tool_behaviour
–

var
tool_enabled
–

var
tool_mode
–

var
tool_volume
–

var
toolbox_radial_menu_compatibility
–

var
toolspeed
–

var
undyeable
–

var
usesound
–

var
worn_x_dimension
–

var
worn_y_dimension
–

↑
Adjacent
(/atom/neighbor, /atom/target, /atom/movable/mover, recurse)

proc
IsReflect
(def_zone)

proc
active_uplink_check
(/mob/user)

proc
allow_attack_hand_drop
(/mob/user)

proc
allowed_for_alien
()

proc
attack
(/mob/living/target, /mob/living/user, params, def_zone, skip_attack_anim)

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

proc
camera_upgrade
(/obj/machinery/camera/target, power_use_update)

proc
can_enter_storage
(/obj/item/storage/S, /mob/user)

proc
carbon_skip_catch_check
(/mob/living/carbon/user)