toggle_attached_clothing

Component which allows clothing to deploy a different kind of clothing onto you. The simplest example is hooded suits deploying hoods onto your head.

Vars
action_name	Name of toggle action
currently_deployed	Current state of our deployable equipment
deployable	Instance of the item we're creating
deployable_type	Typepath of what we're creating
destroy_on_removal	If true, we delete our deployable on toggle rather than putting it in nullspace
down_overlay_state_suffix	Icon state for overlay to display over the parent item while deployable item is not deployed
equipped_slot	Which slot this item equips into
on_created	Optional callback triggered when we create our deployable equipment
on_deployed	Optional callback triggered when we have deployed our equipment
on_removed	Optional callback triggered before we hide our equipment, before as we may delete it afterwards
parent_icon_state_suffix	What should be added to the end of the parent icon state when equipment is deployed? Set to "" for no change
pre_creation_check	Optional callback triggered before deploying, return TRUE to continue or FALSE to cancel
toggle_action	Action used to toggle deployment
undeployed_overlay	Overlay to display over the parent item while deployable item is not deployed
Procs
create_deployable	Create our gear, returns true if we actually made anything
on_action_slot_checked	Called when action attempts to check what slot the item is worn in
on_checked_overlays	Apply an overlay while the item is not deployed
on_deployed_destroyed	Undeploy gear if it is deleted
on_deployed_dropped	Undeploy gear if you drop it
on_deployed_equipped	Undeploy gear if it moves slots somehow
on_parent_equipped	Undeploy gear if it moves slots somehow
on_parent_equipped_outfit	Display deployed if worn in an outfit
on_toggle_pressed	Toggle deployable when the UI button is clicked
remove_deployable	Removes our deployed equipment from the wearer
toggle_deployable	Deploys gear if it is hidden, hides it if it is deployed
unequip_deployable	Removes an equipped deployable atom upon its retraction or destruction

Var Details

var
action_name
–

Name of toggle action

var
currently_deployed
–

Current state of our deployable equipment

var
deployable
– /obj/item

Instance of the item we're creating

var
deployable_type
–

Typepath of what we're creating

var
destroy_on_removal
–

If true, we delete our deployable on toggle rather than putting it in nullspace

var
down_overlay_state_suffix
–

Icon state for overlay to display over the parent item while deployable item is not deployed

var
equipped_slot
–

Which slot this item equips into

var
on_created
– /datum/callback

Optional callback triggered when we create our deployable equipment

var
on_deployed
– /datum/callback

Optional callback triggered when we have deployed our equipment

var
on_removed
– /datum/callback

Optional callback triggered before we hide our equipment, before as we may delete it afterwards

var
parent_icon_state_suffix
–

What should be added to the end of the parent icon state when equipment is deployed? Set to "" for no change

var
pre_creation_check
– /datum/callback

Optional callback triggered before deploying, return TRUE to continue or FALSE to cancel

var
toggle_action
– /datum/action/item_action

Action used to toggle deployment

var
undeployed_overlay
– /mutable_appearance

Overlay to display over the parent item while deployable item is not deployed

Proc Details

proc
create_deployable
()

Create our gear, returns true if we actually made anything

proc
on_action_slot_checked
(/obj/item/clothing/source, /mob/user, /datum/action, slot)

Called when action attempts to check what slot the item is worn in

proc
on_checked_overlays
(/obj/item/source, /list/overlays, /mutable_appearance/standing, isinhands, icon_file)

Apply an overlay while the item is not deployed

proc
on_deployed_destroyed
()

Undeploy gear if it is deleted

proc
on_deployed_dropped
()

Undeploy gear if you drop it

proc
on_deployed_equipped
(/obj/item/clothing/source, /mob/equipper, slot)

Undeploy gear if it moves slots somehow

proc
on_parent_equipped
(/obj/item/clothing/source, /mob/equipper, slot)

Undeploy gear if it moves slots somehow

proc
on_parent_equipped_outfit
(/obj/item/clothing/source, /mob/equipper, visuals_only, slot)

Display deployed if worn in an outfit

proc
on_toggle_pressed
(/obj/item/source, /mob/user, /datum/action)

Toggle deployable when the UI button is clicked

proc
remove_deployable
()

Removes our deployed equipment from the wearer

proc
toggle_deployable
()

Deploys gear if it is hidden, hides it if it is deployed

proc
unequip_deployable
()

Removes an equipped deployable atom upon its retraction or destruction

toggle_attached_clothing /datum/component/toggle_attached_clothing

Vars

Procs

Var Details

var action_name –

var currently_deployed –

var deployable – /obj/item

var deployable_type –

var destroy_on_removal –

var down_overlay_state_suffix –

var equipped_slot –

var on_created – /datum/callback

var on_deployed – /datum/callback

var on_removed – /datum/callback

var parent_icon_state_suffix –

var pre_creation_check – /datum/callback

var toggle_action – /datum/action/item_action

var undeployed_overlay – /mutable_appearance