Class: CountdownScene

Extends

• Scene

Constructors

new CountdownScene()

new CountdownScene(options): CountdownScene

A scene that counts down from a specified number to zero, then transitions to the next scene.

Parameters

• options: CountdownSceneOptions

CountdownSceneOptions

Returns

CountdownScene

Overrides

Scene.constructor

Source

addons/src/scenes/countdown-scene.ts:57

Properties

_active

_active: boolean

Inherited from

Scene._active

Source

core/dist/index.d.ts:410

---

_alpha

_alpha: number

Inherited from

Scene._alpha

Source

core/dist/index.d.ts:2538

---

_draggable

protected _draggable: boolean

Inherited from

Scene._draggable

Source

core/dist/index.d.ts:2541

---

_game?

optional _game: Game

Inherited from

Scene._game

Source

core/dist/index.d.ts:2544

---

_hidden

protected _hidden: boolean

Inherited from

Scene._hidden

Source

core/dist/index.d.ts:2542

---

_isUserInteractionEnabled

protected _isUserInteractionEnabled: boolean

Inherited from

Scene._isUserInteractionEnabled

Source

core/dist/index.d.ts:2540

---

_position

_position: Point

Inherited from

Scene._position

Source

core/dist/index.d.ts:2536

---

_scale

_scale: number

Inherited from

Scene._scale

Source

core/dist/index.d.ts:2537

---

_size

protected _size: Size

Inherited from

Scene._size

Source

core/dist/index.d.ts:2548

---

_transitioning

_transitioning: boolean

Inherited from

Scene._transitioning

Source

core/dist/index.d.ts:411

---

_zRotation

_zRotation: number

Inherited from

Scene._zRotation

Source

core/dist/index.d.ts:2539

---

absoluteAlpha

absoluteAlpha: number

Inherited from

Scene.absoluteAlpha

Source

core/dist/index.d.ts:2550

---

absoluteAlphaChange

absoluteAlphaChange: number

Inherited from

Scene.absoluteAlphaChange

Source

core/dist/index.d.ts:2551

---

absolutePosition

absolutePosition: Point

Inherited from

Scene.absolutePosition

Source

core/dist/index.d.ts:2547

---

absoluteScale

absoluteScale: number

Inherited from

Scene.absoluteScale

Source

core/dist/index.d.ts:2549

---

actions

actions: Action[]

Inherited from

Scene.actions

Source

core/dist/index.d.ts:2552

---

children

children: M2Node[]

Inherited from

Scene.children

Source

core/dist/index.d.ts:2546

---

constructionIso8601TimeStamp

constructionIso8601TimeStamp: string

Inherited from

Scene.constructionIso8601TimeStamp

Source

core/dist/index.d.ts:2533

---

constructionSequence

constructionSequence: number

Inherited from

Scene.constructionSequence

Source

core/dist/index.d.ts:2534

---

constructionTimeStamp

constructionTimeStamp: number

Inherited from

Scene.constructionTimeStamp

Source

core/dist/index.d.ts:2532

---

dragging

dragging: boolean

Is the node in a dragging state?

Inherited from

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

Scene.draggingLastPointerOffset

Source

core/dist/index.d.ts:2575

---

eventListeners

eventListeners: M2NodeEventListener<M2NodeEvent>[]

Inherited from

Scene.eventListeners

Source

core/dist/index.d.ts:2554

---

isDrawable

isDrawable: boolean

Inherited from

Scene.isDrawable

Source

core/dist/index.d.ts:406

---

isShape

isShape: boolean

Inherited from

Scene.isShape

Source

core/dist/index.d.ts:2528

---

isText

isText: boolean

Inherited from

Scene.isText

Source

core/dist/index.d.ts:2529

---

layout

layout: Layout

Inherited from

Scene.layout

Source

core/dist/index.d.ts:2543

---

loopMessages

loopMessages: Set<string>

Inherited from

Scene.loopMessages

Source

core/dist/index.d.ts:2558

---

name

name: string

Inherited from

Scene.name

Source

core/dist/index.d.ts:2535

---

needsInitialization

needsInitialization: boolean

Inherited from

Scene.needsInitialization

Source

core/dist/index.d.ts:2556

---

nodeEvents

nodeEvents: M2Event<M2Node>[]

Inherited from

Scene.nodeEvents

Source

core/dist/index.d.ts:2559

---

options

options: M2NodeOptions

Inherited from

Scene.options

Source

core/dist/index.d.ts:2531

---

parent?

optional parent: M2Node

Inherited from

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

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

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

Scene.pressedInitialPointerOffset

Source

core/dist/index.d.ts:2572

---

queuedAction?

optional queuedAction: Action

Inherited from

Scene.queuedAction

Source

core/dist/index.d.ts:2553

---

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

Scene.toString

Source

core/dist/index.d.ts:2619

---

type

readonly type: Scene = M2NodeType.Scene

Inherited from

Scene.type

Source

core/dist/index.d.ts:405

---

userData

userData: any

Inherited from

Scene.userData

Source

core/dist/index.d.ts:2557

---

uuid

readonly uuid: string

Inherited from

Scene.uuid

Source

core/dist/index.d.ts:2555

---

withinHitArea

withinHitArea: boolean

Inherited from

Scene.withinHitArea

Source

core/dist/index.d.ts:2563

Accessors

alpha

get alpha(): number

set alpha(alpha): void

Parameters

• alpha: number

Returns

number

Source

core/dist/index.d.ts:2876

---

ancestors

get ancestors(): M2Node[]

Returns all ancestor nodes, not including the node itself.

Returns

M2Node[]

Source

core/dist/index.d.ts:2674

---

anchorPoint

get anchorPoint(): Point

set anchorPoint(anchorPoint): void

Parameters

• anchorPoint: Point

Returns

Point

Source

core/dist/index.d.ts:448

---

backgroundColor

get backgroundColor(): RgbaColor

set backgroundColor(backgroundColor): void

Parameters

• backgroundColor: RgbaColor

Returns

RgbaColor

Source

core/dist/index.d.ts:446

---

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

anchorPoint?

optional anchorPoint: Point

backgroundColor

backgroundColor: RgbaColor

draggable?

optional draggable: boolean

hidden?

optional hidden: boolean

isUserInteractionEnabled?

optional isUserInteractionEnabled: boolean

layout?

optional layout: Layout

name?

optional name: string

position?

optional position: Point

scale?

optional scale: number

suppressEvents?

optional suppressEvents: boolean

uuid?

optional uuid: string

zPosition?

optional zPosition: number

zRotation?

optional zRotation: number

Source

core/dist/index.d.ts:421

---

descendants

get descendants(): M2Node[]

Returns all descendant nodes.

Remarks

Descendants are children and children of children, recursively.

Returns

M2Node[]

Source

core/dist/index.d.ts:2670

---

draggable

get draggable(): boolean

set draggable(draggable): void

Parameters

• draggable: boolean

Returns

boolean

Source

core/dist/index.d.ts:2882

---

game

get game(): Game

The game which this scene is a part of.

Remarks

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

set game(game): void

Parameters

• game: Game

Returns

Game

Source

core/dist/index.d.ts:445

---

hidden

get hidden(): boolean

set hidden(hidden): void

Parameters

• hidden: boolean

Returns

boolean

Source

core/dist/index.d.ts:2880

---

isUserInteractionEnabled

get isUserInteractionEnabled(): boolean

set isUserInteractionEnabled(isUserInteractionEnabled): void

Parameters

• isUserInteractionEnabled: boolean

Returns

boolean

Source

core/dist/index.d.ts:2878

---

parentSceneAsNode

get parentSceneAsNode(): M2Node

Returns

M2Node

Source

core/dist/index.d.ts:2867

---

position

get position(): Point

set position(position): void

Parameters

• position: Point

Returns

Point

Source

core/dist/index.d.ts:2870

---

scale

get scale(): number

set scale(scale): void

Parameters

• scale: number

Returns

number

Source

core/dist/index.d.ts:2874

---

size

get size(): Size

set size(size): void

Parameters

• size: Size

Returns

Size

Source

core/dist/index.d.ts:2868

---

suppressEvents

get suppressEvents(): boolean

set suppressEvents(value): void

Parameters

• value: boolean

Returns

boolean

Source

core/dist/index.d.ts:2884

---

zPosition

get zPosition(): number

set zPosition(zPosition): void

Parameters

• zPosition: number

Returns

number

Source

core/dist/index.d.ts:450

---

zRotation

get zRotation(): number

set zRotation(zRotation): void

Parameters

• zRotation: number

Returns

number

Source

core/dist/index.d.ts:2872

Methods

addChild()

addChild(child): void

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

Parameters

• child: M2Node

The child node to add

Returns

void

Inherited from

Scene.addChild

Source

core/dist/index.d.ts:2627

---

addEventListener()

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

Type parameters

• T extends M2NodeEvent

Parameters

• type: string

• callback

• callbackOptions?: CallbackOptions

Returns

void

Inherited from

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

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

Scene.dispose

Source

core/dist/index.d.ts:438

---

draw()

draw(canvas): void

Parameters

• canvas: Canvas

Returns

void

Inherited from

Scene.draw

Source

core/dist/index.d.ts:487

---

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

Scene.drawChildren

Source

core/dist/index.d.ts:2821

---

duplicate()

duplicate(newName?): Scene

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

Scene

Inherited from

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

core/dist/index.d.ts:462

---

getDrawableOptions()

protected getDrawableOptions(): DrawableOptions

Returns

DrawableOptions

Inherited from

Scene.getDrawableOptions

Source

core/dist/index.d.ts:2859

---

getNodeOptions()

protected getNodeOptions(): M2NodeOptions

Returns

M2NodeOptions

Inherited from

Scene.getNodeOptions

Source

core/dist/index.d.ts:2858

---

getTextOptions()

protected getTextOptions(): TextOptions

Returns

TextOptions

Inherited from

Scene.getTextOptions

Source

core/dist/index.d.ts:2860

---

initialize()

initialize(): void

Returns

void

Inherited from

Scene.initialize

Source

core/dist/index.d.ts:437

---

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

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

Scene.involvedInSceneTransition

Source

core/dist/index.d.ts:2692

---

onAppear()

onAppear(callback, options?): void

Code that will be called after the scene has finished any transitions and has fully appeared on the screen.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Scene.onAppear

Source

core/dist/index.d.ts:485

---

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

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

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

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

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

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

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

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

---

onSetup()

onSetup(callback, options?): void

Code that will be called every time the scene is presented.

Parameters

• callback

function to execute

• options?: CallbackOptions

CallbackOptions

Returns

void

Inherited from

Scene.onSetup

Remarks

Use this callback to set nodes to their initial state, if that state might be changed later. For example, if a scene allows players to place dots on a grid, the setup() method should ensure the grid is clear of any prior dots from previous times this scene may have been displayed. In addition, if nodes should vary in each iteration, that should be done here.

Source

core/dist/index.d.ts:476

---

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

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

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

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

Scene.onTapUpAny

Remarks

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

Source

core/dist/index.d.ts:2727

---

removeAction()

removeAction(key): void

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

Parameters

• key: string

key (string identifier) of the action to remove

Returns

void

Inherited from

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

Scene.removeAllActions

Source

core/dist/index.d.ts:2846

---

removeAllChildren()

removeAllChildren(): void

Removes all children from the node.

Returns

void

Inherited from

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

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

Scene.removeChildren

Source

core/dist/index.d.ts:2654

---

run()

run(action, key?): void

Runs an action on this node.

Parameters

• action: Action

The action to run

• key?: string

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

Returns

void

Inherited from

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

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

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

Scene.savePropertyChangeEvent

Source

core/dist/index.d.ts:2591

---

update()

update(): void

Returns

void

Inherited from

Scene.update

Source

core/dist/index.d.ts:486

---

warmup()

warmup(canvas): void

Parameters

• canvas: Canvas

Returns

void

Inherited from

Scene.warmup

Source

core/dist/index.d.ts:488