Struct InputAction.CallbackContext

Information provided to action callbacks about what triggered an action.

Namespace: UnityEngine.InputSystem
Syntax
public struct CallbackContext

Properties

action

The action that got triggered.

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

canceled

Declaration
public bool canceled { get; }
Property Value
Type Description
System.Boolean

control

The control that triggered the action.

Declaration
public InputControl control { get; }
Property Value
Type Description
InputControl
Remarks

In case of a composite binding, this is the control of the composite that activated the composite as a whole. For example, in case of a WASD-style binding, it could be the W key.

duration

Time difference between time and startTime.

Declaration
public double duration { get; }
Property Value
Type Description
System.Double

interaction

The interaction that triggered the action or null if the binding that triggered does not have any particular interaction set on it.

Declaration
public IInputInteraction interaction { get; }
Property Value
Type Description
IInputInteraction

performed

Declaration
public bool performed { get; }
Property Value
Type Description
System.Boolean

phase

Declaration
public InputActionPhase phase { get; }
Property Value
Type Description
InputActionPhase

started

Declaration
public bool started { get; }
Property Value
Type Description
System.Boolean

startTime

Time at which the action was started.

Declaration
public double startTime { get; }
Property Value
Type Description
System.Double
Remarks

This is only relevant for actions that go through distinct a Started cycle as driven by IInputInteraction.

time

The time at which the action got triggered.

Declaration
public double time { get; }
Property Value
Type Description
System.Double
Remarks

This is usually determined by the timestamp of the input event that activated a control bound to the action.

valueSizeInBytes

Declaration
public int valueSizeInBytes { get; }
Property Value
Type Description
System.Int32

valueType

Declaration
public Type valueType { get; }
Property Value
Type Description
System.Type

Methods

ReadValue(Void*, Int32)

Declaration
public void ReadValue(void *buffer, int bufferSize)
Parameters
Type Name Description
System.Void* buffer
System.Int32 bufferSize

ReadValue<TValue>()

Declaration
public TValue ReadValue<TValue>()
    where TValue : struct
Returns
Type Description
TValue
Type Parameters
Name Description
TValue

ReadValueAsObject()

Declaration
public object ReadValueAsObject()
Returns
Type Description
System.Object

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.ValueType.ToString()

See Also

Did you find this page useful? Please give it a rating: