Class InputActionNode

A single action inside an action map, viewed through the underlying InputJSONNode.

Inheritance

object

InputActionNode

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.Input

Assembly: ScyllaInput.dll

Syntax

public sealed class InputActionNode

Remarks

An action carries no bindings of its own in this format. Its bindings are entries in the owning map's binding array whose action member matches this action's name. Use GetBindingsForAction(string, List<InputBindingNode>) to gather them.

Constructors

InputActionNode(InputJSONNode)

Wraps an existing action node.

Declaration

public InputActionNode(InputJSONNode node)

Parameters

Type	Name	Description
InputJSONNode	node	The backing node.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the node is null.

Properties

ExpectedControlType

Gets or sets the expected control layout, for example Vector2.

Declaration

public string ExpectedControlType { get; set; }

Property Value

Type	Description
string

ID

Gets or sets the stable GUID.

Declaration

public string ID { get; set; }

Property Value

Type	Description
string

InitialStateCheck

Gets or sets whether the action performs an initial state check when enabled.

Declaration

public bool InitialStateCheck { get; set; }

Property Value

Type	Description
bool

Interactions

Gets or sets the semicolon-separated interaction list.

Declaration

public string Interactions { get; set; }

Property Value

Type	Description
string

Name

Gets or sets the action name, unique within its map.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Node

Gets the backing node, for access to members this wrapper does not model.

Declaration

public InputJSONNode Node { get; }

Property Value

Type	Description
InputJSONNode

Processors

Gets or sets the semicolon-separated processor list.

Declaration

public string Processors { get; set; }

Property Value

Type	Description
string

Type

Gets or sets the action type: Button, Value or PassThrough.

Declaration

public string Type { get; set; }

Property Value

Type	Description
string

Methods

Create(string, string, string, string)

Builds a new action node with every member present, in the order Unity emits them.

Declaration

public static InputActionNode Create(string name, string id, string type, string expectedControlType)

Parameters

Type	Name	Description
string	name	Action name.
string	id	Stable GUID.
string	type	Action type.
string	expectedControlType	Expected control layout, or empty.

Returns

Type	Description
InputActionNode	The wrapper around the new node.