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
Returns
Overrides
Scene.constructor
Defined in
m2c2kit/packages/addons/src/scenes/countdown-scene.ts:58
Properties
_active
_active:
boolean
Inherited from
Scene._active
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:452
_alpha
_alpha:
number
Inherited from
Scene._alpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3093
_draggable
protected_draggable:boolean
Inherited from
Scene._draggable
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3096
_game?
optional_game:Game
Inherited from
Scene._game
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3099
_hidden
protected_hidden:boolean
Inherited from
Scene._hidden
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3097
_isUserInteractionEnabled
protected_isUserInteractionEnabled:boolean
Inherited from
Scene._isUserInteractionEnabled
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3095
_position
_position:
Point
Inherited from
Scene._position
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3091
_scale
_scale:
number
Inherited from
Scene._scale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3092
_size
protected_size:Size
Inherited from
Scene._size
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3103
_transitioning
_transitioning:
boolean
Inherited from
Scene._transitioning
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:453
_zRotation
_zRotation:
number
Inherited from
Scene._zRotation
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3094
absoluteAlpha
absoluteAlpha:
number
Inherited from
Scene.absoluteAlpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3105
absoluteAlphaChange
absoluteAlphaChange:
number
Inherited from
Scene.absoluteAlphaChange
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3106
absolutePosition
absolutePosition:
Point
Inherited from
Scene.absolutePosition
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3102
absoluteScale
absoluteScale:
number
Inherited from
Scene.absoluteScale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3104
actions
actions:
Action[]
Inherited from
Scene.actions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3107
children
children:
M2Node[]
Inherited from
Scene.children
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3101
constructionIso8601TimeStamp
constructionIso8601TimeStamp:
string
Inherited from
Scene.constructionIso8601TimeStamp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3088
constructionSequence
constructionSequence:
number
Inherited from
Scene.constructionSequence
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3089
constructionTimeStamp
constructionTimeStamp:
number
Inherited from
Scene.constructionTimeStamp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3087
dragging
dragging:
boolean
Is the node in a dragging state?
Inherited from
Scene.dragging
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3132
draggingLastPointerOffset
draggingLastPointerOffset:
Point
What was the previous pointer offset when the node was in a dragging state?
Inherited from
Scene.draggingLastPointerOffset
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3130
eventListeners
eventListeners:
M2NodeEventListener<M2NodeEvent>[]
Inherited from
Scene.eventListeners
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3109
isDrawable
isDrawable:
boolean
Inherited from
Scene.isDrawable
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:448
isShape
isShape:
boolean
Inherited from
Scene.isShape
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3083
isText
isText:
boolean
Inherited from
Scene.isText
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3084
layout
layout:
Layout
FOR INTERNAL USE ONLY
Inherited from
Scene.layout
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3098
loopMessages
loopMessages:
Set<string>
Inherited from
Scene.loopMessages
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3113
name
name:
string
Name of the node. Only needed if the node will be referred to by name in a later function
Inherited from
Scene.name
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3090
needsInitialization
needsInitialization:
boolean
Inherited from
Scene.needsInitialization
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3111
nodeEvents
nodeEvents:
M2Event<M2Node>[]
Inherited from
Scene.nodeEvents
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3114
options
options:
M2NodeOptions
Inherited from
Scene.options
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3086
parent?
optionalparent:M2Node
Inherited from
Scene.parent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3100
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3117
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3123
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3127
queuedAction?
optionalqueuedAction:Action
Inherited from
Scene.queuedAction
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3108
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
Scene.toString
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3174
type
readonlytype:Scene=M2NodeType.Scene
Inherited from
Scene.type
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:447
userData
userData:
any
Inherited from
Scene.userData
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3112
uuid
readonlyuuid:string
Internal
Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only
Inherited from
Scene.uuid
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3110
withinHitArea
withinHitArea:
boolean
Inherited from
Scene.withinHitArea
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3118
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
Inherited from
Scene.alpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3438
ancestors
Get Signature
get ancestors():
M2Node[]
Returns all ancestor nodes, not including the node itself.
Returns
M2Node[]
Inherited from
Scene.ancestors
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3229
anchorPoint
Get Signature
get anchorPoint():
Point
Returns
Point
Set Signature
set anchorPoint(
anchorPoint):void
Parameters
• anchorPoint: Point
Returns
void
Inherited from
Scene.anchorPoint
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:490
backgroundColor
Get Signature
get backgroundColor():
RgbaColor
Background color of the scene. Default is Constants.DEFAULT_SCENE_BACKGROUND_COLOR (WebColors.White)
Returns
RgbaColor
Set Signature
set backgroundColor(
backgroundColor):void
Background color of the scene. Default is Constants.DEFAULT_SCENE_BACKGROUND_COLOR (WebColors.White)
Parameters
• backgroundColor: RgbaColor
Returns
void
Inherited from
Scene.backgroundColor
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:488
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
Scene.canvasKit
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3428
completeNodeOptions
Get Signature
get completeNodeOptions():
object
Returns
object
alpha?
optionalalpha:number
anchorPoint?
optionalanchorPoint:Point
backgroundColor
backgroundColor:
RgbaColor
draggable?
optionaldraggable:boolean
hidden?
optionalhidden:boolean
isPartOfComposite?
optionalisPartOfComposite:boolean
isUserInteractionEnabled?
optionalisUserInteractionEnabled:boolean
layout?
optionallayout:Layout
name?
optionalname:string
position?
optionalposition:Point
scale?
optionalscale:number
uuid?
optionaluuid:string
zPosition?
optionalzPosition:number
zRotation?
optionalzRotation:number
Inherited from
Scene.completeNodeOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:463
descendants
Get Signature
get descendants():
M2Node[]
Returns all descendant nodes.
Remarks
Descendants are children and children of children, recursively.
Returns
M2Node[]
Inherited from
Scene.descendants
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3225
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
Inherited from
Scene.draggable
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3444
game
Get Signature
get game():
Game
The game which this scene is a part of.
Remarks
Throws error if scene is not part of the game object.
Returns
Game
Set Signature
set game(
game):void
The game which this node is a part of.
Remarks
Throws error if node is not part of the game object.
Parameters
• game: Game
Returns
void
Inherited from
Scene.game
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:487
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
Inherited from
Scene.hidden
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3442
isPartOfComposite
Get Signature
get isPartOfComposite():
boolean
Is the node part of a composite? 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 isPartOfComposite(
value):void
Is the node part of a composite? 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
Inherited from
Scene.isPartOfComposite
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3446
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
Inherited from
Scene.isUserInteractionEnabled
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3440
parentSceneAsNode
Get Signature
get parentSceneAsNode():
M2Node
Returns
M2Node
Inherited from
Scene.parentSceneAsNode
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3429
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
Inherited from
Scene.position
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3432
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
Inherited from
Scene.scale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3436
size
Get Signature
get size():
Size
Returns
Size
Set Signature
set size(
size):void
Parameters
• size: Size
Returns
void
Inherited from
Scene.size
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3430
zPosition
Get Signature
get zPosition():
number
Returns
number
Set Signature
set zPosition(
zPosition):void
Parameters
• zPosition: number
Returns
void
Inherited from
Scene.zPosition
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:492
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
Inherited from
Scene.zRotation
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3434
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3182
addEventListener()
addEventListener<
T>(type,callback,callbackOptions?):void
Type Parameters
• T extends M2NodeEvent
Parameters
• type: string
• callback
• callbackOptions?: CallbackOptions
Returns
void
Inherited from
Scene.addEventListener
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3354
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
Scene.descendant
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3219
dispose()
dispose():
void
Frees up resources and breaks parent/child links.
Returns
void
Remarks
This should be overridden by derived classes to clean up specific resources (like Skia objects), and they should call super.dispose().
Inherited from
Scene.dispose
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:480
draw()
draw(
canvas):void
Parameters
• canvas: Canvas
Returns
void
Inherited from
Scene.draw
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:557
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3383
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
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.
Inherited from
Scene.duplicate
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:504
getDrawableOptions()
protectedgetDrawableOptions():DrawableOptions
Returns
DrawableOptions
Inherited from
Scene.getDrawableOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3421
getNodeOptions()
protectedgetNodeOptions():M2NodeOptions
Returns
M2NodeOptions
Inherited from
Scene.getNodeOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3420
getTextOptions()
protectedgetTextOptions():TextOptions
Returns
TextOptions
Inherited from
Scene.getTextOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3422
initialize()
initialize():
void
Returns
void
Inherited from
Scene.initialize
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:479
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
Scene.involvedInActionAffectingAppearance
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3240
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3247
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:527
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3346
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3353
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3339
onKeyDown()
onKeyDown(
callback,options?):void
Code that will be called after a key is pressed on the device's built-in keyboard.
Parameters
• callback
function to execute
• options?: CallbackOptions
CallbackOptions
Returns
void
Remarks
The built-in keyboard is defined as the hardware keyboard on a
desktop/laptop or the built-in soft keyboard on a tablet or phone. The
latter is not used in m2c2kit. On tablet or phone, the VirtualKeyboard
in the @m2c2kit/addons package should be used for key events.
Inherited from
Scene.onKeyDown
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:541
onKeyUp()
onKeyUp(
callback,options?):void
Code that will be called after a key is released on the device's built-in keyboard.
Parameters
• callback
function to execute
• options?: CallbackOptions
CallbackOptions
Returns
void
Remarks
The built-in keyboard is defined as the hardware keyboard on a
desktop/laptop or the built-in soft keyboard on a tablet or phone. The
latter is not used in m2c2kit. On tablet or phone, the VirtualKeyboard
in the @m2c2kit/addons package should be used for key events.
Inherited from
Scene.onKeyUp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:555
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
Scene.onPointerDown
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3304
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3332
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3324
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
Scene.onPointerUp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3316
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
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.
Inherited from
Scene.onSetup
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:518
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
Scene.onTapDown
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3257
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
Scene.onTapLeave
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3294
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
Scene.onTapUp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3269
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
Scene.onTapUpAny
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3282
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3403
removeAllActions()
removeAllActions():
void
Remove all actions from this node. If actions are running, they will be stopped.
Returns
void
Inherited from
Scene.removeAllActions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3408
removeAllChildren()
removeAllChildren():
void
Removes all children from the node.
Returns
void
Inherited from
Scene.removeAllChildren
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3195
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3202
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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3209
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
Scene.run
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3396
saveEvent()
protectedsaveEvent(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
Scene.saveEvent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3156
saveNodeNewEvent()
protectedsaveNodeNewEvent():void
Save the node's construction event in the event store.
Returns
void
Inherited from
Scene.saveNodeNewEvent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3139
savePropertyChangeEvent()
protectedsavePropertyChangeEvent(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
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3146
update()
update():
void
Returns
void
Inherited from
Scene.update
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:556
warmup()
warmup(
canvas):void
Parameters
• canvas: Canvas
Returns
void
Inherited from
Scene.warmup
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:558