ZOA Input

InputActionId

struct

Strongly typed action identifier wrapping a string. Ordinal equality, an IsValid guard against empty values, and equality operators so it works as a dictionary key.

• InputActionId(string value)
• string Value { get; } bool IsValid { get; }

InputContextId

struct

Strongly typed context identifier. Same shape as InputActionId; DefaultContexts holds the built-in values.

• InputContextId(string value)
• string Value { get; } bool IsValid { get; }

DefaultContexts

class

The built-in context ids for common gameplay states. Gameplay is the guaranteed floor of every stack.

• static readonly InputContextId Gameplay, UI, Vehicle
• static readonly InputContextId Inventory, Dialogue, Spectator, Debug

IInputActionBinding

interface

Read-only view of one action, abstracted from the underlying input system. This is what a weapon controller or an interaction trigger holds instead of an InputActionReference.

• InputActionId ActionId { get; } InputContextId OwnerContext { get; }
• bool IsPressed { get; }
• bool WasPressedThisFrame { get; } bool WasReleasedThisFrame { get; }
• float ReadValue() Vector2 ReadVector2()

InputActionBinding

class

The concrete wrapper over a Unity InputAction. Every read guards on the action being enabled, and the value reads catch the control-type mismatch that compound bindings can throw, returning zero rather than letting an exception escape an Update loop.

• InputActionBinding(InputActionId actionId, InputContextId ownerContext, InputAction action)

IZOAInputBindings

interface

The binding-lookup service. A failed resolve means the action is not authored in the active set, which callers treat as not available in this context rather than as an error.

• bool TryGetBinding(InputActionId actionId, out IInputActionBinding binding)
• bool TryGetBinding(string actionId, out IInputActionBinding binding)

IInputContextService

interface

Layered context management with arbitration. Push and pop as surfaces open and close; register a rule to change how one action resolves.

• void PushContext(InputContextId contextId, int priority = 0)
• void PopContext(InputContextId contextId)
• InputContextId ActiveContext { get; }
• bool IsContextActive(InputContextId contextId)
• void RegisterArbitrationRule(InputArbitrationRule rule)

InputContextService

class

The concrete stack. Adds the two resolution queries the interface does not expose, and guarantees the Gameplay baseline is always present.

• const int DefaultPriority = 0
• InputContextId ResolveOwner(InputActionId actionId)
• bool IsActionAllowed(InputContextId contextId, InputActionId actionId)

InputArbitrationRule

class

One action's conflict-resolution policy: the action it governs, the context it prefers, and the strategy to apply.

• InputArbitrationRule(InputActionId actionId, InputContextId preferredContext, InputArbitrationStrategy strategy = InputArbitrationStrategy.HighestPriority)
• InputActionId ActionId { get; } InputContextId PreferredContext { get; } InputArbitrationStrategy Strategy { get; }

InputArbitrationStrategy

enum

How a contested action resolves. HighestPriority is the default when no rule is registered.

• HighestPriority — the top active context wins
• PreferSpecified — the named context wins whenever it is active
• BlockAll — nobody gets the action while the conflict exists
• PassThrough — every active context sees it

IInputFocusService

interface

Owner-token focus stack. Each request is tracked independently, so nested surfaces release their own claim without disturbing anyone else's.

• InputFocusToken Acquire(InputFocusRequest request)
• bool Release(InputFocusToken token) int ReleaseOwner(object owner)
• bool IsActive(InputFocusToken token)
• InputFocusSnapshot Snapshot { get; } InputContextId ActiveContext { get; }
• event Action<InputFocusSnapshot> Changed

InputFocusRequest

struct

What a surface asks for: a context, an owner, a priority, a layer, whether the cursor should lock or unlock, whether gameplay should be suppressed, and a reason string for diagnostics.

• InputFocusRequest(InputContextId contextId, object owner = null, int priority = 0, InputFocusLayer layer = InputFocusLayer.Overlay, InputFocusCursorPolicy cursorPolicy = InputFocusCursorPolicy.Unchanged, bool suppressesGameplay = false, string reason = null)
• enum InputFocusLayer { Gameplay = 0, Overlay = 10, Modal = 20, System = 30 }
• enum InputFocusCursorPolicy { Unchanged, Lock, Unlock }

InputFocusSnapshot

class

The resolved focus state handed to subscribers: the winning entry, every live entry, and the derived context, cursor policy and gameplay-suppression flag.

• InputFocusEntry? ActiveEntry { get; } IReadOnlyList<InputFocusEntry> Entries { get; }
• InputContextId ActiveContext { get; }
• InputFocusCursorPolicy CursorPolicy { get; } bool SuppressesGameplay { get; }

ZOAInputAdapter

component

The composition root on the player rig. Materialises the binding set into Unity InputActions, owns the context and focus services, and publishes all three into the service registry. Added under ZOA/Input/ZOA Input Adapter.

• InputBindingSet BindingSet { get; } void SetBindingSet(InputBindingSet newSet)
• InputContextService ContextService { get; } InputFocusService FocusService { get; }
• bool TryGetBinding(InputActionId actionId, out IInputActionBinding binding)
• serialized: bindingSet, publishToRegistry, initialContextId, initialContextPriority

InputFocusUnityBridge

class

Translates focus intent into Unity behaviour: cursor capture, the cursor-lock bus, and input suppression. Constructed by the adapter and disposed with it.

• InputFocusUnityBridge(IInputFocusService focusService, UnityEngine.Object cursorOwner, object suppressionOwner = null)
• bool CursorCaptured { get; } bool InputSuppressed { get; }
• void Dispose()

InputBindingRow

struct

One canonical action and every binding path that activates it. Supports single paths, multi-path fan-in across device families, and composites through named CompositePart entries.

• string actionId string displayName InputControlType controlType
• List<string> bindingPaths
• bool isComposite string compositeType List<CompositePart> compositeParts
• bool IsAuthored()
• enum InputControlType { Button, Axis, Vector2 }

IInputGlyphService

interface

Glyph metadata lookup plus active-device tracking. HUD prompts, tutorials and the rebind menu resolve through it instead of parsing control paths themselves.

• InputDeviceFamily ActiveFamily { get; }
• IReadOnlyList<InputGlyph> GlyphsFor(string actionId)
• bool TryGetGlyph(string actionId, InputDeviceFamily family, out InputGlyph glyph)
• IReadOnlyCollection<string> ActionIds { get; }

InputGlyphService

service

The default glyph service, built from InputActionAssets. Ensure resolves or creates the registered instance; Rebuild replaces the table wholesale after a rebind. Its path classifiers are public and are what the editor exporters use.

• static InputGlyphService Ensure()
• void Rebuild(params InputActionAsset[] assets)
• static InputDeviceFamily ClassifyControlPath(string controlPath)
• static string NormalizeGlyphKey(string controlPath)

InputGlyph

struct

One action-binding glyph entry: the action id, its device family, the normalised semantic glyph key an atlas resolves, and a human-readable label for text fallbacks. Never a sprite reference.

• string ActionId InputDeviceFamily Family string GlyphKey string DisplayName
• enum InputDeviceFamily { Unknown, KeyboardMouse, XboxGamepad, PlayStationGamepad, NintendoGamepad, GenericGamepad, SteamDeck, Touch }

InputOverrideStore

class

PlayerPrefs-backed persistence for user rebinds. One JSON blob per binding-set id, so two sets never collide and saving a set is one write rather than one per action.

• static void Save(string bindingSetId, IEnumerable<(string actionId, int bindingIndex, string overridePath)> entries)
• static IEnumerable<(string actionId, int bindingIndex, string overridePath)> Load(string bindingSetId)
• static void Clear(string bindingSetId)

InputRebindMenu

component

The runtime rebind panel. Enumerates the rows published on the active bindings, captures a new control through Unity's interactive rebinding, and persists the override. Requires a UIDocument sibling and compiles only under the ZOA_INPUT_REBIND_UI define. Added under ZOA/Input/Runtime Rebind Menu.

• serialized: headingText, bindingSetIdOverride, applyOverridesOnStart

InputBindingSet

asset

The bundled binding-set asset: a stable id, the context it targets, and one row per canonical action. A genre bundle references one by id and the adapter loads it at play-mode start to build its InputActions. Created via ZOA/Input/Input Binding Set.

• string BindingSetId { get; } string Version { get; } int SchemaVersion { get; }
• string ContextId { get; } IReadOnlyList<InputBindingRow> Rows { get; }
• bool TryGetRow(string actionId, out InputBindingRow row)
• const int CurrentSchemaVersion = 1