Class: CountdownTimer

Extends

• Composite

Implements

• CountdownTimerOptions

Constructors

new CountdownTimer()

new CountdownTimer(options): CountdownTimer

A countdown timer displays a number that counts down to zero.

Parameters

• options: CountdownTimerOptions

Returns

CountdownTimer

Overrides

Composite.constructor

Source

addons/src/composites/countdown-timer.ts:92

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

---

_fontColor

private _fontColor: RgbaColor = WebColors.White

Source

addons/src/composites/countdown-timer.ts:72

---

_fontName

private _fontName: undefined | string

Source

addons/src/composites/countdown-timer.ts:70

---

_fontSize

private _fontSize: number = 50

Source

addons/src/composites/countdown-timer.ts:71

---

_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

---

_isRunning

private _isRunning: boolean = false

Source

addons/src/composites/countdown-timer.ts:84

---

_isUserInteractionEnabled

protected _isUserInteractionEnabled: boolean

Inherited from

Composite._isUserInteractionEnabled

Source

core/dist/index.d.ts:2540

---

_milliseconds

private _milliseconds: number = 3000

Source

addons/src/composites/countdown-timer.ts:68

---

_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

---

_textVerticalBias

private _textVerticalBias: number = 0.5

Source

addons/src/composites/countdown-timer.ts:80

---

_tickIntervalMilliseconds

private _tickIntervalMilliseconds: number = 1000

Source

addons/src/composites/countdown-timer.ts:69

---

_timerShape

private _timerShape: TimerShape

Source

addons/src/composites/countdown-timer.ts:74

---

_zRotation

_zRotation: number

Inherited from

Composite._zRotation

Source

core/dist/index.d.ts:2539

---

_zeroString

private _zeroString: string = "0"

Source

addons/src/composites/countdown-timer.ts:73

---

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

---

children

children: M2Node[]

Inherited from

Composite.children

Source

core/dist/index.d.ts:2546

---

compositeType

readonly compositeType: "CountdownTimer" = "CountdownTimer"

Overrides

Composite.compositeType

Source

addons/src/composites/countdown-timer.ts:66

---

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

---

countdownSequence

private countdownSequence: Action[]

Source

addons/src/composites/countdown-timer.ts:81

---

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

---

hasStopped

private hasStopped: boolean = false

Source

addons/src/composites/countdown-timer.ts:85

---

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

---

layout

layout: Layout

FOR INTERNAL USE ONLY

Implementation of

CountdownTimerOptions.layout

Inherited from

Composite.layout

Source

core/dist/index.d.ts:2543

---

loopMessages

loopMessages: Set<string>

Inherited from

Composite.loopMessages

Source

core/dist/index.d.ts:2558

---

name

name: string

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

Implementation of

CountdownTimerOptions.name

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: CountdownTimerOptions

Source

addons/src/composites/countdown-timer.ts:67

---

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

---

timerNumberLabel?

private optional timerNumberLabel: Label

Source

addons/src/composites/countdown-timer.ts:83

---

timerShapeNode?

private optional timerShapeNode: Shape

Source

addons/src/composites/countdown-timer.ts:82

---

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

Internal

readonly uuid: string

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

Implementation of

CountdownTimerOptions.uuid

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

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

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

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

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

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

draggable?

optional draggable: boolean

Can the node be dragged?

fontColor?

optional fontColor: RgbaColor

Font size for timer text (numbers). Default is white.

fontName?

optional fontName: string

Font name for timer text (numbers).

fontSize?

optional fontSize: number

Font size for timer text (numbers). Default is 50.

hidden?

optional hidden: boolean

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

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

milliseconds?

optional milliseconds: number

Duration of the countdown, in milliseconds. Must be multiple of 1000. Default is 3000.

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)

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.

textVerticalBias?

optional textVerticalBias: number

Default is to center the timer text (numbers) vertically within the timer shape (verticalBias = .5). Setting verticalBias less than .5 will pull the text towards the top of the timer shape. Setting verticalBias greater than .5 will pull the text towards the bottom of the timer shape.

tickIntervalMilliseconds?

optional tickIntervalMilliseconds: number

Duration of each tick interval, in milliseconds. Default is 1000.

timerShape?

optional timerShape: TimerShape

Shape of the timer. Default is a Royal Blue circle with a radius of 100.

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.

zeroString?

optional zeroString: string

String to show when the timer reaches zero. Default is "0". This could be changed to another value, such as "GO!"

Source

addons/src/composites/countdown-timer.ts:130

---

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

Can the node be dragged?

set draggable(draggable): void

Can the node be dragged?

Parameters

• draggable: boolean

Returns

boolean

Source

core/dist/index.d.ts:2882

---

fontColor

get fontColor(): RgbaColor

Font size for timer text (numbers). Default is white.

set fontColor(fontColor): void

Font size for timer text (numbers). Default is white.

Parameters

• fontColor: RgbaColor

Returns

RgbaColor

Source

addons/src/composites/countdown-timer.ts:454

---

fontName

get fontName(): undefined | string

Font name for timer text (numbers).

set fontName(fontName): void

Font name for timer text (numbers).

Parameters

• fontName: undefined | string

Returns

undefined | string

Source

addons/src/composites/countdown-timer.ts:466

---

fontSize

get fontSize(): number

Font size for timer text (numbers). Default is 50.

set fontSize(fontSize): void

Font size for timer text (numbers). Default is 50.

Parameters

• fontSize: number

Returns

number

Source

addons/src/composites/countdown-timer.ts:478

---

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

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

core/dist/index.d.ts:2880

---

isRunning

get isRunning(): boolean

Returns true if the countdown timer is running.

Returns

boolean

Source

addons/src/composites/countdown-timer.ts:337

---

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

core/dist/index.d.ts:2878

---

milliseconds

get milliseconds(): number

Duration of the countdown, in milliseconds. Must be multiple of 1000. Default is 3000.

set milliseconds(milliseconds): void

Duration of the countdown, in milliseconds. Must be multiple of 1000. Default is 3000.

Parameters

• milliseconds: number

Returns

number

Source

addons/src/composites/countdown-timer.ts:427

---

parentSceneAsNode

get parentSceneAsNode(): M2Node

Returns

M2Node

Source

core/dist/index.d.ts:2867

---

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

core/dist/index.d.ts:2870

---

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

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

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

core/dist/index.d.ts:2884

---

textVerticalBias

get textVerticalBias(): number

Default is to center the timer text (numbers) vertically within the timer shape (verticalBias = .5). Setting verticalBias less than .5 will pull the text towards the top of the timer shape. Setting verticalBias greater than .5 will pull the text towards the bottom of the timer shape.

set textVerticalBias(textVerticalBias): void

Default is to center the timer text (numbers) vertically within the timer shape (verticalBias = .5). Setting verticalBias less than .5 will pull the text towards the top of the timer shape. Setting verticalBias greater than .5 will pull the text towards the bottom of the timer shape.

Parameters

• textVerticalBias: number

Returns

number

Source

addons/src/composites/countdown-timer.ts:514

---

tickIntervalMilliseconds

get tickIntervalMilliseconds(): number

Duration of each tick interval, in milliseconds. Default is 1000.

set tickIntervalMilliseconds(tickIntervalMilliseconds): void

Duration of each tick interval, in milliseconds. Default is 1000.

Parameters

• tickIntervalMilliseconds: number

Returns

number

Source

addons/src/composites/countdown-timer.ts:439

---

timerShape

get timerShape(): TimerShape

Shape of the timer. Default is a Royal Blue circle with a radius of 100.

set timerShape(shape): void

Shape of the timer. Default is a Royal Blue circle with a radius of 100.

Parameters

• shape: TimerShape

Returns

TimerShape

Source

addons/src/composites/countdown-timer.ts:502

---

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

core/dist/index.d.ts:136

---

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

core/dist/index.d.ts:2872

---

zeroString

get zeroString(): string

String to show when the timer reaches zero. Default is "0". This could be changed to another value, such as "GO!"

set zeroString(zeroString): void

String to show when the timer reaches zero. Default is "0". This could be changed to another value, such as "GO!"

Parameters

• zeroString: string

Returns

string

Source

addons/src/composites/countdown-timer.ts:490

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

---

addCountdownTimerEventListener()

private addCountdownTimerEventListener(eventListener, options?): void

Parameters

• eventListener: M2NodeEventListener<CountdownTimerEvent>

• options?: CallbackOptions

Returns

void

Source

addons/src/composites/countdown-timer.ts:410

---

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

---

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/countdown-timer.ts:544

---

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?): CountdownTimer

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

CountdownTimer

Overrides

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

addons/src/composites/countdown-timer.ts:536

---

getDrawableOptions()

protected getDrawableOptions(): DrawableOptions

Returns

DrawableOptions

Inherited from

Composite.getDrawableOptions

Source

core/dist/index.d.ts:2859

---

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: CountdownTimerEvent

Returns

void

Overrides

Composite.handleCompositeEvent

Source

addons/src/composites/countdown-timer.ts:341

---

initialize()

initialize(): void

Returns

void

Overrides

Composite.initialize

Source

addons/src/composites/countdown-timer.ts:139

---

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

---

onComplete()

onComplete(callback, options?): void

Executes a callback when the timer completes.

Parameters

• callback

function to execute.

• options?: CallbackOptions

Returns

void

Remarks

This is the last tick of the timer.

Source

addons/src/composites/countdown-timer.ts:395

---

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

---

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

---

onTick()

onTick(callback, options?): void

Executes a callback when the timer ticks.

Parameters

• callback

function to execute

• options?: CallbackOptions

Returns

void

Remarks

The callback is also executed when the timer completes.

Source

addons/src/composites/countdown-timer.ts:372

---

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

---

reset()

reset(): void

Resets the countdown timer to its initial state so it can be started again.

Returns

void

Remarks

This method is idempotent. Calling reset() multiple times will not raise an error. This can be called on a CountdownTimer in any state.

Source

addons/src/composites/countdown-timer.ts:329

---

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

---

start()

start(): void

Starts the countdown timer.

Returns

void

Remarks

Calling start() on a timer whose state is running (already started) or stopped will raise an error.

Source

addons/src/composites/countdown-timer.ts:284

---

stop()

stop(): void

Stops the countdown timer.

Returns

void

Remarks

This method is idempotent. Calling stop() on a stopped timer has no effect and will not raise an error. This can be called on a CountdownTimer in any state.

Source

addons/src/composites/countdown-timer.ts:314

---

tick()

private tick(millisecondsRemaining): void

Parameters

• millisecondsRemaining: number

Returns

void

Source

addons/src/composites/countdown-timer.ts:252

---

update()

update(): void

Returns

void

Overrides

Composite.update

Source

addons/src/composites/countdown-timer.ts:540

---

warmup()

warmup(canvas): void

Parameters

• canvas: Canvas

Returns

void

Overrides

Composite.warmup

Source

addons/src/composites/countdown-timer.ts:548