loadout_item

Singleton that holds all the information about each loadout items, and how to equip them.

Vars
abstract_type	The abstract parent of this loadout item, to determine which items to not instantiate
additional_displayed_text	Lazylist of additional "information" text to display about this item.
blacklisted_roles	If set, is a list of job names of which can't get the loadout item
cached_reskin_options	Reskin options of this item if it can be reskinned.
can_be_greyscale	Whether this item has greyscale support. Only works if the item is compatible with the GAGS system of coloring. Set automatically to TRUE for all items that have the flag IS_PLAYER_COLORABLE_1. If you really want it to not be colorable set this to DONT_GREYSCALE
can_be_named	Whether this item can be renamed. I recommend you apply this sparingly becuase it certainly can go wrong (or get reset / overridden easily)
can_be_reskinned	Whether this item can be reskinned. Only works if the item has a "unique reskin" list set.
category	The category of the loadout item. Set automatically in New
ckeywhitelist	If set, it's a list containing ckeys which only can get the item
donator_only	Whether the item is restricted to supporters
erp_box	If the item goes into the special erp box
erp_item	If the item won't appear when the ERP config is disabled
item_path	The actual item path of the loadout item.
name	Displayed name of the loadout item. Defaults to the item's name if unset.
required_season	Whether the item requires a specific season in order to be available
restricted_roles	If set, is a list of job names of which can get the loadout item
restricted_species	If set, is a list of species which can get the loadout item
ui_icon	Icon file (DMI) for the UI to use for preview icons. Set automatically if null
ui_icon_state	Icon state for the UI to use for preview icons. Set automatically if null
veteran_only	Whether the item is restricted to veterans.
Procs
can_be_applied_to	Called before a loadout item is given to a mob, making sure that they're elligible to receive it, based on all of that item's restrictions, if any.
get_reskin_options	Returns a list of options this item can be reskinned into.
on_equip_item	Called When the item is equipped on [equipper].
set_description	Sets the description of the item.
set_item_color	Opens up the GAGS editing menu.
set_name	Sets the name of the item.
set_skin	Used for reskinning an item to an alt skin.
set_slot_greyscale	Callback for GAGS menu to set this item's color.

Var Details

var
abstract_type
–

The abstract parent of this loadout item, to determine which items to not instantiate

var
additional_displayed_text
– /list

Lazylist of additional "information" text to display about this item.

var
blacklisted_roles
– /list

If set, is a list of job names of which can't get the loadout item

var
cached_reskin_options
– /final/list

Reskin options of this item if it can be reskinned.

var
can_be_greyscale
–

Whether this item has greyscale support. Only works if the item is compatible with the GAGS system of coloring. Set automatically to TRUE for all items that have the flag IS_PLAYER_COLORABLE_1. If you really want it to not be colorable set this to DONT_GREYSCALE

var
can_be_named
–

Whether this item can be renamed. I recommend you apply this sparingly becuase it certainly can go wrong (or get reset / overridden easily)

var
can_be_reskinned
–

Whether this item can be reskinned. Only works if the item has a "unique reskin" list set.

var
category
– /final/datum/loadout_category

The category of the loadout item. Set automatically in New

var
ckeywhitelist
– /list

If set, it's a list containing ckeys which only can get the item

var
donator_only
–

Whether the item is restricted to supporters

var
erp_box
–

If the item goes into the special erp box

var
erp_item
–

If the item won't appear when the ERP config is disabled

var
item_path
– /obj/item

The actual item path of the loadout item.

var
name
–

Displayed name of the loadout item. Defaults to the item's name if unset.

var
required_season
–

Whether the item requires a specific season in order to be available

var
restricted_roles
– /list

If set, is a list of job names of which can get the loadout item

var
restricted_species
– /list

If set, is a list of species which can get the loadout item

var
ui_icon
–

Icon file (DMI) for the UI to use for preview icons. Set automatically if null

var
ui_icon_state
–

Icon state for the UI to use for preview icons. Set automatically if null

var
veteran_only
–

Whether the item is restricted to veterans.

Proc Details

proc
can_be_applied_to
(/mob/living/target, /datum/preferences/preference_source, /datum/job/equipping_job, silent)

Called before a loadout item is given to a mob, making sure that they're elligible to receive it, based on all of that item's restrictions, if any.

Returns TRUE if target is allowed to receive this item, FALSE if not.

proc
get_reskin_options
()

Returns a list of options this item can be reskinned into.

proc
on_equip_item
(/obj/item/equipped_item, /datum/preferences/preference_source, /list/preference_list, /mob/living/carbon/human/equipper, visuals_only)

Called When the item is equipped on [equipper].

At this point the item is in the mob's contents

Arguments:

preference_source - the datum/preferences our loadout item originated from - cannot be null
equipper - the mob we're equipping this item onto
visuals_only - whether or not this is only concerned with visual things (not backpack, not renaming, etc)
preference_list - what the raw loadout list looks like in the preferences

Return a bitflag of slot flags to update

proc
set_description
(/datum/preference_middleware/loadout/manager, /mob/user)

Sets the description of the item.

proc
set_item_color
(/datum/preference_middleware/loadout/manager, /mob/user)

Opens up the GAGS editing menu.

proc
set_name
(/datum/preference_middleware/loadout/manager, /mob/user)

Sets the name of the item.

proc
set_skin
(/datum/preference_middleware/loadout/manager, /mob/user, params)

Used for reskinning an item to an alt skin.

proc
set_slot_greyscale
(/datum/preference_middleware/loadout/manager, /datum/greyscale_modify_menu/open_menu)

Callback for GAGS menu to set this item's color.

Loadout item datum /datum/loadout_item

Vars

Procs

Var Details

var abstract_type –

var additional_displayed_text – /list

var blacklisted_roles – /list

var cached_reskin_options – /final/list

var can_be_greyscale –

var can_be_named –

var can_be_reskinned –

var category – /final/datum/loadout_category

var ckeywhitelist – /list

var donator_only –

var erp_box –

var erp_item –

var item_path – /obj/item

var name –

var required_season –

var restricted_roles – /list

var restricted_species – /list

var ui_icon –

var ui_icon_state –

var veteran_only –