Class Keyboard

The Keyboard class models a computer keyboard, providing ButtonInput properties for all of the keys found on most standard English computer keyboards (coverage of other language keyboards is currently unconfirmed).

Hierarchy

  • Keyboard

Implements

Constructors

constructor

Accessors

a b backquote backslash backspace buttons c capslock comma d delete down e end enter equal escape f f1 f10 f11 f12 f2 f3 f4 f5 f6 f7 f8 f9 finished g h home i insert intlBackslash isFinished j k l left leftAlt leftBracket leftCtrl leftShift m minus n numlock numpad0 numpad1 numpad2 numpad3 numpad4 numpad5 numpad6 numpad7 numpad8 numpad9 numpadAdd numpadDecimal numpadDivide numpadEnter numpadMultiply numpadSubtract numrow0 numrow1 numrow2 numrow3 numrow4 numrow5 numrow6 numrow7 numrow8 numrow9 o p pageDown pageUp period q quote r ref right rightAlt rightBracket rightCtrl rightShift s semicolon slash space t tab typeName u up v w x y z

Methods

activate deactivate finish update withRef

Constructors

constructor

  • Parameters

    • eventSubscriber: IEventSubscriber

      The passed in event subscriber should wrap around the document object, allowing the keyboard to subscribe to keyup & keydown events when the activate() method is called.

    Returns Keyboard

Accessors

a

b

backquote

  • get backquote(): ButtonInput

  • ButtonInput for the Backquote ` key.

    Returns ButtonInput

backslash

  • get backslash(): ButtonInput

  • ButtonInput for the Backslash `` key.

    Returns ButtonInput

backspace

  • get backspace(): ButtonInput

  • ButtonInput for the Backspace key in the numbers row.

    Returns ButtonInput

buttons

  • get buttons(): ButtonInput[]

  • The collection of all ButtonInputs that the Keyboard holds.

    Returns ButtonInput[]

c

capslock

  • get capslock(): ButtonInput

  • ButtonInput for the Caps Lock key.

    Returns ButtonInput

comma

d

delete

down

e

end

enter

equal

  • get equal(): ButtonInput

  • ButtonInput for the Equal key in the numbers row.

    Returns ButtonInput

escape

f

f1

f10

f11

f12

f2

f3

f4

f5

f6

f7

f8

f9

finished

g

h

home

i

insert

intlBackslash

  • get intlBackslash(): ButtonInput

  • ButtonInput for the Backslash `` key on non-American keyboards (typically located next to the left shift key).

    Returns ButtonInput

isFinished

  • get isFinished(): boolean

  • If true, then the keyboard has been deactivated and marked for disposal.

    Returns boolean

j

k

l

left

leftAlt

leftBracket

  • get leftBracket(): ButtonInput

  • ButtonInput for the Left Bracket [ key.

    Returns ButtonInput

leftCtrl

  • get leftCtrl(): ButtonInput

  • ButtonInput for the Left Control key.

    Returns ButtonInput

leftShift

  • get leftShift(): ButtonInput

  • ButtonInput for the Left Shift key.

    Returns ButtonInput

m

minus

  • get minus(): ButtonInput

  • ButtonInput for the Minus key in the numbers row.

    Returns ButtonInput

n

numlock

numpad0

  • get numpad0(): ButtonInput

  • ButtonInput for the 0 key in the numpad.

    Returns ButtonInput

numpad1

  • get numpad1(): ButtonInput

  • ButtonInput for the 1 key in the numpad.

    Returns ButtonInput

numpad2

  • get numpad2(): ButtonInput

  • ButtonInput for the 2 key in the numpad.

    Returns ButtonInput

numpad3

  • get numpad3(): ButtonInput

  • ButtonInput for the 3 key in the numpad.

    Returns ButtonInput

numpad4

  • get numpad4(): ButtonInput

  • ButtonInput for the 4 key in the numpad.

    Returns ButtonInput

numpad5

  • get numpad5(): ButtonInput

  • ButtonInput for the 5 key in the numpad.

    Returns ButtonInput

numpad6

  • get numpad6(): ButtonInput

  • ButtonInput for the 6 key in the numpad.

    Returns ButtonInput

numpad7

  • get numpad7(): ButtonInput

  • ButtonInput for the 7 key in the numpad.

    Returns ButtonInput

numpad8

  • get numpad8(): ButtonInput

  • ButtonInput for the 8 key in the numpad.

    Returns ButtonInput

numpad9

  • get numpad9(): ButtonInput

  • ButtonInput for the 9 key in the numpad.

    Returns ButtonInput

numpadAdd

  • get numpadAdd(): ButtonInput

  • ButtonInput for the Add + key in the numpad.

    Returns ButtonInput

numpadDecimal

  • get numpadDecimal(): ButtonInput

  • ButtonInput for the Decimal . key in the numpad.

    Returns ButtonInput

numpadDivide

  • get numpadDivide(): ButtonInput

  • ButtonInput for the Divide / key in the numpad.

    Returns ButtonInput

numpadEnter

  • get numpadEnter(): ButtonInput

  • ButtonInput for the Enter key in the numpad.

    Returns ButtonInput

numpadMultiply

  • get numpadMultiply(): ButtonInput

  • ButtonInput for the Multiply * key in the numpad.

    Returns ButtonInput

numpadSubtract

  • get numpadSubtract(): ButtonInput

  • ButtonInput for the Subtract - key in the numpad.

    Returns ButtonInput

numrow0

  • get numrow0(): ButtonInput

  • ButtonInput for the 0 key in the numbers row.

    Returns ButtonInput

numrow1

  • get numrow1(): ButtonInput

  • ButtonInput for the 1 key in the numbers row.

    Returns ButtonInput

numrow2

  • get numrow2(): ButtonInput

  • ButtonInput for the 2 key in the numbers row.

    Returns ButtonInput

numrow3

  • get numrow3(): ButtonInput

  • ButtonInput for the 3 key in the numbers row.

    Returns ButtonInput

numrow4

  • get numrow4(): ButtonInput

  • ButtonInput for the 4 key in the numbers row.

    Returns ButtonInput

numrow5

  • get numrow5(): ButtonInput

  • ButtonInput for the 5 key in the numbers row.

    Returns ButtonInput

numrow6

  • get numrow6(): ButtonInput

  • ButtonInput for the 6 key in the numbers row.

    Returns ButtonInput

numrow7

  • get numrow7(): ButtonInput

  • ButtonInput for the 7 key in the numbers row.

    Returns ButtonInput

numrow8

  • get numrow8(): ButtonInput

  • ButtonInput for the 8 key in the numbers row.

    Returns ButtonInput

numrow9

  • get numrow9(): ButtonInput

  • ButtonInput for the 9 key in the numbers row.

    Returns ButtonInput

o

p

pageDown

  • get pageDown(): ButtonInput

  • ButtonInput for the Page Down key.

    Returns ButtonInput

pageUp

period

q

quote

r

ref

  • get ref(): string

  • Provides a way of identifying keyboards so they can be easily retrieved later.

    Returns string

  • set ref(value: string): void

  • Parameters

    • value: string

    Returns void

right

rightAlt

  • get rightAlt(): ButtonInput

  • ButtonInput for the Right Alt key.

    Returns ButtonInput

rightBracket

  • get rightBracket(): ButtonInput

  • ButtonInput for the Right Bracket ] key.

    Returns ButtonInput

rightCtrl

  • get rightCtrl(): ButtonInput

  • ButtonInput for the Right Control key.

    Returns ButtonInput

rightShift

  • get rightShift(): ButtonInput

  • ButtonInput for the Right Shift key.

    Returns ButtonInput

s

semicolon

  • get semicolon(): ButtonInput

  • ButtonInput for the Semicolon ; key.

    Returns ButtonInput

slash

space

t

tab

typeName

  • get typeName(): string

  • Returns the name of this type. This can be used rather than instanceof which is sometimes unreliable.

    Returns string

u

up

v

w

x

y

z

Methods

activate

  • Start listening to keyboard events.

    Returns

    Returns false if the keyboard was already activated and nothing needed to be done. Otherwise returns true.

    Returns boolean

deactivate

  • Stop listening to keyboard events.

    Returns

    Returns false if the keyboard wasn't already activated and nothing needed to be done. Otherwise returns true.

    Returns boolean

finish

  • Calling this tells the Keyboard to deactivate itself and that it will no longer be used.

    Returns void

update

  • This method is intended to be called by a clock to provide regular updates. It should not be called by consumers of the library.

    Parameters

    • deltaMs: number

      How many milliseconds have passed since the last update cycle.

    Returns void

withRef

  • Provides a way for setting the ref through a chained function call. For example:

    clock.addChild(new Keyboard(new EventSubscriber(document)).withRef('keyboard'));

    Returns

    The calling object.

    Parameters

    • ref: string

      The ref to set on the object.

    Returns IClockChild

Settings

Member Visibility

Theme

Generated using TypeDoc