InputManager
Defined in: InputManager.ts:10
Central input state manager. Resolved via DI with InputManagerKey.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new InputManager():
InputManager
Returns
Section titled “Returns”InputManager
Methods
Section titled “Methods”_advanceTime()
Section titled “_advanceTime()”_advanceTime(
dtMs):void
Defined in: InputManager.ts:410
Internal
Advance the elapsed game-time clock. Called by InputPollSystem.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
_clearFrameState()
Section titled “_clearFrameState()”_clearFrameState():
void
Defined in: InputManager.ts:394
Internal
Clear per-frame justPressed/justReleased flags.
Returns
Section titled “Returns”void
_onKeyDown()
Section titled “_onKeyDown()”_onKeyDown(
code):void
Defined in: InputManager.ts:355
Internal
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
_onKeyUp()
Section titled “_onKeyUp()”_onKeyUp(
code):void
Defined in: InputManager.ts:370
Internal
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
_onPointerDown()
Section titled “_onPointerDown()”_onPointerDown():
void
Defined in: InputManager.ts:384
Internal
Returns
Section titled “Returns”void
_onPointerMove()
Section titled “_onPointerMove()”_onPointerMove(
screenX,screenY):void
Defined in: InputManager.ts:379
Internal
Parameters
Section titled “Parameters”screenX
Section titled “screenX”number
screenY
Section titled “screenY”number
Returns
Section titled “Returns”void
_onPointerUp()
Section titled “_onPointerUp()”_onPointerUp():
void
Defined in: InputManager.ts:389
Internal
Returns
Section titled “Returns”void
_setCamera()
Section titled “_setCamera()”_setCamera(
camera):void
Defined in: InputManager.ts:400
Internal
Set camera for pointer world-coord conversion.
Parameters
Section titled “Parameters”camera
Section titled “camera”Returns
Section titled “Returns”void
bindKey()
Section titled “bindKey()”bindKey(
action,key):void
Defined in: InputManager.ts:134
Add a key binding to an action. Creates the action if it doesn’t exist.
Parameters
Section titled “Parameters”action
Section titled “action”string
string
Returns
Section titled “Returns”void
cancelListen()
Section titled “cancelListen()”cancelListen():
void
Defined in: InputManager.ts:344
Cancel an active listenForNextKey. Resolves the pending promise with null.
Returns
Section titled “Returns”void
disableGroup()
Section titled “disableGroup()”disableGroup(
name):void
Defined in: InputManager.ts:293
Disable a group by name. Actions only in disabled groups become inactive.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
enableGroup()
Section titled “enableGroup()”enableGroup(
name):void
Defined in: InputManager.ts:288
Enable a group by name.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
exportBindings()
Section titled “exportBindings()”exportBindings():
ActionMapDefinition
Defined in: InputManager.ts:252
Export the current bindings as a plain object for serialization.
Returns
Section titled “Returns”getActionNames()
Section titled “getActionNames()”getActionNames():
string[]
Defined in: InputManager.ts:405
Get all configured action names.
Returns
Section titled “Returns”string[]
getActionsForKey()
Section titled “getActionsForKey()”getActionsForKey(
key):string[]
Defined in: InputManager.ts:161
Returns all action names that have the given key bound.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
getAxis()
Section titled “getAxis()”getAxis(
negative,positive):number
Defined in: InputManager.ts:79
Returns -1, 0, or 1 based on negative/positive action states.
Parameters
Section titled “Parameters”negative
Section titled “negative”string
positive
Section titled “positive”string
Returns
Section titled “Returns”number
getBindings()
Section titled “getBindings()”getBindings(
action): readonlystring[]
Defined in: InputManager.ts:156
Returns the current key bindings for an action, or an empty array if unmapped.
Parameters
Section titled “Parameters”action
Section titled “action”string
Returns
Section titled “Returns”readonly string[]
getGroupActions()
Section titled “getGroupActions()”getGroupActions(
name): readonlystring[]
Defined in: InputManager.ts:318
Get the action names belonging to a group. Returns empty array for unknown groups.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”readonly string[]
getGroups()
Section titled “getGroups()”getGroups():
string[]
Defined in: InputManager.ts:313
Get all configured group names.
Returns
Section titled “Returns”string[]
getHoldDuration()
Section titled “getHoldDuration()”getHoldDuration(
action):number
Defined in: InputManager.ts:57
Milliseconds the action has been held. Returns 0 if not held.
Parameters
Section titled “Parameters”action
Section titled “action”string
Returns
Section titled “Returns”number
getPointerPosition()
Section titled “getPointerPosition()”getPointerPosition():
Vec2
Defined in: InputManager.ts:100
Pointer position in world coordinates (via Camera), or screen coords if no camera.
Returns
Section titled “Returns”Vec2
getPointerScreenPosition()
Section titled “getPointerScreenPosition()”getPointerScreenPosition():
Vec2
Defined in: InputManager.ts:112
Raw pointer position in screen coordinates.
Returns
Section titled “Returns”Vec2
getVector()
Section titled “getVector()”getVector(
left,right,up,down):Vec2
Defined in: InputManager.ts:86
Returns a Vec2 from four directional actions. Not normalized.
Parameters
Section titled “Parameters”string
string
string
string
Returns
Section titled “Returns”Vec2
isGroupEnabled()
Section titled “isGroupEnabled()”isGroupEnabled(
name):boolean
Defined in: InputManager.ts:308
Whether a group is currently enabled. Returns true for unknown group names.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
isHeldFor()
Section titled “isHeldFor()”isHeldFor(
action,minTime):boolean
Defined in: InputManager.ts:72
Whether the action has been held for at least minTime ms.
Parameters
Section titled “Parameters”action
Section titled “action”string
minTime
Section titled “minTime”number
Returns
Section titled “Returns”boolean
isJustPressed()
Section titled “isJustPressed()”isJustPressed(
action):boolean
Defined in: InputManager.ts:35
Whether any key mapped to this action was pressed this frame.
Parameters
Section titled “Parameters”action
Section titled “action”string
Returns
Section titled “Returns”boolean
isJustReleased()
Section titled “isJustReleased()”isJustReleased(
action):boolean
Defined in: InputManager.ts:41
Whether any key mapped to this action was released this frame.
Parameters
Section titled “Parameters”action
Section titled “action”string
Returns
Section titled “Returns”boolean
isPointerDown()
Section titled “isPointerDown()”isPointerDown():
boolean
Defined in: InputManager.ts:117
Whether any pointer button is currently held.
Returns
Section titled “Returns”boolean
isPressed()
Section titled “isPressed()”isPressed(
action):boolean
Defined in: InputManager.ts:29
Whether any key mapped to this action is currently held.
Parameters
Section titled “Parameters”action
Section titled “action”string
Returns
Section titled “Returns”boolean
listenForNextKey()
Section titled “listenForNextKey()”listenForNextKey():
Promise<string|null>
Defined in: InputManager.ts:336
Returns a promise that resolves with the next key code pressed. Intercepts the key.
Returns
Section titled “Returns”Promise<string | null>
loadBindings()
Section titled “loadBindings()”loadBindings(
map):void
Defined in: InputManager.ts:261
Load bindings from a plain object. Resets to defaults first, then overlays the provided map.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
rebind()
Section titled “rebind()”rebind(
action,key,opts?):RebindResult
Defined in: InputManager.ts:175
Rebind a key to an action with optional conflict detection. Conflicts are only detected between actions sharing at least one group.
Parameters
Section titled “Parameters”action
Section titled “action”string
string
Returns
Section titled “Returns”resetBindings()
Section titled “resetBindings()”resetBindings(
action?):void
Defined in: InputManager.ts:237
Reset bindings to defaults. If an action name is provided, only reset that action.
Parameters
Section titled “Parameters”action?
Section titled “action?”string
Returns
Section titled “Returns”void
setActionMap()
Section titled “setActionMap()”setActionMap(
actions):void
Defined in: InputManager.ts:124
Replace the entire action map and store it as the default for resetBindings.
Parameters
Section titled “Parameters”actions
Section titled “actions”Returns
Section titled “Returns”void
setActiveGroups()
Section titled “setActiveGroups()”setActiveGroups(
names):void
Defined in: InputManager.ts:298
Set exactly these groups as active; all others are disabled.
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”void
setGroups()
Section titled “setGroups()”setGroups(
groups):void
Defined in: InputManager.ts:271
Configure input groups. Group name -> array of action names.
Parameters
Section titled “Parameters”groups
Section titled “groups”Record<string, string[]>
Returns
Section titled “Returns”void
unbindKey()
Section titled “unbindKey()”unbindKey(
action,key):void
Defined in: InputManager.ts:146
Remove a key binding from an action.
Parameters
Section titled “Parameters”action
Section titled “action”string
string
Returns
Section titled “Returns”void