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

M2Node.pressedAndWithinHitArea

Source

M2Node.ts:132

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

M2Node.pressedInitialPointerOffset

Source

M2Node.ts:136

queuedAction?

optional queuedAction: Action

Inherited from

M2Node.queuedAction

Source

M2Node.ts:114

type

readonly type: Label = M2NodeType.Label

Overrides

M2Node.type

Source

Label.ts:26

userData

userData: any = {}

Inherited from

M2Node.userData

Source

M2Node.ts:120

uuid

Internal

readonly uuid: string

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

Implementation of

LabelOptions.uuid

Inherited from

M2Node.uuid

Source

M2Node.ts:116

withinHitArea

withinHitArea: boolean = false

Inherited from

M2Node.withinHitArea

Source

M2Node.ts:127

Accessors

alpha

get 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.

set alpha(alpha): void

Parameters

• alpha: number

Returns

number

Source

M2Node.ts:1383

ancestors

get ancestors(): M2Node[]

Returns all ancestor nodes, not including the node itself.

Returns

M2Node[]

Source

M2Node.ts:537

anchorPoint

get 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

set anchorPoint(anchorPoint): void

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

Parameters

• anchorPoint: Point

Returns

Point

Source

Label.ts:470

backgroundColor

get backgroundColor(): undefined | RgbaColor

Background color of label text. Default is no background color

set backgroundColor(backgroundColor): void

Background color of label text. Default is no background color

Parameters

• backgroundColor: undefined | RgbaColor

Returns

undefined | RgbaColor

Source

Label.ts:446

backgroundPaint

get private backgroundPaint(): Paint

set private backgroundPaint(backgroundPaint): void

Parameters

• backgroundPaint: Paint

Returns

Paint

Source

Label.ts:515

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

M2Node.ts:1277

completeNodeOptions

get completeNodeOptions(): object

Returns

object

alpha?

optional alpha: number

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

backgroundColor: undefined | RgbaColor

draggable?

optional draggable: boolean

Can the node be dragged?

fontColor?

optional fontColor: RgbaColor

Color of text. Default is Constants.DEFAULT_FONT_COLOR (WebColors.Black)

fontName?

optional fontName: string

Name of font to use for text. Must have been previously loaded

fontNames

fontNames: undefined | string[]

fontSize?

optional fontSize: number

Size of text. Default is Constants.DEFAULT_FONT_SIZE (16)

hidden?

optional hidden: boolean

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

horizontalAlignmentMode

horizontalAlignmentMode: LabelHorizontalAlignmentMode

interpolation?

optional interpolation: StringInterpolationMap

Map of placeholders to values for use in string interpolation during localization.

isUserInteractionEnabled?

optional isUserInteractionEnabled: boolean

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

layout?

optional layout: Layout

FOR INTERNAL USE ONLY

localize?

optional localize: boolean

If true, try to use a localized version of the text. Default is true.

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)

preferredMaxLayoutWidth

preferredMaxLayoutWidth: undefined | number

scale?

optional scale: number

Scale of the node. Default is 1.0

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.

text?

optional text: string

Text to be displayed

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

Label.ts:79

descendants

get descendants(): M2Node[]

Returns all descendant nodes.

Remarks

Descendants are children and children of children, recursively.

Returns

M2Node[]

Source

M2Node.ts:524

draggable

get draggable(): boolean

Can the node be dragged?

set draggable(draggable): void

Can the node be dragged?

Parameters

• draggable: boolean

Returns

boolean

Source

M2Node.ts:1419

fontColor

get fontColor(): RgbaColor

Color of text. Default is Constants.DEFAULT_FONT_COLOR (WebColors.Black)

set fontColor(fontColor): void

Color of text. Default is Constants.DEFAULT_FONT_COLOR (WebColors.Black)

Parameters

• fontColor: RgbaColor

Returns

RgbaColor

Source

Label.ts:390

fontName

get fontName(): undefined | string

Name of font to use for text. Must have been previously loaded

set fontName(fontName): void

Name of font to use for text. Must have been previously loaded

Parameters

• fontName: undefined | string

Returns

undefined | string

Source

Label.ts:366

fontNames

get fontNames(): undefined | string[]

Names of multiple fonts to use for text. For example, if a text font and an emoji font are to be used together. Must have been previously loaded

set fontNames(fontNames): void

Names of multiple fonts to use for text. For example, if a text font and an emoji font are to be used together. Must have been previously loaded

Parameters

• fontNames: undefined | string[]

Returns

undefined | string[]

Source

Label.ts:378

fontPaint

get private fontPaint(): Paint

set private fontPaint(fontPaint): void

Parameters

• fontPaint: Paint

Returns

Paint

Source

Label.ts:525

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

M2Node.ts:277

hidden

get hidden(): boolean

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

set hidden(hidden): void

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

Parameters

• hidden: boolean

Returns

boolean

Source

M2Node.ts:1408

horizontalAlignmentMode

get horizontalAlignmentMode(): LabelHorizontalAlignmentMode

Horizontal alignment of label text. see LabelHorizontalAlignmentMode. Default is LabelHorizontalAlignmentMode.center

set horizontalAlignmentMode(horizontalAlignmentMode): void

Horizontal alignment of label text. see LabelHorizontalAlignmentMode. Default is LabelHorizontalAlignmentMode.center

Parameters

• horizontalAlignmentMode: LabelHorizontalAlignmentMode

Returns

LabelHorizontalAlignmentMode

Source

Label.ts:414

interpolation

get interpolation(): StringInterpolationMap

Map of placeholders to values for use in string interpolation during localization.

set interpolation(interpolation): void

Map of placeholders to values for use in string interpolation during localization.

Parameters

• interpolation: StringInterpolationMap

Returns

StringInterpolationMap

Source

Label.ts:345

isUserInteractionEnabled

get isUserInteractionEnabled(): boolean

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

set isUserInteractionEnabled(isUserInteractionEnabled): void

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

Parameters

• isUserInteractionEnabled: boolean

Returns

boolean

Source

M2Node.ts:1394

localize

get localize(): boolean

If true, try to use a localized version of the text. Default is true.

set localize(localize): void

If true, try to use a localized version of the text. Default is true.

Parameters

• localize: boolean

Returns

boolean

Source

Label.ts:458

parentSceneAsNode

get parentSceneAsNode(): M2Node

Returns

M2Node

Source

M2Node.ts:1281

position

get position(): Point

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

set position(position): void

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

Parameters

• position: Point

Returns

Point

Source

M2Node.ts:1327

preferredMaxLayoutWidth

get preferredMaxLayoutWidth(): undefined | number

Maximum width of label text before wrapping occurs. Default is the canvas width

set preferredMaxLayoutWidth(preferredMaxLayoutWidth): void

Maximum width of label text before wrapping occurs. Default is the canvas width

Parameters

• preferredMaxLayoutWidth: undefined | number

Returns

undefined | number

Source

Label.ts:431

scale

get scale(): number

Scale of the node. Default is 1.0

set scale(scale): void

Scale of the node. Default is 1.0

Parameters

• scale: number

Returns

number

Source

M2Node.ts:1372

size

get size(): Size

set size(size): void

Parameters

• size: Size

Returns

Size

Source

M2Node.ts:1293

suppressEvents

get 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.

set suppressEvents(value): void

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.

Parameters

• value: boolean

Returns

boolean

Source

M2Node.ts:1430

text

get text(): string

Text to be displayed

set text(text): void

Text to be displayed

Parameters

• text: string

Returns

string

Source

Label.ts:333

zPosition

get zPosition(): number

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

set zPosition(zPosition): void

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

Parameters

• zPosition: number

Returns

number

Source

Label.ts:504

zRotation

get 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.

set zRotation(zRotation): void

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.

Parameters

• zRotation: number

Returns

number

Source

M2Node.ts:1361

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

M2Node.addChild

Source

M2Node.ts:346

addEventListener()

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

Type parameters

• T extends M2NodeEvent

Parameters

• type: string

• callback

• callbackOptions?: CallbackOptions

Returns

void

Inherited from

M2Node.addEventListener

Source

M2Node.ts:760

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

M2Node.descendant

Remarks

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

Source

M2Node.ts:507

dispose()

Internal

dispose(): void

Frees up resources allocated by the Drawable M2Node.

For m2c2kit library use only

Returns

void

Implementation of

IDrawable.dispose

Remarks

This will be done automatically by the m2c2kit library; the end-user must not call this.

Source

Label.ts:323

draw()

draw(canvas): void

Parameters

• canvas: Canvas

Returns

void

Implementation of

IDrawable.draw

Source

Label.ts:585

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

M2Node.drawChildren

Source

M2Node.ts:1153

duplicate()

duplicate(newName?): Label

Duplicates a node using deep copy.

Parameters

• newName?: string

optional name of the new, duplicated node. If not provided, name will be the new uuid

Returns

Label

Overrides

M2Node.duplicate

Remarks

This is a deep recursive clone (node and children). The uuid property of all duplicated nodes will be newly created, because uuid must be unique.

Source

Label.ts:545

getDrawableOptions()

protected getDrawableOptions(): DrawableOptions

Returns

DrawableOptions

Inherited from

M2Node.getDrawableOptions

Source

M2Node.ts:1231

getNodeOptions()

protected getNodeOptions(): M2NodeOptions

Returns

M2NodeOptions

Inherited from

M2Node.getNodeOptions

Source

M2Node.ts:1215

getRequiredLabelFonts()

private getRequiredLabelFonts(fontManager): M2Font[]

Determines the M2Font objects that need to be ready in order to draw the Label.

Parameters

• fontManager: FontManager

FontManager

Returns

M2Font[]

an array of M2Font objects that are required for the Label

Remarks

It needs a FontManager because it may need to look up the default font.

Source

Label.ts:296

getTextOptions()

protected getTextOptions(): TextOptions

Returns

TextOptions

Inherited from

M2Node.getTextOptions

Source

M2Node.ts:1244

initialize()

initialize(): void

Returns

void

Overrides

M2Node.initialize

Source

Label.ts:92

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

M2Node.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

M2Node.ts:562

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

M2Node.involvedInSceneTransition

Source

M2Node.ts:578

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

M2Node.onDrag

Source

M2Node.ts:740

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

M2Node.onDragEnd

Source

M2Node.ts:753

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

M2Node.onDragStart

Source

M2Node.ts:727

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

M2Node.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

M2Node.ts:668

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

M2Node.onPointerLeave

Source

M2Node.ts:714

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

M2Node.onPointerMove

Source

M2Node.ts:700

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

M2Node.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

M2Node.ts:686

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

M2Node.onTapDown

Remarks

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

Source

M2Node.ts:597

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

M2Node.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

M2Node.ts:652

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

M2Node.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

M2Node.ts:615

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

M2Node.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

M2Node.ts:634

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

M2Node.removeAction

Source

M2Node.ts:1189

removeAllActions()

removeAllActions(): void

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

Returns

void

Inherited from

M2Node.removeAllActions

Source

M2Node.ts:1197

removeAllChildren()

removeAllChildren(): void

Removes all children from the node.

Returns

void

Inherited from

M2Node.removeAllChildren

Source

M2Node.ts:448

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

M2Node.removeChild

Source

M2Node.ts:458

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

M2Node.removeChildren

Source

M2Node.ts:487

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

M2Node.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

M2Node.ts:1173

saveEvent()

protected saveEvent(event): void

Saves the node's event.

Parameters

• event: M2Event<M2Node>

event to save

Returns

void

Inherited from

M2Node.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

M2Node.ts:261

saveNodeNewEvent()

protected saveNodeNewEvent(): void

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

Returns

void

Inherited from

M2Node.saveNodeNewEvent

Source

M2Node.ts:207

savePropertyChangeEvent()

protected savePropertyChangeEvent(property, value): void

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

Parameters

• property: string

property name

property value

Returns

void

Inherited from

M2Node.savePropertyChangeEvent

Source

M2Node.ts:234

toString()

toString(): string

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

Returns

string

Inherited from

M2Node.toString

Remarks

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

Source

M2Node.ts:326

update()

update(): void

Returns

void

Overrides

M2Node.update

Source

Label.ts:567

warmup()

warmup(canvas): void

Parameters

• canvas: Canvas

Returns

void

Implementation of

IDrawable.warmup

Source

Label.ts:612

Extends​

Implements​

Constructors​

new Label()​

Parameters​

Returns​

Overrides​

Remarks​

Source​

Properties​

_alpha​

Inherited from​

Source​

_anchorPoint​

Source​

_backgroundColor?​

Source​

_backgroundPaint?​

Source​

_draggable​

Inherited from​

Source​

_fontColor​

Source​

_fontName​

Source​

_fontNames​

Source​

_fontPaint?​

Source​

_fontSize​

Source​

_game?​

Inherited from​

Source​

_hidden​

Inherited from​

Source​

_horizontalAlignmentMode​

Source​

_interpolation​

Source​

_isUserInteractionEnabled​

Inherited from​

Source​

_localize​

Source​

_position​

Inherited from​

Source​

_preferredMaxLayoutWidth​

Source​

_scale​

Inherited from​

Source​

_size​

Inherited from​

Source​

_text​

Source​

_zPosition​

Source​

_zRotation​

Inherited from​

Source​

absoluteAlpha​

Inherited from​

Source​

absoluteAlphaChange​

Inherited from​

Source​

absolutePosition​

Inherited from​

Source​

absoluteScale​

Inherited from​

Source​

actions​

Inherited from​

Source​

Extends

Implements

Constructors

new Label()

Parameters

Returns

Overrides

Remarks

Source

Properties

_alpha

Inherited from

Source

_anchorPoint

Source

_backgroundColor?

Source

_backgroundPaint?

Source

_draggable

Inherited from

Source

_fontColor

Source

_fontName

Source

_fontNames

Source

_fontPaint?

Source

_fontSize

Source

_game?

Inherited from

Source

_hidden

Inherited from

Source

_horizontalAlignmentMode

Source

_interpolation

Source

_isUserInteractionEnabled

Inherited from

Source

_localize

Source

_position

Inherited from

Source

_preferredMaxLayoutWidth

Source

_scale

Inherited from

Source

_size

Inherited from

Source

_text

Source

_zPosition

Source

_zRotation

Inherited from

Source

absoluteAlpha

Inherited from

Source

absoluteAlphaChange

Inherited from

Source

absolutePosition

Inherited from

Source

absoluteScale

Inherited from

Source

actions

Inherited from

Source