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
animated	Is this item animated?
category	The category of the loadout item. Set automatically in New
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!
loadout_flags	Loadout flags, see LOADOUT_FLAG_* defines
name	Displayed name of the loadout item. Defaults to the item's name if unset.
required_holiday	If set, this item can only be selected during the holiday specified.
reskin_datum	Base typepath to what reskin datum this item can use to reskin into Doesn't verify that the item_path actually has these reskins
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
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.
get_ui_buttons	Returns a list of buttons that are shown in the loadout UI for customizing this item.
handle_loadout_action	Takes in an action from a loadout manager and applies it
insert_path_into_outfit	Place our [item_path] into the passed [outfit].
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.
on_equip_item	Called When the item is equipped on [equipper].
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
animated

Is this item animated?

var
category
– /final/datum/loadout_category

The category of the loadout item. Set automatically in New

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
loadout_flags

Loadout flags, see LOADOUT_FLAG_* defines

var
name

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

var
required_holiday

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

var
reskin_datum

Base typepath to what reskin datum this item can use to reskin into Doesn't verify that the item_path actually has these reskins

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
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
get_ui_buttons
() as /list

Returns a list of buttons that are shown in the loadout UI for customizing this item.

Buttons contain

'L'abel: The text displayed beside the button
act_key: The key that is sent to the loadout manager when the button is clicked, for use in handle_loadout_action
button_icon: The FontAwesome icon to display on the button
active_key: In the loadout UI, this key is checked in the user's loadout list for this item to determine if the button is 'active' (green) or not (blue).
active_text: Optional, if provided, the button appears to be a checkbox and this text is shown when 'active'
inactive_text: Optional, if provided, the button appears to be a checkbox and this text is shown when not 'active'

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

Takes in an action from a loadout manager and applies it

Useful for subtypes of loadout items with unique actions

Return TRUE to force an update to the UI / character preview

proc
insert_path_into_outfit
(/datum/outfit/outfit, /mob/living/carbon/human/equipper, visuals_only)

Place our [item_path] into the passed [outfit].

By default, just adds the item into the outfit's backpack contents, if non-visual.

Arguments:

outfit - The outfit we're equipping our items into.
equipper - If we're equipping out outfit onto a mob at the time, this is the mob it is equipped on. Can be null.
visual - If TRUE, then our outfit is only for visual use (for example, a preview).

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
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_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 animated

var category – /final/datum/loadout_category

var group

var item_path – /obj/item

var job_greyscale_palettes – /list

var loadout_flags

var name

var required_holiday

var reskin_datum

var ui_icon

var ui_icon_state

Proc Details

proc default_one_color_job_palette()

proc get_item_information() as /list

proc get_job_color(/datum/outfit/base_outfit)

proc get_reskin_options() as /list

proc get_ui_buttons() as /list

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

proc insert_path_into_outfit(/datum/outfit/outfit, /mob/living/carbon/human/equipper, visuals_only)

proc is_disabled()

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

proc is_greyscale_item()

proc on_equip_item(/obj/item/equipped_item, /list/item_details, /mob/living/carbon/human/equipper, /datum/outfit/outfit, visuals_only)

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

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

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

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