Struct InputActionProperty

A serializable property type that can either reference an action externally defined in an InputActionAsset or define a new action directly on the property.

Namespace: UnityEngine.InputSystem
Syntax
[Serializable]
public struct InputActionProperty : IEquatable<InputActionProperty>, IEquatable<InputAction>, IEquatable<InputActionReference>

Constructors

InputActionProperty(InputAction)

Declaration
public InputActionProperty(InputAction action)
Parameters
Type Name Description
InputAction action

InputActionProperty(InputActionReference)

Declaration
public InputActionProperty(InputActionReference reference)
Parameters
Type Name Description
InputActionReference reference

Properties

action

The action held on to by the property.

Declaration
public InputAction action { get; }
Property Value
Type Description
InputAction

reference

Declaration
public InputActionReference reference { get; }
Property Value
Type Description
InputActionReference

Methods

Equals(Object)

Declaration
public override bool Equals(object o)
Parameters
Type Name Description
System.Object o
Returns
Type Description
System.Boolean
Overrides
System.ValueType.Equals(System.Object)

Equals(InputAction)

Declaration
public bool Equals(InputAction other)
Parameters
Type Name Description
InputAction other
Returns
Type Description
System.Boolean

Equals(InputActionProperty)

Declaration
public bool Equals(InputActionProperty other)
Parameters
Type Name Description
InputActionProperty other
Returns
Type Description
System.Boolean

Equals(InputActionReference)

Declaration
public bool Equals(InputActionReference other)
Parameters
Type Name Description
InputActionReference other
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.ValueType.GetHashCode()

Operators

Equality(InputAction, InputActionProperty)

Declaration
public static bool operator ==(InputAction left, InputActionProperty right)
Parameters
Type Name Description
InputAction left
InputActionProperty right
Returns
Type Description
System.Boolean

Equality(InputActionProperty, InputAction)

Declaration
public static bool operator ==(InputActionProperty left, InputAction right)
Parameters
Type Name Description
InputActionProperty left
InputAction right
Returns
Type Description
System.Boolean

Equality(InputActionProperty, InputActionProperty)

Declaration
public static bool operator ==(InputActionProperty left, InputActionProperty right)
Parameters
Type Name Description
InputActionProperty left
InputActionProperty right
Returns
Type Description
System.Boolean

Implicit(InputAction to InputActionProperty)

Declaration
public static implicit operator InputActionProperty(InputAction action)
Parameters
Type Name Description
InputAction action
Returns
Type Description
InputActionProperty

Inequality(InputAction, InputActionProperty)

Declaration
public static bool operator !=(InputAction left, InputActionProperty right)
Parameters
Type Name Description
InputAction left
InputActionProperty right
Returns
Type Description
System.Boolean

Inequality(InputActionProperty, InputAction)

Declaration
public static bool operator !=(InputActionProperty left, InputAction right)
Parameters
Type Name Description
InputActionProperty left
InputAction right
Returns
Type Description
System.Boolean

Inequality(InputActionProperty, InputActionProperty)

Declaration
public static bool operator !=(InputActionProperty left, InputActionProperty right)
Parameters
Type Name Description
InputActionProperty left
InputActionProperty right
Returns
Type Description
System.Boolean