Class: VirtualKeyboard

Extends

• Composite

Constructors

new VirtualKeyboard()

new VirtualKeyboard(options): VirtualKeyboard

An on-screen keyboard that can be used to enter text.

Parameters

• options: VirtualKeyboardOptions

VirtualKeyboardOptions

Returns

VirtualKeyboard

Overrides

Composite.constructor

Source

addons/src/composites/virtual-keyboard.ts:187

Properties

_alpha

_alpha: number

Inherited from

Composite._alpha

Source

core/dist/index.d.ts:2538

---

_draggable

protected _draggable: boolean

Inherited from

Composite._draggable

Source

core/dist/index.d.ts:2541

---

_game?

optional _game: Game

Inherited from

Composite._game

Source

core/dist/index.d.ts:2544

---

_hidden

protected _hidden: boolean

Inherited from

Composite._hidden

Source

core/dist/index.d.ts:2542

---

_isUserInteractionEnabled

protected _isUserInteractionEnabled: boolean

Inherited from

Composite._isUserInteractionEnabled

Source

core/dist/index.d.ts:2540

---

_position

_position: Point

Inherited from

Composite._position

Source

core/dist/index.d.ts:2536

---

_scale

_scale: number

Inherited from

Composite._scale

Source

core/dist/index.d.ts:2537

---

_size

protected _size: Size

Inherited from

Composite._size

Source

core/dist/index.d.ts:2548

---

_zRotation

_zRotation: number

Inherited from

Composite._zRotation

Source

core/dist/index.d.ts:2539

---

absoluteAlpha

absoluteAlpha: number

Inherited from

Composite.absoluteAlpha

Source

core/dist/index.d.ts:2550

---

absoluteAlphaChange

absoluteAlphaChange: number

Inherited from

Composite.absoluteAlphaChange

Source

core/dist/index.d.ts:2551

---

absolutePosition

absolutePosition: Point

Inherited from

Composite.absolutePosition

Source

core/dist/index.d.ts:2547

---

absoluteScale

absoluteScale: number

Inherited from

Composite.absoluteScale

Source

core/dist/index.d.ts:2549

---

actions

actions: Action[]

Inherited from

Composite.actions

Source

core/dist/index.d.ts:2552

---

backgroundColor

private backgroundColor: RgbaColor

Source

addons/src/composites/virtual-keyboard.ts:171

---

capitalLettersOnly

private capitalLettersOnly: boolean

Source

addons/src/composites/virtual-keyboard.ts:167

---

children

children: M2Node[]

Inherited from

Composite.children

Source

core/dist/index.d.ts:2546

---

compositeType

readonly compositeType: "VirtualKeyboard" = "VirtualKeyboard"

Overrides

Composite.compositeType

Source

addons/src/composites/virtual-keyboard.ts:157

---

constructionIso8601TimeStamp

constructionIso8601TimeStamp: string

Inherited from

Composite.constructionIso8601TimeStamp

Source

core/dist/index.d.ts:2533

---

constructionSequence

constructionSequence: number

Inherited from

Composite.constructionSequence

Source

core/dist/index.d.ts:2534

---

constructionTimeStamp

constructionTimeStamp: number

Inherited from

Composite.constructionTimeStamp

Source

core/dist/index.d.ts:2532

---

dragging

dragging: boolean

Is the node in a dragging state?

Inherited from

Composite.dragging

Source

core/dist/index.d.ts:2577

---

draggingLastPointerOffset

draggingLastPointerOffset: Point

What was the previous pointer offset when the node was in a dragging state?

Inherited from

Composite.draggingLastPointerOffset

Source

core/dist/index.d.ts:2575

---

eventListeners

eventListeners: M2NodeEventListener<M2NodeEvent>[]

Inherited from

Composite.eventListeners

Source

core/dist/index.d.ts:2554

---

fontNames

private fontNames: undefined | string[]

Source

addons/src/composites/virtual-keyboard.ts:165

---

fontSize

private fontSize: number

Source

addons/src/composites/virtual-keyboard.ts:164

---

hiddenKeys

private hiddenKeys: string

Source

addons/src/composites/virtual-keyboard.ts:166

---

isDrawable

isDrawable: boolean

Inherited from

Composite.isDrawable

Source

core/dist/index.d.ts:124

---

isShape

isShape: boolean

Inherited from

Composite.isShape

Source

core/dist/index.d.ts:2528

---

isText

isText: boolean

Inherited from

Composite.isText

Source

core/dist/index.d.ts:2529

---

keyColor

private keyColor: RgbaColor

Source

addons/src/composites/virtual-keyboard.ts:168

---

keyDownColor

private keyDownColor: RgbaColor

Source

addons/src/composites/virtual-keyboard.ts:169

---

keyHorizontalPaddingPercent

private keyHorizontalPaddingPercent: number

Source

addons/src/composites/virtual-keyboard.ts:160

---

keyLabels

private keyLabels: Label[]

Source

addons/src/composites/virtual-keyboard.ts:177

---

keyShapes

private keyShapes: Shape[]

Source

addons/src/composites/virtual-keyboard.ts:176

---

keyVerticalPaddingPercent

private keyVerticalPaddingPercent: number

Source

addons/src/composites/virtual-keyboard.ts:161

---

keyboardHorizontalPaddingPercent

private keyboardHorizontalPaddingPercent: number

Source

addons/src/composites/virtual-keyboard.ts:158

---

keyboardRows

private keyboardRows: InternalKeyboardRow[]

Source

addons/src/composites/virtual-keyboard.ts:162

---

keyboardVerticalPaddingPercent

private keyboardVerticalPaddingPercent: number

Source

addons/src/composites/virtual-keyboard.ts:159

---

keysPerRow

private keysPerRow: number

Source

addons/src/composites/virtual-keyboard.ts:163

---

layout

layout: Layout

Inherited from

Composite.layout

Source

core/dist/index.d.ts:2543

---

letterCircle?

private optional letterCircle: Shape

Source

addons/src/composites/virtual-keyboard.ts:179

---

letterCircleLabel?

private optional letterCircleLabel: Label

Source

addons/src/composites/virtual-keyboard.ts:180

---

loopMessages

loopMessages: Set<string>

Inherited from

Composite.loopMessages

Source

core/dist/index.d.ts:2558

---

name

name: string

Inherited from

Composite.name

Source

core/dist/index.d.ts:2535

---

needsInitialization

needsInitialization: boolean

Inherited from

Composite.needsInitialization

Source

core/dist/index.d.ts:2556

---

nodeEvents

nodeEvents: M2Event<M2Node>[]

Inherited from

Composite.nodeEvents

Source

core/dist/index.d.ts:2559

---

options

options: M2NodeOptions

Inherited from

Composite.options

Source

core/dist/index.d.ts:2531

---

originalOptions

private originalOptions: VirtualKeyboardOptions

Source

addons/src/composites/virtual-keyboard.ts:173

---

parent?

optional parent: M2Node

Inherited from

Composite.parent

Source

core/dist/index.d.ts:2545

---

pressed

pressed: boolean

Is the node in a pressed state? E.g., did the user put the pointer down on the node and not yet release it?

Inherited from

Composite.pressed

Source

core/dist/index.d.ts:2562

---

pressedAndWithinHitArea

pressedAndWithinHitArea: boolean

Is the node in a pressed state AND is the pointer within the node's hit area? For example, a user may put the pointer down on the node, but then move the pointer, while still down, beyond the node's hit area. In this case, pressed = true, but pressedAndWithinHitArea = false.

Inherited from

Composite.pressedAndWithinHitArea

Source

core/dist/index.d.ts:2568

---

pressedInitialPointerOffset

pressedInitialPointerOffset: Point

When the node initially enters the pressed state, what is the pointer offset? (offset from the canvas's origin to the pointer position). We save this because it will be needed if this press then led to a drag.

Inherited from

Composite.pressedInitialPointerOffset

Source

core/dist/index.d.ts:2572

---

queuedAction?

optional queuedAction: Action

Inherited from

Composite.queuedAction

Source

core/dist/index.d.ts:2553

---

shiftActivated

private shiftActivated: boolean = false

Source

addons/src/composites/virtual-keyboard.ts:175

---

showKeyDownPreview

private showKeyDownPreview: boolean

Source

addons/src/composites/virtual-keyboard.ts:172

---

specialKeyDownColor

private specialKeyDownColor: RgbaColor

Source

addons/src/composites/virtual-keyboard.ts:170

---

toString()

toString: () => string

Overrides toString() and returns a human-friendly description of the node.

Remarks

Inspiration from https://stackoverflow.com/a/35361695

Returns

string

Inherited from

Composite.toString

Source

core/dist/index.d.ts:2619

---

type

readonly type: Composite = M2NodeType.Composite

Inherited from

Composite.type

Source

core/dist/index.d.ts:122

---

userData

userData: any

Inherited from

Composite.userData

Source

core/dist/index.d.ts:2557

---

uuid

readonly uuid: string

Inherited from

Composite.uuid

Source

core/dist/index.d.ts:2555

---

withinHitArea

withinHitArea: boolean

Inherited from

Composite.withinHitArea

Source

core/dist/index.d.ts:2563

Accessors

alpha

get alpha(): number

set alpha(alpha): void

Parameters

• alpha: number

Returns

number

Source

core/dist/index.d.ts:2876

---

ancestors

get ancestors(): M2Node[]

Returns all ancestor nodes, not including the node itself.

Returns

M2Node[]

Source

core/dist/index.d.ts:2674

---

anchorPoint

get anchorPoint(): Point

set anchorPoint(anchorPoint): void

Parameters

• anchorPoint: Point

Returns

Point

Source

core/dist/index.d.ts:134

---

canvasKit

get canvasKit(): CanvasKit

Gets the scene that contains this node by searching up the ancestor tree recursively. Throws exception if node is not part of a scene.

Returns

CanvasKit

Scene that contains this node

Source

core/dist/index.d.ts:2866

---

completeNodeOptions

get completeNodeOptions(): object

Returns

object

alpha?

optional alpha: number

Opacity of the node. 0 is fully transparent, 1 is fully opaque. Default is 1.0. Alpha has multiplicative inheritance. For example, if the node's parent is alpha .5 and this node's is alpha .4, then the node will appear with alpha .2.

anchorPoint?

optional anchorPoint: Point

Point within the node that determines its position. Default is { x: 0.5, y: 0.5 }, which centers the node on its position

backgroundColor?

optional backgroundColor: RgbaColor

Background color of keyboard.

capitalLettersOnly?

optional capitalLettersOnly: boolean

If true, only capital letters will be shown.

draggable?

optional draggable: boolean

Can the node be dragged?

fontNames?

optional fontNames: string[]

The fonts for the key labels, if not the default font.

fontSize?

optional fontSize: number

Size of font for keys.

hidden?

optional hidden: boolean

Is the node, and its children, hidden? (not displayed). Default is false

hiddenKeys?

optional hiddenKeys: string

Comma-separated list of keys to hide.

isUserInteractionEnabled?

optional isUserInteractionEnabled: boolean

Does the node respond to user events, such as taps? Default is false

keyColor?

optional keyColor: RgbaColor

Color of keys.

keyDownColor?

optional keyDownColor: RgbaColor

Color of keys when pressed.

keyHorizontalPaddingPercent?

optional keyHorizontalPaddingPercent: number

Percent of each key's width that should be used for padding on the left and right sides. Default is .10

keyVerticalPaddingPercent?

optional keyVerticalPaddingPercent: number

Percent of each key's height that should be used for padding on the top and bottom sides. Default is .10

keyboardHorizontalPaddingPercent?

optional keyboardHorizontalPaddingPercent: number

Percent of the keyboard width that should be used for padding on the left and right sides. Default is .02

keyboardVerticalPaddingPercent?

optional keyboardVerticalPaddingPercent: number

Percent of the keyboard height that should be used for padding on the top and bottom sides. Default is .025

keysPerRow?

optional keysPerRow: number

How many regular-sized keys should fit in a row? This is used for scaling purposes. If not provided, it will be inferred from the row configuration.

layout?

optional layout: Layout

FOR INTERNAL USE ONLY

name?

optional name: string

Name of the node. Only needed if the node will be referred to by name in a later function

position?

optional position: Point

Position of the node within its parent coordinate system. Default is (0, 0)

rows?

optional rows: VirtualKeyboardRow[]

Configuration of keyboard rows. Order is from top to bottom rows.

scale?

optional scale: number

Scale of the node. Default is 1.0

showKeyDownPreview?

optional showKeyDownPreview: boolean

If true, a preview of the key that will be pressed will be shown.

size

size: Size

specialKeyDownColor?

optional specialKeyDownColor: RgbaColor

Color of special keys when pressed.

suppressEvents?

optional suppressEvents: boolean

Should the node not emit events to the EventStore? Default is false.

Remarks

This property is for use by authors of Composite nodes. It is not intended for general use.

uuid?

Internal

optional uuid: string

Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only

zPosition?

optional zPosition: number

Value along the z-axis to determine drawing and tap order. Larger values are on top.

zRotation?

optional zRotation: number

Rotation of the node around the Z axis. Unit is radians. Default is 0 (no rotation). zRotation has inheritance. In addition to this node's zRotation, all ancestors' zRotations will be applied.

Source

addons/src/composites/virtual-keyboard.ts:244

---

descendants

get descendants(): M2Node[]

Returns all descendant nodes.

Remarks

Descendants are children and children of children, recursively.

Returns

M2Node[]

Source

core/dist/index.d.ts:2670

---

draggable

get draggable(): boolean

set draggable(draggable): void

Parameters

• draggable: boolean

Returns

boolean

Source

core/dist/index.d.ts:2882

---

game

get game(): Game

The game which this node is a part of.

Remarks

Throws error if node is not part of the game object.

Returns

Game

Source

core/dist/index.d.ts:2607

---

hidden

get hidden(): boolean

set hidden(hidden): void

Parameters

• hidden: boolean

Returns

boolean

Source

core/dist/index.d.ts:2880

---

isUserInteractionEnabled

get isUserInteractionEnabled(): boolean

Does the VirtualKeyboard respond to user events? Default is true.

set isUserInteractionEnabled(isUserInteractionEnabled): void

Does the VirtualKeyboard respond to user events? Default is true.

Parameters

• isUserInteractionEnabled: boolean

Returns

boolean

Source

addons/src/composites/virtual-keyboard.ts:1008

---

parentSceneAsNode

get parentSceneAsNode(): M2Node

Returns

M2Node

Source

core/dist/index.d.ts:2867

---

position

get position(): Point

set position(position): void

Parameters

• position: Point

Returns

Point

Source

core/dist/index.d.ts:2870

---

scale

get scale(): number

set scale(scale): void

Parameters

• scale: number

Returns

number

Source

core/dist/index.d.ts:2874

---

size

get size(): Size

set size(size): void

Parameters

• size: Size

Returns

Size

Source

core/dist/index.d.ts:2868

---

suppressEvents

get suppressEvents(): boolean

set suppressEvents(value): void

Parameters

• value: boolean

Returns

boolean

Source

core/dist/index.d.ts:2884

---

zPosition

get zPosition(): number

set zPosition(zPosition): void

Parameters

• zPosition: number

Returns

number

Source

core/dist/index.d.ts:136

---

zRotation

get zRotation(): number

set zRotation(zRotation): void

Parameters

• zRotation: number

Returns

number

Source

core/dist/index.d.ts:2872

Methods

addChild()

addChild(child): void

Adds a child to this parent node. Throws exception if the child's name is not unique with respect to other children of this parent, or if the child has already been added to another parent.

Parameters

• child: M2Node

The child node to add

Returns

void

Inherited from

Composite.addChild

Source

core/dist/index.d.ts:2627

---

addEventListener()

addEventListener<T>(type, callback, callbackOptions?): void

Type parameters

• T extends M2NodeEvent

Parameters

• type: string

• callback

• callbackOptions?: CallbackOptions

Returns

void

Inherited from

Composite.addEventListener

Source

core/dist/index.d.ts:2799

---

addVirtualKeyboardEventListener()

private addVirtualKeyboardEventListener(eventListener, options?): void

Parameters

• eventListener: M2NodeEventListener<VirtualKeyboardEvent>

• options?: CallbackOptions

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:988

---

createDefaultKeyboardRows()

private createDefaultKeyboardRows(): InternalKeyboardRow[]

Returns

InternalKeyboardRow[]

Source

addons/src/composites/virtual-keyboard.ts:901

---

descendant()

descendant<T>(name): T

Searches all descendants by name and returns first matching node.

Type parameters

• T extends M2Node

Parameters

• name: string

Name of the descendant node to return

Returns

T

Inherited from

Composite.descendant

Remarks

Descendants are children and children of children, recursively. Throws exception if no descendant with the given name is found.

Source

core/dist/index.d.ts:2664

---

dispose()

dispose(): void

Returns

void

Inherited from

Composite.dispose

Source

core/dist/index.d.ts:138

---

draw()

draw(canvas): void

Parameters

• canvas: Canvas

Returns

void

Overrides

Composite.draw

Source

addons/src/composites/virtual-keyboard.ts:498

---

drawChildren()

drawChildren(canvas): void

Draws each child node that is Drawable and is not hidden, by zPosition order (highest zPosition on top).

Parameters

• canvas: Canvas

CanvasKit canvas

Returns

void

Inherited from

Composite.drawChildren

Source

core/dist/index.d.ts:2821

---

duplicate()

duplicate(newName?): M2Node

Parameters

• newName?: string

Returns

M2Node

Overrides

Composite.duplicate

Source

addons/src/composites/virtual-keyboard.ts:511

---

getDrawableOptions()

protected getDrawableOptions(): DrawableOptions

Returns

DrawableOptions

Inherited from

Composite.getDrawableOptions

Source

core/dist/index.d.ts:2859

---

getKeyAsString()

private getKeyAsString(key): string

Parameters

• key: KeyConfigurationWithShape

Returns

string

Source

addons/src/composites/virtual-keyboard.ts:632

---

getNodeOptions()

protected getNodeOptions(): M2NodeOptions

Returns

M2NodeOptions

Inherited from

Composite.getNodeOptions

Source

core/dist/index.d.ts:2858

---

getTextOptions()

protected getTextOptions(): TextOptions

Returns

TextOptions

Inherited from

Composite.getTextOptions

Source

core/dist/index.d.ts:2860

---

handleCompositeEvent()

handleCompositeEvent(event): void

Parameters

• event: VirtualKeyboardEvent

Returns

void

Overrides

Composite.handleCompositeEvent

Source

addons/src/composites/virtual-keyboard.ts:699

---

handleKeyDownEvent()

private handleKeyDownEvent(event, keyboard, keyShape): void

Parameters

• event: VirtualKeyboardEvent

• keyboard: InternalKeyboardConfiguration

• keyShape: Shape

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:731

---

handleKeyLeaveEvent()

private handleKeyLeaveEvent(event, keyboard, keyShape): void

Parameters

• event: VirtualKeyboardEvent

• keyboard: InternalKeyboardConfiguration

• keyShape: Shape

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:817

---

handleKeyShapeTapDown()

private handleKeyShapeTapDown(key, keyShape, tapEvent): void

Parameters

• key: KeyConfigurationWithShape

• keyShape: Shape

• tapEvent: TapEvent

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:515

---

handleKeyShapeTapLeave()

private handleKeyShapeTapLeave(key, keyShape, tapEvent): void

Parameters

• key: KeyConfigurationWithShape

• keyShape: Shape

• tapEvent: TapEvent

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:594

---

handleKeyShapeTapUp()

private handleKeyShapeTapUp(key, keyShape, tapEvent): void

Parameters

• key: KeyConfigurationWithShape

• keyShape: Shape

• tapEvent: TapEvent

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:556

---

handleKeyUpEvent()

private handleKeyUpEvent(event, keyboard, keyShape): void

Parameters

• event: VirtualKeyboardEvent

• keyboard: InternalKeyboardConfiguration

• keyShape: Shape

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:775

---

initialize()

initialize(): void

Returns

void

Overrides

Composite.initialize

Source

addons/src/composites/virtual-keyboard.ts:253

---

internalKeyboardRowsToInternalKeyboardConfiguration()

private internalKeyboardRowsToInternalKeyboardConfiguration(keyboardRows): InternalKeyboardConfiguration

Converts the keyboard rows to the internal keyboard configuration.

Parameters

• keyboardRows: InternalKeyboardRow[]

Returns

InternalKeyboardConfiguration

the keyboard for internal use

Remarks

This normalizes the keyboard rows so that each key is a full KeyConfigurationWithShape object, instead of a string or array of strings.

Source

addons/src/composites/virtual-keyboard.ts:654

---

involvedInActionAffectingAppearance()

involvedInActionAffectingAppearance(): boolean

Determines if this node or ancestor is part of an active action that affects it appearance.

Returns

boolean

true if part of active action affecting appearance

Inherited from

Composite.involvedInActionAffectingAppearance

Remarks

This is used to determine if the node should be rendered with anti-aliasing or not. Anti-aliasing on some devices causes a new shader to be compiled during the action, which causes jank.

Source

core/dist/index.d.ts:2685

---

involvedInSceneTransition()

involvedInSceneTransition(): boolean

Determines if the node is a transitioning Scene or a descendant of a transitioning Scene.

Returns

boolean

true if transitioning

Inherited from

Composite.involvedInSceneTransition

Source

core/dist/index.d.ts:2692

---

onDrag()

onDrag(callback, options?): void

Executes a callback when the user continues dragging a node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onDrag

Source

core/dist/index.d.ts:2791

---

onDragEnd()

onDragEnd(callback, options?): void

Executes a callback when the user stop dragging a node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onDragEnd

Source

core/dist/index.d.ts:2798

---

onDragStart()

onDragStart(callback, options?): void

Executes a callback when the user begins dragging a node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onDragStart

Source

core/dist/index.d.ts:2784

---

onKeyDown()

onKeyDown(callback, options?): void

Executes a callback when the user presses down on a key.

Parameters

• callback

function to execute

• options?: CallbackOptions

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:431

---

onKeyLeave()

onKeyLeave(callback, options?): void

Executes a callback when the user has pressed a key with the pointer, but moves the pointer outside the key bounds before releasing the pointer.

Parameters

• callback

function to execute

• options?: CallbackOptions

Returns

void

Remarks

Typically, this event will not be used, since it is a user's inaccurate interaction with the keyboard. However, it can be used to provide feedback to the user that they have moved the pointer outside the key bounds, and thus the key stroke will not be registered.

Source

addons/src/composites/virtual-keyboard.ts:479

---

onKeyUp()

onKeyUp(callback, options?): void

Executes a callback when the user releases a key.

Parameters

• callback

function to execute

• options?: CallbackOptions

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:452

---

onPointerDown()

onPointerDown(callback, options?): void

Executes a callback when the pointer first is down on the node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onPointerDown

Remarks

PointerDown is a pointer down (mouse click or touches begin) within the bounds of the node. It occurs under the same conditions as TapDown.

Source

core/dist/index.d.ts:2749

---

onPointerLeave()

onPointerLeave(callback, options?): void

Executes a callback when the user moves the pointer (mouse or touches) outside the bounds of the node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onPointerLeave

Source

core/dist/index.d.ts:2777

---

onPointerMove()

onPointerMove(callback, options?): void

Executes a callback when the user moves the pointer (mouse or touches) within the bounds of the node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onPointerMove

Source

core/dist/index.d.ts:2769

---

onPointerUp()

onPointerUp(callback, options?): void

Executes a callback when the user releases a press from the node within the bounds of the node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onPointerUp

Remarks

PointerUp is a pointer up (mouse click release or touches end) within the bounds of the node. It does not require that there was a previous PointerDown on the node.

Source

core/dist/index.d.ts:2761

---

onTapDown()

onTapDown(callback, options?): void

Executes a callback when the user presses down on the node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onTapDown

Remarks

TapDown is a pointer down (mouse click or touches begin) within the bounds of the node.

Source

core/dist/index.d.ts:2702

---

onTapLeave()

onTapLeave(callback, options?): void

Executes a callback when the user moves the pointer (mouse, touches) beyond the bounds of the node while the pointer is down.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onTapLeave

Remarks

TapLeave occurs when the pointer (mouse, touches) that has previously pressed the node moves beyond the bounds of the node before the press release.

Source

core/dist/index.d.ts:2739

---

onTapUp()

onTapUp(callback, options?): void

Executes a callback when the user releases a press, that has been fully within the node, from the node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptionsue.

Returns

void

Inherited from

Composite.onTapUp

Remarks

TapUp is a pointer up (mouse click release or touches end) within the bounds of the node and the pointer, while down, has never moved beyond the bounds of the node.

Source

core/dist/index.d.ts:2714

---

onTapUpAny()

onTapUpAny(callback, options?): void

Executes a callback when the user releases a press from the node within the bounds of the node.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Composite.onTapUpAny

Remarks

TapUpAny is a pointer up (mouse click release or touches end) within the bounds of the node and the pointer, while down, is allowed to have been beyond the bounds of the node during the press before the release.

Source

core/dist/index.d.ts:2727

---

removeAction()

removeAction(key): void

Remove an action from this node. If the action is running, it will be stopped.

Parameters

• key: string

key (string identifier) of the action to remove

Returns

void

Inherited from

Composite.removeAction

Source

core/dist/index.d.ts:2841

---

removeAllActions()

removeAllActions(): void

Remove all actions from this node. If actions are running, they will be stopped.

Returns

void

Inherited from

Composite.removeAllActions

Source

core/dist/index.d.ts:2846

---

removeAllChildren()

removeAllChildren(): void

Removes all children from the node.

Returns

void

Inherited from

Composite.removeAllChildren

Source

core/dist/index.d.ts:2640

---

removeChild()

removeChild(child): void

Removes the specific child from this parent node. Throws exception if this parent does not contain the child.

Parameters

• child: M2Node

Returns

void

Inherited from

Composite.removeChild

Source

core/dist/index.d.ts:2647

---

removeChildren()

removeChildren(children): void

Removes the children from the parent. Throws error if the parent does not contain all of the children.

Parameters

• children: M2Node[]

An array of children to remove from the parent node

Returns

void

Inherited from

Composite.removeChildren

Source

core/dist/index.d.ts:2654

---

run()

run(action, key?): void

Runs an action on this node.

Parameters

• action: Action

The action to run

• key?: string

key (string identifier) used to identify the action. Only needed if the action will be referred to later

Returns

void

Inherited from

Composite.run

Remarks

If the node is part of an active scene, the action runs immediately. Otherwise, the action will run when the node's scene becomes active. Calling run() multiple times on a node will add to existing actions, not replace them.

Source

core/dist/index.d.ts:2834

---

saveEvent()

protected saveEvent(event): void

Saves the node's event.

Parameters

• event: M2Event<M2Node>

event to save

Returns

void

Inherited from

Composite.saveEvent

Remarks

If the game event store is not available, the event is saved within the node's nodeEvents event array. It will be added to the game event store when the node is added to the game.

Source

core/dist/index.d.ts:2601

---

saveNodeNewEvent()

protected saveNodeNewEvent(): void

Save the node's construction event in the event store.

Returns

void

Inherited from

Composite.saveNodeNewEvent

Source

core/dist/index.d.ts:2584

---

savePropertyChangeEvent()

protected savePropertyChangeEvent(property, value): void

Saves the node's property change event in the event store.

Parameters

• property: string

property name

• value: undefined | null | string | number | boolean | object

property value

Returns

void

Inherited from

Composite.savePropertyChangeEvent

Source

core/dist/index.d.ts:2591

---

showKeyboardNotShifted()

private showKeyboardNotShifted(keyboard): void

Parameters

• keyboard: InternalKeyboardConfiguration

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:870

---

showKeyboardShifted()

private showKeyboardShifted(keyboard): void

Parameters

• keyboard: InternalKeyboardConfiguration

Returns

void

Source

addons/src/composites/virtual-keyboard.ts:839

---

update()

update(): void

Returns

void

Overrides

Composite.update

Source

addons/src/composites/virtual-keyboard.ts:494

---

warmup()

warmup(canvas): void

Parameters

• canvas: Canvas

Returns

void

Overrides

Composite.warmup

Source

addons/src/composites/virtual-keyboard.ts:502