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
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.
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
group	Title of a group that this item will be bundled under Defaults to parent category's title if unset
item_path	The actual item path of the loadout item.
job_greyscale_palettes	A list of greyscale colors that are used for items that have greyscale support, but don't allow full customization. This is an assoc list of /datum/job_department -> colors, or /datum/job -> colors, allowing for preset colors based on player chosen job. Jobs are prioritized over departments. Note: You don't need to set a color for every job or department!
mechanical_item	Is the loadout item a mechanical item? If so, it will be blocked by 'allow_mechanical_loadout_items' under some circumstances
name	Displayed name of the loadout item. Defaults to the item's name if unset.
nova_stars_only	Whether the item is restricted to Nova stars.
required_holiday	If set, this item can only be selected during the holiday specified.
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
species_blacklist	If set, is a list of species which can't get the loadout item
species_whitelist	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
Procs
can_be_applied_to	Called before a loadout item is given to a mob, making sure that they're eligible to receive it, based on all of that item's restrictions, if any.
default_one_color_job_palette	Default job gags colors for one color gags items
get_item_information	Returns a list of information to display about this item in the loadout UI. Icon -> tooltip displayed when its hovered over
get_job_color	When passed an outfit, attempts to select a job-appropriate color from job_greyscale_palettes
get_reskin_options	Returns a list of options this item can be reskinned into.
is_disabled	Checks if this item is disabled and cannot be selected or granted
is_equippable	Checks if this item is disabled or unequippable for the given item details.
is_greyscale_item	Checks if the item is capable of being recolored / is a GAGS item.
message_client	Tells the client we couldn't equip their item
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

↑
abstract_type

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

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
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
group

Title of a group that this item will be bundled under Defaults to parent category's title if unset

var
item_path
– /obj/item

The actual item path of the loadout item.

var
job_greyscale_palettes
– /list

A list of greyscale colors that are used for items that have greyscale support, but don't allow full customization. This is an assoc list of /datum/job_department -> colors, or /datum/job -> colors, allowing for preset colors based on player chosen job. Jobs are prioritized over departments. Note: You don't need to set a color for every job or department!

var
mechanical_item

Is the loadout item a mechanical item? If so, it will be blocked by 'allow_mechanical_loadout_items' under some circumstances

var
name

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

var
nova_stars_only

Whether the item is restricted to Nova stars.

var
required_holiday

If set, this item can only be selected during the holiday specified.

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
species_blacklist
– /list

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

var
species_whitelist
– /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

Proc Details

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

Called before a loadout item is given to a mob, making sure that they're eligible 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
default_one_color_job_palette
()

Default job gags colors for one color gags items

proc
get_item_information
() as /list

Returns a list of information to display about this item in the loadout UI. Icon -> tooltip displayed when its hovered over

proc
get_job_color
(/datum/outfit/base_outfit)

When passed an outfit, attempts to select a job-appropriate color from job_greyscale_palettes

proc
get_reskin_options
() as /list

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

proc
is_disabled
()

Checks if this item is disabled and cannot be selected or granted

proc
is_equippable
(/mob/living/carbon/human/equipper, /list/item_details)

Checks if this item is disabled or unequippable for the given item details.

proc
is_greyscale_item
()

Checks if the item is capable of being recolored / is a GAGS item.

proc
message_client
(client, target, msg)

Tells the client we couldn't equip their item

proc
on_equip_item
(/obj/item/equipped_item, /list/item_details, /mob/living/carbon/human/equipper, /datum/outfit/outfit, 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
item_details - the details of the item in the loadout preferences, such as greyscale, name, reskin, etc
equipper - the mob we're equipping this item onto
outfit - the rest of the outfit being equipped, may be null
visuals_only - whether or not this is only concerned with visual things (not backpack, not renaming, etc)

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

↑abstract_type

var blacklisted_roles – /list

var cached_reskin_options – /final/list

var category – /final/datum/loadout_category

var ckeywhitelist – /list

var donator_only

var erp_box

var erp_item

var group

var item_path – /obj/item

var job_greyscale_palettes – /list

var mechanical_item

var name

var nova_stars_only

var required_holiday

var required_season

var restricted_roles – /list

var species_blacklist – /list

var species_whitelist – /list

var ui_icon

var ui_icon_state