Input Action Update

Like what your seeing?

Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

Used by InputAction objects to report changes as an event argument. InputAction is a type of Game Event, to learn more about Game Events read our article here.

Fields and Attributes

controller

public InputHandle_t controller

The controller this event was triggered by

type

public InputActionType type

The type of input action that caused this event

mode

public EInputSourceMode mode

The input mode behaviour used for the InputAction that generated this event e.g. button, stick, trigger, etc.

isActive

public bool isActive

Indicates rather or not this action is currently active

isState

public bool isState

Indicates rather or not this action is currently state == true or false, true meaning this action happened, false meaning it is not happening.

isX

public float isX

The current value of the X input for this action if any

isY

public float isY

The current value of the Y input for this action if any

wasActive

public bool wasActive

Indicates rather or not this action was active before this event

wasState

public bool wasState

Indicates rather or not this action was state = true or false before this event

wasX

public float wasX

The value of the X input for this action before this event if any

wasY

public float wasY

The value of the Y input for this action before this event if any

DeltaX

public float DeltaX => isX - wasX;

The difference between is and was for the X input

DeltaY

public float DeltaY => isY - wasY;

The difference between is and was for the Y input

Active

public bool Active => isActive;

Reads the is Active, convenance feature and no different than reading isActive

State

public bool State => isState;

Reads the is State, convenance feature and no different than reading isState

X

public float X => isX;

Reads the is X, convenance feature and no different than reading isX

Y

public float Y => isY;

Reads the is Y, convenance feature and no different than reading isY

Data

public InputActionData Data => get;

Returns an InputActionData object representing the "is" or current state of the InputAction.