Class: Label

Extends

• M2Node

Implements

• IDrawable
• IText
• LabelOptions

Constructors

new Label()

new Label(options): Label

Single or multi-line text formatted and rendered on the screen.

Parameters

• options: LabelOptions = {}

LabelOptions

Returns

Label

Remarks

Label (in contrast to TextLine) has enhanced text support for line wrapping, centering/alignment, and background colors.

Overrides

M2Node.constructor

Defined in

m2c2kit/packages/core/src/Label.ts:97

Properties

_alpha

_alpha: number = 1.0

Inherited from

M2Node._alpha

Defined in

m2c2kit/packages/core/src/M2Node.ts:99

---

_draggable

protected _draggable: boolean = false

Inherited from

M2Node._draggable

Defined in

m2c2kit/packages/core/src/M2Node.ts:102

---

_game?

optional _game: Game

Inherited from

M2Node._game

Defined in

m2c2kit/packages/core/src/M2Node.ts:106

---

_hidden

protected _hidden: boolean = false

Inherited from

M2Node._hidden

Defined in

m2c2kit/packages/core/src/M2Node.ts:103

---

_isUserInteractionEnabled

protected _isUserInteractionEnabled: boolean = false

Inherited from

M2Node._isUserInteractionEnabled

Defined in

m2c2kit/packages/core/src/M2Node.ts:101

---

_position

_position: Point

Inherited from

M2Node._position

Defined in

m2c2kit/packages/core/src/M2Node.ts:97

---

_scale

_scale: number = 1.0

Inherited from

M2Node._scale

Defined in

m2c2kit/packages/core/src/M2Node.ts:98

---

_size

protected _size: Size

Inherited from

M2Node._size

Defined in

m2c2kit/packages/core/src/M2Node.ts:110

---

_zRotation

_zRotation: number = 0

Inherited from

M2Node._zRotation

Defined in

m2c2kit/packages/core/src/M2Node.ts:100

---

absoluteAlpha

absoluteAlpha: number = 1.0

Inherited from

M2Node.absoluteAlpha

Defined in

m2c2kit/packages/core/src/M2Node.ts:112

---

absoluteAlphaChange

absoluteAlphaChange: number = 0

Inherited from

M2Node.absoluteAlphaChange

Defined in

m2c2kit/packages/core/src/M2Node.ts:113

---

absolutePosition

absolutePosition: Point

Inherited from

M2Node.absolutePosition

Defined in

m2c2kit/packages/core/src/M2Node.ts:109

---

absoluteScale

absoluteScale: number = 1.0

Inherited from

M2Node.absoluteScale

Defined in

m2c2kit/packages/core/src/M2Node.ts:111

---

actions

actions: Action[]

Inherited from

M2Node.actions

Defined in

m2c2kit/packages/core/src/M2Node.ts:114

---

children

children: M2Node[]

Inherited from

M2Node.children

Defined in

m2c2kit/packages/core/src/M2Node.ts:108

---

constructionIso8601TimeStamp

constructionIso8601TimeStamp: string

Inherited from

M2Node.constructionIso8601TimeStamp

Defined in

m2c2kit/packages/core/src/M2Node.ts:93

---

constructionSequence

constructionSequence: number

Inherited from

M2Node.constructionSequence

Defined in

m2c2kit/packages/core/src/M2Node.ts:94

---

constructionTimeStamp

constructionTimeStamp: number

Inherited from

M2Node.constructionTimeStamp

Defined in

m2c2kit/packages/core/src/M2Node.ts:92

---

dragging

dragging: boolean = false

Is the node in a dragging state?

Inherited from

M2Node.dragging

Defined in

m2c2kit/packages/core/src/M2Node.ts:142

---

draggingLastPointerOffset

draggingLastPointerOffset: Point

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

Inherited from

M2Node.draggingLastPointerOffset

Defined in

m2c2kit/packages/core/src/M2Node.ts:140

---

eventListeners

eventListeners: M2NodeEventListener<M2NodeEvent>[]

Inherited from

M2Node.eventListeners

Defined in

m2c2kit/packages/core/src/M2Node.ts:116

---

isDrawable

isDrawable: boolean = true

Overrides

M2Node.isDrawable

Defined in

m2c2kit/packages/core/src/Label.ts:58

---

isShape

isShape: boolean = false

Inherited from

M2Node.isShape

Defined in

m2c2kit/packages/core/src/M2Node.ts:88

---

isText

isText: boolean = true

Overrides

M2Node.isText

Defined in

m2c2kit/packages/core/src/Label.ts:59

---

layout

layout: Layout = {}

FOR INTERNAL USE ONLY

Implementation of

LabelOptions.layout

Inherited from

M2Node.layout

Defined in

m2c2kit/packages/core/src/M2Node.ts:104

---

loopMessages

loopMessages: Set<string>

Inherited from

M2Node.loopMessages

Defined in

m2c2kit/packages/core/src/M2Node.ts:122

---

name

name: string

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

Implementation of

LabelOptions.name

Inherited from

M2Node.name

Defined in

m2c2kit/packages/core/src/M2Node.ts:96

---

needsInitialization

needsInitialization: boolean = true

Inherited from

M2Node.needsInitialization

Defined in

m2c2kit/packages/core/src/M2Node.ts:118

---

nodeEvents

nodeEvents: M2Event<M2Node>[]

Inherited from

M2Node.nodeEvents

Defined in

m2c2kit/packages/core/src/M2Node.ts:123

---

options

options: M2NodeOptions

Inherited from

M2Node.options

Defined in

m2c2kit/packages/core/src/M2Node.ts:91

---

parent?

optional parent: M2Node

Inherited from

M2Node.parent

Defined in

m2c2kit/packages/core/src/M2Node.ts:107

---

pressed

pressed: boolean = false

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

M2Node.pressed

Defined in

m2c2kit/packages/core/src/M2Node.ts:127

---

pressedAndWithinHitArea

pressedAndWithinHitArea: boolean = false

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:133

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:137

---

queuedAction?

optional queuedAction: Action

Inherited from

M2Node.queuedAction

Defined in

m2c2kit/packages/core/src/M2Node.ts:115

---

type

readonly type: Label = M2NodeType.Label

Overrides

M2Node.type

Defined in

m2c2kit/packages/core/src/Label.ts:57

---

userData

userData: any = {}

Inherited from

M2Node.userData

Defined in

m2c2kit/packages/core/src/M2Node.ts:121

---

uuid

readonly uuid: string

Internal

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

Implementation of

LabelOptions.uuid

Inherited from

M2Node.uuid

Defined in

m2c2kit/packages/core/src/M2Node.ts:117

---

withinHitArea

withinHitArea: boolean = false

Inherited from

M2Node.withinHitArea

Defined in

m2c2kit/packages/core/src/M2Node.ts:128

Accessors

alpha

Get Signature

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.

Returns

number

Set Signature

set alpha(alpha): void

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.

Parameters

• alpha: number

Returns

void

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.

Implementation of

LabelOptions.alpha

Inherited from

M2Node.alpha

Defined in

m2c2kit/packages/core/src/M2Node.ts:1386

---

ancestors

Get Signature

get ancestors(): M2Node[]

Returns all ancestor nodes, not including the node itself.

Returns

M2Node[]

Inherited from

M2Node.ancestors

Defined in

m2c2kit/packages/core/src/M2Node.ts:538

---

anchorPoint

Get Signature

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

Returns

Point

Set Signature

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

void

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

Implementation of

LabelOptions.anchorPoint

Defined in

m2c2kit/packages/core/src/Label.ts:811

---

backgroundColor

Get Signature

get backgroundColor(): undefined | RgbaColor

Background color of label text. Default is no background color

Returns

undefined | RgbaColor

Set Signature

set backgroundColor(backgroundColor): void

Background color of label text. Default is no background color

Parameters

• backgroundColor: undefined | RgbaColor

Returns

void

Background color of label text. Default is no background color

Implementation of

LabelOptions.backgroundColor

Defined in

m2c2kit/packages/core/src/Label.ts:787

---

canvasKit

Get Signature

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

Inherited from

M2Node.canvasKit

Defined in

m2c2kit/packages/core/src/M2Node.ts:1278

---

completeNodeOptions

Get Signature

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

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?

optional uuid: string

Internal

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.

Overrides

M2Node.completeNodeOptions

Defined in

m2c2kit/packages/core/src/Label.ts:115

---

descendants

Get Signature

get descendants(): M2Node[]

Returns all descendant nodes.

Remarks

Descendants are children and children of children, recursively.

Returns

M2Node[]

Inherited from

M2Node.descendants

Defined in

m2c2kit/packages/core/src/M2Node.ts:525

---

draggable

Get Signature

get draggable(): boolean

Can the node be dragged?

Returns

boolean

Set Signature

set draggable(draggable): void

Can the node be dragged?

Parameters

• draggable: boolean

Returns

void

Can the node be dragged?

Implementation of

LabelOptions.draggable

Inherited from

M2Node.draggable

Defined in

m2c2kit/packages/core/src/M2Node.ts:1422

---

fontColor

Get Signature

get fontColor(): RgbaColor

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

Returns

RgbaColor

Set Signature

set fontColor(fontColor): void

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

Parameters

• fontColor: RgbaColor

Returns

void

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

Implementation of

LabelOptions.fontColor

Defined in

m2c2kit/packages/core/src/Label.ts:731

---

fontName

Get Signature

get fontName(): undefined | string

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

Returns

undefined | string

Set Signature

set fontName(fontName): void

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

Parameters

• fontName: undefined | string

Returns

void

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

Implementation of

LabelOptions.fontName

Defined in

m2c2kit/packages/core/src/Label.ts:707

---

fontNames

Get Signature

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

Returns

undefined | string[]

Set Signature

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

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

Implementation of

LabelOptions.fontNames

Defined in

m2c2kit/packages/core/src/Label.ts:719

---

fontSize

Get Signature

get fontSize(): number

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

Returns

number

Set Signature

set fontSize(fontSize): void

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

Parameters

• fontSize: number

Returns

void

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

Implementation of

LabelOptions.fontSize

Defined in

m2c2kit/packages/core/src/Label.ts:743

---

game

Get Signature

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

Inherited from

M2Node.game

Defined in

m2c2kit/packages/core/src/M2Node.ts:278

---

hidden

Get Signature

get hidden(): boolean

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

Returns

boolean

Set Signature

set hidden(hidden): void

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

Parameters

• hidden: boolean

Returns

void

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

Implementation of

LabelOptions.hidden

Inherited from

M2Node.hidden

Defined in

m2c2kit/packages/core/src/M2Node.ts:1411

---

horizontalAlignmentMode

Get Signature

get horizontalAlignmentMode(): LabelHorizontalAlignmentMode

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

Returns

LabelHorizontalAlignmentMode

Set Signature

set horizontalAlignmentMode(horizontalAlignmentMode): void

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

Parameters

• horizontalAlignmentMode: LabelHorizontalAlignmentMode

Returns

void

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

Implementation of

LabelOptions.horizontalAlignmentMode

Defined in

m2c2kit/packages/core/src/Label.ts:755

---

interpolation

Get Signature

get interpolation(): StringInterpolationMap

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

Returns

StringInterpolationMap

Set Signature

set interpolation(interpolation): void

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

Parameters

• interpolation: StringInterpolationMap

Returns

void

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

Implementation of

LabelOptions.interpolation

Defined in

m2c2kit/packages/core/src/Label.ts:686

---

isUserInteractionEnabled

Get Signature

get isUserInteractionEnabled(): boolean

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

Returns

boolean

Set Signature

set isUserInteractionEnabled(isUserInteractionEnabled): void

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

Parameters

• isUserInteractionEnabled: boolean

Returns

void

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

Implementation of

LabelOptions.isUserInteractionEnabled

Inherited from

M2Node.isUserInteractionEnabled

Defined in

m2c2kit/packages/core/src/M2Node.ts:1397

---

localize

Get Signature

get localize(): boolean

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

Returns

boolean

Set Signature

set localize(localize): void

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

Parameters

• localize: boolean

Returns

void

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

Implementation of

LabelOptions.localize

Defined in

m2c2kit/packages/core/src/Label.ts:799

---

parentSceneAsNode

Get Signature

get parentSceneAsNode(): M2Node

Returns

M2Node

Inherited from

M2Node.parentSceneAsNode

Defined in

m2c2kit/packages/core/src/M2Node.ts:1282

---

position

Get Signature

get position(): Point

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

Returns

Point

Set Signature

set position(position): void

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

Parameters

• position: Point

Returns

void

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

Implementation of

LabelOptions.position

Inherited from

M2Node.position

Defined in

m2c2kit/packages/core/src/M2Node.ts:1330

---

preferredMaxLayoutWidth

Get Signature

get preferredMaxLayoutWidth(): undefined | number

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

Returns

undefined | number

Set Signature

set preferredMaxLayoutWidth(preferredMaxLayoutWidth): void

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

Parameters

• preferredMaxLayoutWidth: undefined | number

Returns

void

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

Implementation of

LabelOptions.preferredMaxLayoutWidth

Defined in

m2c2kit/packages/core/src/Label.ts:772

---

scale

Get Signature

get scale(): number

Scale of the node. Default is 1.0

Returns

number

Set Signature

set scale(scale): void

Scale of the node. Default is 1.0

Parameters

• scale: number

Returns

void

Scale of the node. Default is 1.0

Implementation of

LabelOptions.scale

Inherited from

M2Node.scale

Defined in

m2c2kit/packages/core/src/M2Node.ts:1375

---

size

Get Signature

get size(): Size

Returns

Size

Set Signature

set size(size): void

Parameters

• size: Size

Returns

void

Inherited from

M2Node.size

Defined in

m2c2kit/packages/core/src/M2Node.ts:1296

---

suppressEvents

Get Signature

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.

Returns

boolean

Set Signature

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

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.

Implementation of

LabelOptions.suppressEvents

Inherited from

M2Node.suppressEvents

Defined in

m2c2kit/packages/core/src/M2Node.ts:1433

---

text

Get Signature

get text(): string

Text to be displayed. When operating with localization, text within double square brackets will be replaced with the value of the key in the translation. For example, if the text is The translated word is [[RED]], [[RED]] will be replaced with the translation. If no localization is used, or a translation for the key is missing, then the text will be rendered as is. Tags for bold (b), italic (i), underline (u), overline(o), and strikethrough (s) are supported, e.g., <b><u>Bold and underline</u></b>. Note that while bold and italic and be combined, only one of underline, overline, and strikethrough can be used on a text segment.

Returns

string

Set Signature

set text(text): void

Text to be displayed. When operating with localization, text within double square brackets will be replaced with the value of the key in the translation. For example, if the text is The translated word is [[RED]], [[RED]] will be replaced with the translation. If no localization is used, or a translation for the key is missing, then the text will be rendered as is. Tags for bold (b), italic (i), underline (u), overline(o), and strikethrough (s) are supported, e.g., <b><u>Bold and underline</u></b>. Note that while bold and italic and be combined, only one of underline, overline, and strikethrough can be used on a text segment.

Parameters

• text: string

Returns

void

Text to be displayed. When operating with localization, text within double square brackets will be replaced with the value of the key in the translation. For example, if the text is The translated word is [[RED]], [[RED]] will be replaced with the translation. If no localization is used, or a translation for the key is missing, then the text will be rendered as is. Tags for bold (b), italic (i), underline (u), overline(o), and strikethrough (s) are supported, e.g., <b><u>Bold and underline</u></b>. Note that while bold and italic and be combined, only one of underline, overline, and strikethrough can be used on a text segment.

Implementation of

LabelOptions.text

Defined in

m2c2kit/packages/core/src/Label.ts:674

---

zPosition

Get Signature

get zPosition(): number

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

Returns

number

Set Signature

set zPosition(zPosition): void

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

Parameters

• zPosition: number

Returns

void

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

Implementation of

LabelOptions.zPosition

Defined in

m2c2kit/packages/core/src/Label.ts:845

---

zRotation

Get Signature

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.

Returns

number

Set Signature

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

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.

Implementation of

LabelOptions.zRotation

Inherited from

M2Node.zRotation

Defined in

m2c2kit/packages/core/src/M2Node.ts:1364

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:347

---

addEventListener()

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

Type Parameters

• T extends M2NodeEvent

Parameters

• type: string

• callback

• callbackOptions?: CallbackOptions

Returns

void

Inherited from

M2Node.addEventListener

Defined in

m2c2kit/packages/core/src/M2Node.ts:761

---

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

Remarks

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

Inherited from

M2Node.descendant

Defined in

m2c2kit/packages/core/src/M2Node.ts:508

---

dispose()

dispose(): void

Internal

Frees up resources allocated by the Drawable M2Node.

For m2c2kit library use only

Returns

void

Remarks

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

Implementation of

IDrawable.dispose

Defined in

m2c2kit/packages/core/src/Label.ts:664

---

draw()

draw(canvas): void

Parameters

• canvas: Canvas

Returns

void

Implementation of

IDrawable.draw

Defined in

m2c2kit/packages/core/src/Label.ts:926

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:1154

---

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

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.

Overrides

M2Node.duplicate

Defined in

m2c2kit/packages/core/src/Label.ts:886

---

getDrawableOptions()

protected getDrawableOptions(): DrawableOptions

Returns

DrawableOptions

Inherited from

M2Node.getDrawableOptions

Defined in

m2c2kit/packages/core/src/M2Node.ts:1232

---

getNodeOptions()

protected getNodeOptions(): M2NodeOptions

Returns

M2NodeOptions

Inherited from

M2Node.getNodeOptions

Defined in

m2c2kit/packages/core/src/M2Node.ts:1216

---

getTextOptions()

protected getTextOptions(): TextOptions

Returns

TextOptions

Inherited from

M2Node.getTextOptions

Defined in

m2c2kit/packages/core/src/M2Node.ts:1245

---

initialize()

initialize(): void

Returns

void

Overrides

M2Node.initialize

Defined in

m2c2kit/packages/core/src/Label.ts:128

---

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

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.

Inherited from

M2Node.involvedInActionAffectingAppearance

Defined in

m2c2kit/packages/core/src/M2Node.ts:563

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:579

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:741

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:754

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:728

---

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

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.

Inherited from

M2Node.onPointerDown

Defined in

m2c2kit/packages/core/src/M2Node.ts:669

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:715

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:701

---

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

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.

Inherited from

M2Node.onPointerUp

Defined in

m2c2kit/packages/core/src/M2Node.ts:687

---

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

Remarks

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

Inherited from

M2Node.onTapDown

Defined in

m2c2kit/packages/core/src/M2Node.ts:598

---

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

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.

Inherited from

M2Node.onTapLeave

Defined in

m2c2kit/packages/core/src/M2Node.ts:653

---

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

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.

Inherited from

M2Node.onTapUp

Defined in

m2c2kit/packages/core/src/M2Node.ts:616

---

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

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.

Inherited from

M2Node.onTapUpAny

Defined in

m2c2kit/packages/core/src/M2Node.ts:635

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:1190

---

removeAllActions()

removeAllActions(): void

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

Returns

void

Inherited from

M2Node.removeAllActions

Defined in

m2c2kit/packages/core/src/M2Node.ts:1198

---

removeAllChildren()

removeAllChildren(): void

Removes all children from the node.

Returns

void

Inherited from

M2Node.removeAllChildren

Defined in

m2c2kit/packages/core/src/M2Node.ts:449

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:459

---

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

Defined in

m2c2kit/packages/core/src/M2Node.ts:488

---

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

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.

Inherited from

M2Node.run

Defined in

m2c2kit/packages/core/src/M2Node.ts:1174

---

saveEvent()

protected saveEvent(event): void

Saves the node's event.

Parameters

• event: M2Event<M2Node>

event to save

Returns

void

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.

Inherited from

M2Node.saveEvent

Defined in

m2c2kit/packages/core/src/M2Node.ts:262

---

saveNodeNewEvent()

protected saveNodeNewEvent(): void

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

Returns

void

Inherited from

M2Node.saveNodeNewEvent

Defined in

m2c2kit/packages/core/src/M2Node.ts:208

---

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

M2Node.savePropertyChangeEvent

Defined in

m2c2kit/packages/core/src/M2Node.ts:235

---

toString()

toString(): string

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

Returns

string

Remarks

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

Inherited from

M2Node.toString

Defined in

m2c2kit/packages/core/src/M2Node.ts:327

---

update()

update(): void

Returns

void

Overrides

M2Node.update

Defined in

m2c2kit/packages/core/src/Label.ts:908

---

warmup()

warmup(canvas): void

Parameters

• canvas: Canvas

Returns

void

Implementation of

IDrawable.warmup

Defined in

m2c2kit/packages/core/src/Label.ts:954