item

Base vars & procs

Vars
amount	This is for things which are stackable! It means that there are [amount] things here, which could be discretely split or stacked! if you use this to represent something other than a literal stack of items I will break your kneecaps
attack_verbs	Verb used when you attack someone with this, as in [attacker] [attack_verbs] [victim]. Can be a list or single entry
brew_result	What reagent will it make if it's brewable?
burn_output	How hot does the item burn once on fire
burn_point	Ambient temperature at which the item may spontaneously ignite
burn_possible	Is this item burnable
burn_remains	What is left when it's burnt up
burning	Are we currently burning
burning_last_process	Keep track of last burning state
equip_sfx	Sound for when you equip this from an inventory (ie not a turf)
firesource	Is this a valid source for lighting fires
hat_offset_x	Used for the hattable component
hat_offset_y	Used for the hattable component
health	How long an item takes to burn (or be consumed by other means), based on the weight class if no value is set
inhand_color	set to a colour to make the inhand image be that colour. if the item is coloured though that takes priority over this variable
item_state	The in-hand icon state
leaves_slash_wound	when attacking, this item can leave a slash wound
master	This var fucking sucks. It's used for prox sensors and other stuff that when triggered trigger an item they're attached to. Why is this on /item i am so sad
mimic_chance	Chance for this item to be replaced by a mimic disguised as it - note, setting this high here is a really bad idea
pickup_sfx	Sound for when you pick this up from anywhere. If null, we auto-pick from a list based on w_class
stored	storage datum holding it
wear_state	icon state used for worn sprites, icon_state used otherwise
Procs
AfterAttack	Call this proc inplace of afterattack(...)
AttackSelf	Call this proc inplace of attack_self(...)
UpdateStackAppearance	Don't override this, override _update_stack_appearance() instead.
_update_stack_appearance	Call UpdateStackAppearance() instead.
afterattack	DO NOT CALL THIS PROC - Call AfterAttack(...) Instead!
assembly_get_admin_log_message	This will be called when the item is build into a /obj/item/assembly on get_admin_log_message(). Use this for additional information for logging.
assembly_get_part_help_message	This will be called when the item is build into a /obj/item/assembly on get_help_message()
attack_self	DO NOT CALL THIS PROC - Call AttackSelf(...) Instead!
enchant	Enchants an item (minor armor boost for clothing, otherwise increases melee damage)
force_drop	Force the item to drop from the mob's hands. If `sever` is TRUE, items will be severed from item arms
get_hero	Pick one human trying to cover the object
material_on_drop	Called when an item is dropped for mat effects
material_on_pickup	Called when an item is picked up for mat effects
place_to_turf_by_grid	Move item to turf, and snap its pixel offsets to a grid of the input size.
setTwoHanded	This is the safe way of changing 2-handed-ness at runtime. Use this please.
should_place_on	Override to implement custom logic for determining whether the item should be placed onto a target object
try_specific_equip	attempt unique functionality when item is held in hand and and using the equip hotkey

Var Details

var
amount
–

This is for things which are stackable! It means that there are [amount] things here, which could be discretely split or stacked! if you use this to represent something other than a literal stack of items I will break your kneecaps

var
attack_verbs
–

Verb used when you attack someone with this, as in [attacker] [attack_verbs] [victim]. Can be a list or single entry

var
brew_result
–

What reagent will it make if it's brewable?

var
burn_output
–

How hot does the item burn once on fire

var
burn_point
–

Ambient temperature at which the item may spontaneously ignite

var
burn_possible
–

Is this item burnable

var
burn_remains
–

What is left when it's burnt up

var
burning
–

Are we currently burning

var
burning_last_process
–

Keep track of last burning state

var
equip_sfx
–

Sound for when you equip this from an inventory (ie not a turf)

var
firesource
–

Is this a valid source for lighting fires

var
hat_offset_x
–

Used for the hattable component

var
hat_offset_y
–

Used for the hattable component

var
health
–

How long an item takes to burn (or be consumed by other means), based on the weight class if no value is set

var
inhand_color
–

set to a colour to make the inhand image be that colour. if the item is coloured though that takes priority over this variable

var
item_state
–

The in-hand icon state

var
leaves_slash_wound
–

when attacking, this item can leave a slash wound

var
master
– /obj/item

This var fucking sucks. It's used for prox sensors and other stuff that when triggered trigger an item they're attached to. Why is this on /item i am so sad

var
mimic_chance
–

Chance for this item to be replaced by a mimic disguised as it - note, setting this high here is a really bad idea

var
pickup_sfx
–

Sound for when you pick this up from anywhere. If null, we auto-pick from a list based on w_class

var
stored
– /datum/storage

storage datum holding it

var
wear_state
–

icon state used for worn sprites, icon_state used otherwise

Proc Details

proc
AfterAttack
(/atom/target, /mob/user, reach, params)

Call this proc inplace of afterattack(...)

proc
AttackSelf
(/mob/user)

Call this proc inplace of attack_self(...)

proc
UpdateStackAppearance
()

Don't override this, override _update_stack_appearance() instead.

proc
_update_stack_appearance
()

Call UpdateStackAppearance() instead.

proc
afterattack
(/atom/target, /mob/user, reach, params)

DO NOT CALL THIS PROC - Call AfterAttack(...) Instead!

Only override this proc!

proc
assembly_get_admin_log_message
(/mob/user, /obj/item/assembly/parent_assembly)

This will be called when the item is build into a /obj/item/assembly on get_admin_log_message(). Use this for additional information for logging.

proc
assembly_get_part_help_message
(dist, /mob/shown_user, /obj/item/assembly/parent_assembly)

This will be called when the item is build into a /obj/item/assembly on get_help_message()

proc
attack_self
(/mob/user)

DO NOT CALL THIS PROC - Call AttackSelf(...) Instead!

Only override this proc!

proc
enchant
(incr, setTo)

Enchants an item (minor armor boost for clothing, otherwise increases melee damage)

incr - value to enchant by setTo - when true, sets enchantment to incr, otherwise will add incr to existing enchantment (positive or negative)

proc
force_drop
(/mob/possible_mob_holder, sever)

Force the item to drop from the mob's hands. If sever is TRUE, items will be severed from item arms

proc
get_hero
()

Pick one human trying to cover the object

proc
material_on_drop
(/mob/user)

Called when an item is dropped for mat effects

proc
material_on_pickup
(/mob/user)

Called when an item is picked up for mat effects

proc
place_to_turf_by_grid
(/mob/user, params, /turf/target, grid, centered, offsetx, offsety)

Move item to turf, and snap its pixel offsets to a grid of the input size.

proc
setTwoHanded
(twohanded)

This is the safe way of changing 2-handed-ness at runtime. Use this please.

proc
should_place_on
(/obj/target, params)

Override to implement custom logic for determining whether the item should be placed onto a target object

proc
try_specific_equip
(/mob/user)

attempt unique functionality when item is held in hand and and using the equip hotkey

item /obj/item

Vars

Procs

Var Details

var amount –

var attack_verbs –

var brew_result –

var burn_output –

var burn_point –

var burn_possible –

var burn_remains –

var burning –

var burning_last_process –

var equip_sfx –

var firesource –

var hat_offset_x –

var hat_offset_y –

var health –

var inhand_color –

var item_state –

var leaves_slash_wound –

var master – /obj/item

var mimic_chance –

var pickup_sfx –

var stored – /datum/storage

var wear_state –

Proc Details

proc AfterAttack(/atom/target, /mob/user, reach, params)

proc AttackSelf(/mob/user)

proc UpdateStackAppearance()

proc _update_stack_appearance()

proc afterattack(/atom/target, /mob/user, reach, params)

proc assembly_get_admin_log_message(/mob/user, /obj/item/assembly/parent_assembly)

proc assembly_get_part_help_message(dist, /mob/shown_user, /obj/item/assembly/parent_assembly)

proc attack_self(/mob/user)

proc enchant(incr, setTo)

proc force_drop(/mob/possible_mob_holder, sever)

proc get_hero()

proc material_on_drop(/mob/user)

proc material_on_pickup(/mob/user)

proc place_to_turf_by_grid(/mob/user, params, /turf/target, grid, centered, offsetx, offsety)

proc setTwoHanded(twohanded)

proc should_place_on(/obj/target, params)

proc try_specific_equip(/mob/user)

item
/obj/item

var
amount
–

var
attack_verbs
–

var
brew_result
–

var
burn_output
–

var
burn_point
–

var
burn_possible
–

var
burn_remains
–

var
burning
–

var
burning_last_process
–

var
equip_sfx
–

var
firesource
–

var
hat_offset_x
–

var
hat_offset_y
–

var
health
–

var
inhand_color
–

var
item_state
–

var
leaves_slash_wound
–

var
master
– /obj/item

var
mimic_chance
–

var
pickup_sfx
–

var
stored
– /datum/storage

var
wear_state
–

proc
AfterAttack
(/atom/target, /mob/user, reach, params)

proc
AttackSelf
(/mob/user)

proc
UpdateStackAppearance
()

proc
_update_stack_appearance
()

proc
afterattack
(/atom/target, /mob/user, reach, params)

proc
assembly_get_admin_log_message
(/mob/user, /obj/item/assembly/parent_assembly)

proc
assembly_get_part_help_message
(dist, /mob/shown_user, /obj/item/assembly/parent_assembly)

proc
attack_self
(/mob/user)

proc
enchant
(incr, setTo)

proc
force_drop
(/mob/possible_mob_holder, sever)

proc
get_hero
()

proc
material_on_drop
(/mob/user)

proc
material_on_pickup
(/mob/user)

proc
place_to_turf_by_grid
(/mob/user, params, /turf/target, grid, centered, offsetx, offsety)

proc
setTwoHanded
(twohanded)

proc
should_place_on
(/obj/target, params)

proc
try_specific_equip
(/mob/user)