Class HandsSystem

Inheritance
System.Object
SharedHandsSystem
HandsSystem
Implements
EntitySystem
Namespace: Content.Client.Hands.Systems
Assembly: Content.Client.dll
Syntax
public sealed class HandsSystem : SharedHandsSystem, EntitySystem

Methods

| Improve this Doc View Source

AddHand(EntityUid, String, HandLocation, HandsComponent)

Declaration
public override void AddHand(EntityUid uid, string handName, HandLocation handLocation, HandsComponent handsComp = null)
Parameters
Type Name Description
EntityUid uid
System.String handName
HandLocation handLocation
HandsComponent handsComp
| Improve this Doc View Source

DoDrop(EntityUid, Hand, Boolean, HandsComponent)

Declaration
public override void DoDrop(EntityUid uid, Hand hand, bool doDropInteraction = true, HandsComponent hands = null)
Parameters
Type Name Description
EntityUid uid
Hand hand
System.Boolean doDropInteraction
HandsComponent hands
| Improve this Doc View Source

GetActiveHandEntity()

Declaration
public EntityUid? GetActiveHandEntity()
Returns
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

HandleEntityInserted(EntityUid, HandsComponent, EntInsertedIntoContainerMessage)

Declaration
protected override void HandleEntityInserted(EntityUid uid, HandsComponent hands, EntInsertedIntoContainerMessage args)
Parameters
Type Name Description
EntityUid uid
HandsComponent hands
Robust.Shared.Containers.EntInsertedIntoContainerMessage args
| Improve this Doc View Source

HandleEntityRemoved(EntityUid, HandsComponent, EntRemovedFromContainerMessage)

Declaration
protected override void HandleEntityRemoved(EntityUid uid, HandsComponent hands, EntRemovedFromContainerMessage args)
Parameters
Type Name Description
EntityUid uid
HandsComponent hands
Robust.Shared.Containers.EntRemovedFromContainerMessage args
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
Overrides
| Improve this Doc View Source

ReloadHandButtons()

Declaration
public void ReloadHandButtons()
| Improve this Doc View Source

RemoveHand(EntityUid, String, HandsComponent)

Declaration
public override void RemoveHand(EntityUid uid, string handName, HandsComponent handsComp = null)
Parameters
Type Name Description
EntityUid uid
System.String handName
HandsComponent handsComp
| Improve this Doc View Source

TryGetPlayerHands(out HandsComponent)

Get the hands component of the local player

Declaration
public bool TryGetPlayerHands(out HandsComponent hands)
Parameters
Type Name Description
HandsComponent hands
Returns
Type Description
System.Boolean
| Improve this Doc View Source

UIHandActivate(String)

Called when a user clicks on the little "activation" icon in the hands GUI. This is currently only used by storage (backpacks, etc).

Declaration
public void UIHandActivate(string handName)
Parameters
Type Name Description
System.String handName
| Improve this Doc View Source

UIHandAltActivateItem(String)

Declaration
public void UIHandAltActivateItem(string handName)
Parameters
Type Name Description
System.String handName
| Improve this Doc View Source

UIHandClick(HandsComponent, String)

Called when a user clicked on their hands GUI

Declaration
public void UIHandClick(HandsComponent hands, string handName)
Parameters
Type Name Description
HandsComponent hands
System.String handName
| Improve this Doc View Source

UIHandOpenContextMenu(String)

Called when a user clicks on the little "activation" icon in the hands GUI. This is currently only used by storage (backpacks, etc).

Declaration
public void UIHandOpenContextMenu(string handName)
Parameters
Type Name Description
System.String handName
| Improve this Doc View Source

UIInventoryExamine(String)

Declaration
public void UIInventoryExamine(string handName)
Parameters
Type Name Description
System.String handName

Events

| Improve this Doc View Source

OnPlayerAddHand

Declaration
public event Action<string, HandLocation>? OnPlayerAddHand
Event Type
Type Description
System.Nullable<Action<System.String, HandLocation>>
| Improve this Doc View Source

OnPlayerHandBlocked

Declaration
public event Action<string>? OnPlayerHandBlocked
Event Type
Type Description
System.Nullable<Action<System.String>>
| Improve this Doc View Source

OnPlayerHandsAdded

Declaration
public event Action<HandsComponent>? OnPlayerHandsAdded
Event Type
Type Description
System.Nullable<Action<HandsComponent>>
| Improve this Doc View Source

OnPlayerHandsRemoved

Declaration
public event Action? OnPlayerHandsRemoved
Event Type
Type Description
System.Nullable<Action>
| Improve this Doc View Source

OnPlayerHandUnblocked

Declaration
public event Action<string>? OnPlayerHandUnblocked
Event Type
Type Description
System.Nullable<Action<System.String>>
| Improve this Doc View Source

OnPlayerItemAdded

Declaration
public event Action<string, EntityUid>? OnPlayerItemAdded
Event Type
Type Description
System.Nullable<Action<System.String, EntityUid>>
| Improve this Doc View Source

OnPlayerItemRemoved

Declaration
public event Action<string, EntityUid>? OnPlayerItemRemoved
Event Type
Type Description
System.Nullable<Action<System.String, EntityUid>>
| Improve this Doc View Source

OnPlayerRemoveHand

Declaration
public event Action<string>? OnPlayerRemoveHand
Event Type
Type Description
System.Nullable<Action<System.String>>
| Improve this Doc View Source

OnPlayerSetActiveHand

Declaration
public event Action<string?>? OnPlayerSetActiveHand
Event Type
Type Description
System.Nullable<Action<System.Nullable<System.String>>>

Implements

EntitySystem