Class HandsComponent

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

Fields

| Improve this Doc View Source

ActiveHand

The currently active hand.

Declaration
public Hand ActiveHand
Field Value
Type Description
Hand
| Improve this Doc View Source

Hands

Declaration
public Dictionary<string, Hand> Hands
Field Value
Type Description
Dictionary<System.String, Hand>
| Improve this Doc View Source

RevealedLayers

Data about the current sprite layers that the hand is contributing to the owner entity. Used for sprite in-hands. Used by the client.

Declaration
public readonly Dictionary<HandLocation, HashSet<string>> RevealedLayers
Field Value
Type Description
Dictionary<HandLocation, HashSet<System.String>>
| Improve this Doc View Source

ShowInHands

Whether or not to add in-hand sprites for held items. Some entities (e.g., drones) don't want these. Used by the client.

Declaration
public bool ShowInHands
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

SortedHands

List of hand-names. These are keys for Hands. The order of this list determines the order in which hands are iterated over.

Declaration
public List<string> SortedHands
Field Value
Type Description
List<System.String>

Properties

| Improve this Doc View Source

ActiveHandEntity

The item currently held in the active hand.

Declaration
public EntityUid? ActiveHandEntity { get; }
Property Value
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

Count

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

ThrowForceMultiplier

The amount of throw impulse per distance the player is from the throw target.

Declaration
public float ThrowForceMultiplier { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ThrowRange

Distance after which longer throw targets stop increasing throw impulse.

Declaration
public float ThrowRange { get; set; }
Property Value
Type Description
System.Single

Extension Methods