Class HandHelpers
These helpers exist to make getting basic information out of the hands component more convenient, without
needing to resolve hands system or something like that.
Inheritance
System.Object
HandHelpers
Assembly: Content.Shared.dll
Syntax
public static class HandHelpers : object
Methods
|
Improve this Doc
View Source
CountFreeHands(HandsComponent)
Get the number of hands that are not currently holding anything. This is a LinQ method, not a property, so
cache it instead of accessing this multiple times.
Declaration
public static int CountFreeHands(this HandsComponent component)
Parameters
Returns
| Type |
Description |
| System.Int32 |
|
|
Improve this Doc
View Source
GetFreeHandNames(HandsComponent)
Get a list of hands that are currently holding nothing. This is a LinQ method, not a property, so cache
it instead of accessing this multiple times.
Declaration
public static IEnumerable<string> GetFreeHandNames(this HandsComponent component)
Parameters
Returns
| Type |
Description |
| IEnumerable<System.String> |
|
|
Improve this Doc
View Source
GetFreeHands(HandsComponent)
Get a list of hands that are currently holding nothing. This is a LinQ method, not a property, so cache
it instead of accessing this multiple times.
Declaration
public static IEnumerable<Hand> GetFreeHands(this HandsComponent component)
Parameters
Returns
| Type |
Description |
| IEnumerable<Hand> |
|
|
Improve this Doc
View Source
IsAnyHandFree(HandsComponent)
Returns true if any hand is free. This is a LinQ method, not a property, so
cache it instead of accessing this multiple times.
Declaration
public static bool IsAnyHandFree(this HandsComponent component)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|