Class ToggleableClothingComponent

This component gives an item an action that will equip or un-equip some clothing. Intended for use with hardsuits and hardsuit helmets.

Inheritance
System.Object
ToggleableClothingComponent
Namespace: Content.Shared.Clothing.Components
Assembly: Content.Shared.dll
Syntax
public sealed class ToggleableClothingComponent : Component

Fields

| Improve this Doc View Source

Action

Action used to toggle the clothing on or off.

Declaration
public string Action
Field Value
Type Description
System.String
| Improve this Doc View Source

ActionEntity

Declaration
public EntityUid? ActionEntity
Field Value
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

ClothingPrototype

Default clothing entity prototype to spawn into the clothing container.

Declaration
public string ClothingPrototype
Field Value
Type Description
System.String
| Improve this Doc View Source

ClothingUid

The Id of the piece of clothing that belongs to this component. Required for map-saving if the clothing is currently not inside of the container.

Declaration
public EntityUid? ClothingUid
Field Value
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

Container

Declaration
public ContainerSlot Container
Field Value
Type Description
Robust.Shared.Containers.ContainerSlot
| Improve this Doc View Source

ContainerId

The container that the clothing is stored in when not equipped.

Declaration
public string ContainerId
Field Value
Type Description
System.String
| Improve this Doc View Source

DefaultClothingContainerId

Declaration
public const string DefaultClothingContainerId = null
Field Value
Type Description
System.String
| Improve this Doc View Source

RequiredFlags

The inventory slot flags required for this component to function.

Declaration
public SlotFlags RequiredFlags
Field Value
Type Description
SlotFlags
| Improve this Doc View Source

Slot

The inventory slot that the clothing is equipped to.

Declaration
public string Slot
Field Value
Type Description
System.String
| Improve this Doc View Source

StripDelay

Time it takes for this clothing to be toggled via the stripping menu verbs. Null prevents the verb from even showing up.

Declaration
public TimeSpan? StripDelay
Field Value
Type Description
System.Nullable<TimeSpan>
| Improve this Doc View Source

VerbText

Text shown in the toggle-clothing verb. Defaults to using the name of the ActionEntity action.

Declaration
public string? VerbText
Field Value
Type Description
System.Nullable<System.String>