Class IntegratedInput<AL>

keyboardとgamepadで共通のキーを定義し、それをもってどちらの入力にも対応したラッパークラス

Example

const input = new IntegratedInput<"fire">()
input.defineKey("fire", "KeyZ", 1);
if (input.getKeyPress("fire")) doFiring()

Type Parameters

AL extends ActionLabelDefault

Hierarchy

IntegratedInput
- RecordableIntegratedInput

Index

Constructors

constructor

new IntegratedInput<AL>(gamepadIndex?: number): IntegratedInput<AL>
Type Parameters
- AL extends ActionLabelDefault
Parameters
- Optional gamepadIndex: number
Returns IntegratedInput<AL>
- Defined in input/IntegratedInput.ts:60

Properties

_assignMap

_assignMap: KeyAssignMap<Direction | AL> = ...

<ActionLabel => KeyAssign> Map

`Readonly` gamepad

gamepad: GamepadExtension

`Readonly` keyboard

keyboard: StatedKeyboard = ...

Methods

assignFromJson

assignFromJson(json: { [ action in ActionLabelDefault]: KeyAssignData }): void
jsonでキーアサインマップを初期化
Parameters
- json: { [ action in ActionLabelDefault]: KeyAssignData }
Returns void
- Defined in input/IntegratedInput.ts:100

assignGamepad

assignGamepad(label: AL, code: number): void
Parameters
- label: AL
- code: number
Returns void
- Defined in input/IntegratedInput.ts:89

assignKeyboard

assignKeyboard(label: AL, code: "Escape" | "Minus" | "Equal" | "Backspace" | "Tab" | "Enter" | "ShiftLeft" | "ShiftRight" | "ControlLeft" | "ControlRight" | "AltLeft" | "AltRight" | "Pause" | "CapsLock" | "Space" | "PageUp" | "PageDown" | "End" | "Home" | "ArrowLeft" | "ArrowUp" | "ArrowRight" | "ArrowDown" | "PrintScreen" | "Insert" | "Delete" | "Digit0" | "Digit1" | "Digit2" | "Digit3" | "Digit4" | "Digit5" | "Digit6" | "Digit7" | "Digit8" | "Digit9" | "KeyA" | "KeyB" | "KeyC" | "KeyD" | "KeyE" | "KeyF" | "KeyG" | "KeyH" | "KeyI" | "KeyJ" | "KeyK" | "KeyL" | "KeyM" | "KeyN" | "KeyO" | "KeyP" | "KeyQ" | "KeyR" | "KeyS" | "KeyT" | "KeyU" | "KeyV" | "KeyW" | "KeyX" | "KeyY" | "KeyZ" | "MetaLeft" | "OSLeft" | "MetaRight" | "OSRight" | "ContextMenu" | "Numpad0" | "Numpad1" | "Numpad2" | "Numpad3" | "Numpad4" | "Numpad5" | "Numpad6" | "Numpad7" | "Numpad8" | "Numpad9" | "NumpadMultiply" | "NumpadAdd" | "NumpadSubtract" | "NumpadDecimal" | "NumpadDivide" | "NumpadEnter" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "F13" | "F14" | "F15" | "F16" | "F17" | "F18" | "F19" | "F20" | "F21" | "F22" | "F23" | "F24" | "NumLock" | "ScrollLock" | "Semicolon" | "Comma" | "Period" | "Slash" | "Backquote" | "BracketLeft" | "Backslash" | "BracketRight" | "Quote" | "Unidentified"): void
Parameters
- label: AL
- code: "Escape" | "Minus" | "Equal" | "Backspace" | "Tab" | "Enter" | "ShiftLeft" | "ShiftRight" | "ControlLeft" | "ControlRight" | "AltLeft" | "AltRight" | "Pause" | "CapsLock" | "Space" | "PageUp" | "PageDown" | "End" | "Home" | "ArrowLeft" | "ArrowUp" | "ArrowRight" | "ArrowDown" | "PrintScreen" | "Insert" | "Delete" | "Digit0" | "Digit1" | "Digit2" | "Digit3" | "Digit4" | "Digit5" | "Digit6" | "Digit7" | "Digit8" | "Digit9" | "KeyA" | "KeyB" | "KeyC" | "KeyD" | "KeyE" | "KeyF" | "KeyG" | "KeyH" | "KeyI" | "KeyJ" | "KeyK" | "KeyL" | "KeyM" | "KeyN" | "KeyO" | "KeyP" | "KeyQ" | "KeyR" | "KeyS" | "KeyT" | "KeyU" | "KeyV" | "KeyW" | "KeyX" | "KeyY" | "KeyZ" | "MetaLeft" | "OSLeft" | "MetaRight" | "OSRight" | "ContextMenu" | "Numpad0" | "Numpad1" | "Numpad2" | "Numpad3" | "Numpad4" | "Numpad5" | "Numpad6" | "Numpad7" | "Numpad8" | "Numpad9" | "NumpadMultiply" | "NumpadAdd" | "NumpadSubtract" | "NumpadDecimal" | "NumpadDivide" | "NumpadEnter" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "F13" | "F14" | "F15" | "F16" | "F17" | "F18" | "F19" | "F20" | "F21" | "F22" | "F23" | "F24" | "NumLock" | "ScrollLock" | "Semicolon" | "Comma" | "Period" | "Slash" | "Backquote" | "BracketLeft" | "Backslash" | "BracketRight" | "Quote" | "Unidentified"
Returns void
- Defined in input/IntegratedInput.ts:83

convertAssignsToJSON

convertAssignsToJSON(): { [ action in ActionLabelDefault]: KeyAssignData }
キーアサイン状態をJSONオブジェクトにして返す

Returns { [ action in ActionLabelDefault]: KeyAssignData }
- Defined in input/IntegratedInput.ts:117

defineKey

defineKey(actionKey: AL, kbKey?: "Escape" | "Minus" | "Equal" | "Backspace" | "Tab" | "Enter" | "ShiftLeft" | "ShiftRight" | "ControlLeft" | "ControlRight" | "AltLeft" | "AltRight" | "Pause" | "CapsLock" | "Space" | "PageUp" | "PageDown" | "End" | "Home" | "ArrowLeft" | "ArrowUp" | "ArrowRight" | "ArrowDown" | "PrintScreen" | "Insert" | "Delete" | "Digit0" | "Digit1" | "Digit2" | "Digit3" | "Digit4" | "Digit5" | "Digit6" | "Digit7" | "Digit8" | "Digit9" | "KeyA" | "KeyB" | "KeyC" | "KeyD" | "KeyE" | "KeyF" | "KeyG" | "KeyH" | "KeyI" | "KeyJ" | "KeyK" | "KeyL" | "KeyM" | "KeyN" | "KeyO" | "KeyP" | "KeyQ" | "KeyR" | "KeyS" | "KeyT" | "KeyU" | "KeyV" | "KeyW" | "KeyX" | "KeyY" | "KeyZ" | "MetaLeft" | "OSLeft" | "MetaRight" | "OSRight" | "ContextMenu" | "Numpad0" | "Numpad1" | "Numpad2" | "Numpad3" | "Numpad4" | "Numpad5" | "Numpad6" | "Numpad7" | "Numpad8" | "Numpad9" | "NumpadMultiply" | "NumpadAdd" | "NumpadSubtract" | "NumpadDecimal" | "NumpadDivide" | "NumpadEnter" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "F13" | "F14" | "F15" | "F16" | "F17" | "F18" | "F19" | "F20" | "F21" | "F22" | "F23" | "F24" | "NumLock" | "ScrollLock" | "Semicolon" | "Comma" | "Period" | "Slash" | "Backquote" | "BracketLeft" | "Backslash" | "BracketRight" | "Quote" | "Unidentified", gpCode?: number): void
キー定義

Example
```
const input = new IntegratedInput<"fire">()
input.defineKey("fire", "KeyZ", 1);
```
Parameters
- actionKey: AL
- Optional kbKey: "Escape" | "Minus" | "Equal" | "Backspace" | "Tab" | "Enter" | "ShiftLeft" | "ShiftRight" | "ControlLeft" | "ControlRight" | "AltLeft" | "AltRight" | "Pause" | "CapsLock" | "Space" | "PageUp" | "PageDown" | "End" | "Home" | "ArrowLeft" | "ArrowUp" | "ArrowRight" | "ArrowDown" | "PrintScreen" | "Insert" | "Delete" | "Digit0" | "Digit1" | "Digit2" | "Digit3" | "Digit4" | "Digit5" | "Digit6" | "Digit7" | "Digit8" | "Digit9" | "KeyA" | "KeyB" | "KeyC" | "KeyD" | "KeyE" | "KeyF" | "KeyG" | "KeyH" | "KeyI" | "KeyJ" | "KeyK" | "KeyL" | "KeyM" | "KeyN" | "KeyO" | "KeyP" | "KeyQ" | "KeyR" | "KeyS" | "KeyT" | "KeyU" | "KeyV" | "KeyW" | "KeyX" | "KeyY" | "KeyZ" | "MetaLeft" | "OSLeft" | "MetaRight" | "OSRight" | "ContextMenu" | "Numpad0" | "Numpad1" | "Numpad2" | "Numpad3" | "Numpad4" | "Numpad5" | "Numpad6" | "Numpad7" | "Numpad8" | "Numpad9" | "NumpadMultiply" | "NumpadAdd" | "NumpadSubtract" | "NumpadDecimal" | "NumpadDivide" | "NumpadEnter" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "F13" | "F14" | "F15" | "F16" | "F17" | "F18" | "F19" | "F20" | "F21" | "F22" | "F23" | "F24" | "NumLock" | "ScrollLock" | "Semicolon" | "Comma" | "Period" | "Slash" | "Backquote" | "BracketLeft" | "Backslash" | "BracketRight" | "Quote" | "Unidentified"
- Optional gpCode: number
Returns void
- Defined in input/IntegratedInput.ts:75

getActionLabelFromCode

getActionLabelFromCode(code: IntegratedCode, inputType?: keyof KeyAssignData): undefined | AL
割り当てたキーコード等から対応アクションラベルを取得

※方向キー(Direction)種は無視

Returns
アクション名。見つからなかった場合はundefined 同じキーコードが割り当てられたアクションがあった場合、片方しか帰ってこない配列にする？
Parameters
- code: IntegratedCode
- Optional inputType: keyof KeyAssignData
Returns undefined | AL
- Defined in input/IntegratedInput.ts:193

getActionLabelFromGamePadButton

getActionLabelFromGamePadButton(gpButtonId: number): undefined | AL
gamepadボタンidから割り当てられているアクションを取得

Returns
アクション名。見つからなかった場合はundefined
Parameters
- gpButtonId: number
Returns undefined | AL
- Defined in input/IntegratedInput.ts:234

getKeyAssignData

getKeyAssignData(label: Direction | AL): undefined | KeyAssignData
ラベルから定義したアサイン情報取得

Returns
アサイン情報、定義が無ければundefined
Parameters
- label: Direction | AL
Returns undefined | KeyAssignData
- Defined in input/IntegratedInput.ts:132

getKeyDown

getKeyDown(actionLabel: Direction | AL, border?: number): boolean
Parameters
- actionLabel: Direction | AL
- Optional border: number
Returns boolean
- Defined in input/IntegratedInput.ts:167

getKeyPress

getKeyPress(actionLabel: Direction | AL, threshold?: number): boolean
指定アクションキーが押下状態かどうか
Parameters
- actionLabel: Direction | AL
- threshold: number = 0
Returns boolean
- Defined in input/IntegratedInput.ts:158

getKeyUp

getKeyUp(actionLabel: Direction | AL): boolean
Parameters
- actionLabel: Direction | AL
Returns boolean
- Defined in input/IntegratedInput.ts:176

resetStateMap

resetStateMap(): void
keyboard&gamepad キー状態リセット

Returns void
- Defined in input/IntegratedInput.ts:148

updateKeyStates

updateKeyStates(autoPlayMode?: boolean): void
内部KeyStateを更新基本的に毎フレーム実行
Parameters
- Optional autoPlayMode: boolean
Returns void
- Defined in input/IntegratedInput.ts:140

Class IntegratedInput<AL>

Example

Type Parameters

AL extends ActionLabelDefault

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

AL extends ActionLabelDefault

Parameters

Optional gamepadIndex: number

Returns IntegratedInput<AL>

Properties

_assignMap

Readonly gamepad

Readonly keyboard

Methods

assignFromJson

Parameters

json: { [ action in ActionLabelDefault]: KeyAssignData }

Returns void

assignGamepad

Parameters

label: AL

code: number

Returns void

assignKeyboard

Parameters

label: AL

Returns void

convertAssignsToJSON

Returns { [ action in ActionLabelDefault]: KeyAssignData }

defineKey

Example

Parameters

actionKey: AL

Optional gpCode: number

Returns void

getActionLabelFromCode

Returns

Parameters

code: IntegratedCode

Optional inputType: keyof KeyAssignData

Returns undefined | AL

getActionLabelFromGamePadButton

Returns

Parameters

gpButtonId: number

Returns undefined | AL

getKeyAssignData

Returns

Parameters

label: Direction | AL

Returns undefined | KeyAssignData

getKeyDown

Parameters

actionLabel: Direction | AL

Optional border: number

Returns boolean

getKeyPress

Parameters

actionLabel: Direction | AL

threshold: number = 0

Returns boolean

getKeyUp

Parameters

actionLabel: Direction | AL

Returns boolean

resetStateMap

Returns void

updateKeyStates

Parameters

Optional autoPlayMode: boolean

Returns void

Settings

Member Visibility

`Optional` gamepadIndex: number

`Readonly` gamepad

`Readonly` keyboard

`Optional` gpCode: number

`Optional` inputType: keyof KeyAssignData

`Optional` border: number

`Optional` autoPlayMode: boolean