item

Vars
belt_icon_state	Icon state for the belt overlay, if null the normal icon_state will be used.
cryo_preserve	Should the cryo console preserve this item
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
equip_sound	Sound used when equipping the item into a valid slot
fryable	Is this item fryable without a syndicate frying pan
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.
item_state	icon state name for inhand overlays
lefthand_file	Icon file for left hand inhand overlays
mob_throw_hit_sound	Used when yate into a mob
outline_filter	item hover FX
pickup_sound	Sound uses when picking the item up (into your hands)
range_cooldown_mod	multiplier to increase/decrease effects of range on attack cooldown, 0 to ignore range
righthand_file	Icon file for right inhand overlays
sharpness	All items with sharpness of SHARP_EDGED or higher will automatically get the butchering component.
sound_vary	Do the drop and pickup sounds vary?
syndicate	Does this item have syndicate only functionality via hud buttons? Needs to be in this scope to encompass all Chameleon items - Hopek
undyeable	Whether the item is unaffected by standard dying.
weapon_stats	A list of statistics used when a weapon hits someone, swing speed = multiplier for melee attack cd, encumbrance = slowdown, encumbrance_time = slowdown length, reach = reach, embed chance = chance for applicable weapons to embed on hit, damage_low/high = range of damage the weapon takes on hitting a mob
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.
Procs
Adjacent	Yog code for spacepods I guess???
GetAccess	Get the accesses on the item
GetID	Get the ID in the object, used for PDAs
GetJobName	Gets the name of a job from the ID
add_item_action	Adds an item action to our list of item actions. Item actions are actions linked to our item, that are granted to mobs who equip us. This also ensures that the actions are properly tracked in the actions list and removed if they're deleted. Can be be passed a typepath of an action or an instance of an action.
afterattack_secondary	Called at the end of the attack chain if the user right-clicked.
attack	Called from [/mob/living/proc/attackby]
attack_secondary	The equivalent of /obj/item/proc/attack but for alternate attacks, AKA right clicking
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_equip	Parent proc - triggers when an item/module is equipped from a cyborg.
cyborg_unequip	Parent proc - triggers when an item/module is unequipped from a cyborg.
get_temperature	Returns the temperature of src. If you want to know if an item is hot use this proc.
give_item_action	Gives one of our item actions to a mob, when equipped to a certain slot
item_action_slot_check	Sometimes we only want to grant the item's action if it's equipped in a specific slot.
mark_target	Used to mark a target for the demo system during a melee attack chain, call this before return
on_action_deleted	Called when an action associated with our item is deleted
pre_attack_secondary	Called on the item before it hits something, when right clicking.
remove_item_action	Removes an instance of an action from our list of item actions.
update_greyscale	Checks if this atom uses the GAGS system and if so updates the worn and inhand icons
update_item_action_buttons	Updates all action buttons associated with this item

Var Details

var
belt_icon_state
–

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

var
cryo_preserve
–

Should the cryo console preserve this item

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

Sound used when equipping the item into a valid slot

var
fryable
–

Is this item fryable without a syndicate frying pan

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

icon state name for inhand overlays

var
lefthand_file
–

Icon file for left hand inhand overlays

var
mob_throw_hit_sound
–

Used when yate into a mob

var
outline_filter
–

item hover FX

var
pickup_sound
–

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

var
range_cooldown_mod
–

multiplier to increase/decrease effects of range on attack cooldown, 0 to ignore range

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

Do the drop and pickup sounds vary?

var
syndicate
–

Does this item have syndicate only functionality via hud buttons? Needs to be in this scope to encompass all Chameleon items - Hopek

var
undyeable
–

Whether the item is unaffected by standard dying.

var
weapon_stats
– /list

A list of statistics used when a weapon hits someone, swing speed = multiplier for melee attack cd, encumbrance = slowdown, encumbrance_time = slowdown length, reach = reach, embed chance = chance for applicable weapons to embed on hit, damage_low/high = range of damage the weapon takes on hitting a mob

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.

Proc Details

Adjacent
(/atom/neighbor, recurse)

Yog code for spacepods I guess???

proc
GetAccess
()

Get the accesses on the item

proc
GetID
()

Get the ID in the object, used for PDAs

proc
GetJobName
()

Gets the name of a job from the ID

proc
add_item_action
(action_or_action_type)

Adds an item action to our list of item actions. Item actions are actions linked to our item, that are granted to mobs who equip us. This also ensures that the actions are properly tracked in the actions list and removed if they're deleted. Can be be passed a typepath of an action or an instance of an action.

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

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

proc
cyborg_unequip
(/mob/user)

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

proc
get_temperature
()

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

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

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

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
mark_target
(/atom/target)

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

proc
on_action_deleted
(/datum/source)

Called when an action associated with our item is deleted

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
remove_item_action
(/datum/action/action)

Removes an instance of an action from our list of item actions.

↑
update_greyscale
()

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

proc
update_item_action_buttons
(update_flags, force)

Updates all action buttons associated with this item

Arguments:

update_flags - Which flags of the action should we update
force - Force buttons update even if the given button icon state has not changed

item /obj/item

Vars

Procs

Var Details

var belt_icon_state –

var cryo_preserve –

var drop_sound –

var dye_color –

var dying_key –

var equip_sound –

var fryable –

var greyscale_config_belt –

var greyscale_config_inhand_left –

var greyscale_config_inhand_right –

var greyscale_config_worn –

var item_state –

var lefthand_file –

var mob_throw_hit_sound –

var outline_filter –

var pickup_sound –

var range_cooldown_mod –

var righthand_file –

var sharpness –

var sound_vary –

var syndicate –

var undyeable –

var weapon_stats – /list

var worn_icon – /icon

var worn_icon_state –

Proc Details

Adjacent(/atom/neighbor, recurse)

proc GetAccess()

proc GetID()

proc GetJobName()

proc add_item_action(action_or_action_type)

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

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

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

proc attack_self_secondary(/mob/user, modifiers)

proc cyborg_equip(/mob/user)

proc cyborg_unequip(/mob/user)

proc get_temperature()

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

proc item_action_slot_check(slot, /mob/user)

proc mark_target(/atom/target)

proc on_action_deleted(/datum/source)

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

proc remove_item_action(/datum/action/action)

↑update_greyscale()

proc update_item_action_buttons(update_flags, force)

item
/obj/item

var
belt_icon_state
–

var
cryo_preserve
–

var
drop_sound
–

var
dye_color
–

var
dying_key
–

var
equip_sound
–

var
fryable
–

var
greyscale_config_belt
–

var
greyscale_config_inhand_left
–

var
greyscale_config_inhand_right
–

var
greyscale_config_worn
–

var
item_state
–

var
lefthand_file
–

var
mob_throw_hit_sound
–

var
outline_filter
–

var
pickup_sound
–

var
range_cooldown_mod
–

var
righthand_file
–

var
sharpness
–

var
sound_vary
–

var
syndicate
–

var
undyeable
–

var
weapon_stats
– /list

var
worn_icon
– /icon

var
worn_icon_state
–

Adjacent
(/atom/neighbor, recurse)

proc
GetAccess
()

proc
GetID
()

proc
GetJobName
()

proc
add_item_action
(action_or_action_type)

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

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

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

proc
attack_self_secondary
(/mob/user, modifiers)

proc
cyborg_equip
(/mob/user)

proc
cyborg_unequip
(/mob/user)

proc
get_temperature
()

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

proc
item_action_slot_check
(slot, /mob/user)

proc
mark_target
(/atom/target)

proc
on_action_deleted
(/datum/source)

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

proc
remove_item_action
(/datum/action/action)

↑
update_greyscale
()

proc
update_item_action_buttons
(update_flags, force)