InteractionInputPhase

Enum representing the phases of an interaction input action lifecycle. Maps to Unity's UnityEngine.InputSystem.InputActionPhase values using Townskeep naming conventions.

Definition

Namespace: Paragon.Townskeep.InteractionSystem Assembly: Townskeep.dll

public enum InteractionInputPhase

Remarks

This enum mirrors Paragon Core's InputActionPhase but is scoped to the Interaction System. It determines which Unity input phase an InteractionInput subscribes to when Bind() is called.

Values

Value
Unity Equivalent
Description

STARTED

InputActionPhase.Started

The action has been initiated (e.g., button pressed down)

PERFORMED

InputActionPhase.Performed

The action has been fully performed (e.g., button click completed)

CANCELED

InputActionPhase.Canceled

The action was cancelled (e.g., button released)

Phase Lifecycle

Button Press → STARTED → (hold) → PERFORMED → Button Release → CANCELED
circle-info

The exact timing of PERFORMED depends on the interaction type configured on the Unity InputAction. For a "Press" interaction, PERFORMED fires immediately. For a "Hold" interaction, PERFORMED fires after the hold duration elapses.

See Also

Last updated