Class StackComponent

Inheritance
System.Object
StackComponent
Namespace: Content.Shared.Stacks
Assembly: Content.Shared.dll
Syntax
public sealed class StackComponent : Component

Fields

| Improve this Doc View Source

BaseLayer

Default IconLayer stack.

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

IsComposite

Determines if the visualizer uses composite or non-composite layers for icons. Defaults to false.

  • false: they are opaque and mutually exclusive (e.g. sprites in a cable coil). Default value
  • true: they are transparent and thus layered one over another in ascending order first
Declaration
public bool IsComposite
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

LayerStates

Sprite layers used in stack visualizer. Sprites first in layer correspond to lower stack states e.g. 

_spriteLayers[0]
is lower stack level than 
_spriteLayers[1]
.

Declaration
public List<string> LayerStates
Field Value
Type Description
List<System.String>
| Improve this Doc View Source

Lingering

Lingering stacks will remain present even when there are no items. Instead, they will become transparent.

Declaration
public bool Lingering
Field Value
Type Description
System.Boolean

Properties

| Improve this Doc View Source

Count

Current stack count. Do NOT set this directly, use the SetCount(EntityUid, Int32, StackComponent) method instead.

Declaration
public int Count { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

MaxCountOverride

Max amount of things that can be in the stack. Overrides the max defined on the stack prototype.

Declaration
public int? MaxCountOverride { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

StackTypeId

Declaration
public string StackTypeId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ThrowIndividually

Declaration
public bool ThrowIndividually { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

UiUpdateNeeded

Declaration
public bool UiUpdateNeeded { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Unlimited

Set to true to not reduce the count when used. Note that Count still limits the amount that can be used at any one time.

Declaration
public bool Unlimited { get; set; }
Property Value
Type Description
System.Boolean