Class: Scene
Extends
Implements
Constructors
new Scene()
new Scene(
options):Scene
Top-level node that holds all other nodes, such as sprites, rectangles, or labels, that will be displayed on the screen
Parameters
• options: SceneOptions= {}
Returns
Overrides
Remarks
The scene is the game screen or stage, and fills the entire available screen. There are usually multiple screens to contain multiple stages of the game, such as various instruction pages or phases of a game.
Source
Properties
_active
_active:
boolean=false
Source
_alpha
_alpha:
number=1.0
Inherited from
Source
_anchorPoint
private_anchorPoint:Point
Source
_backgroundColor
private_backgroundColor:RgbaColor=Constants.DEFAULT_SCENE_BACKGROUND_COLOR
Source
_draggable
protected_draggable:boolean=false
Inherited from
Source
_game?
optional_game:Game
Inherited from
Source
_hidden
protected_hidden:boolean=false
Inherited from
Source
_isUserInteractionEnabled
protected_isUserInteractionEnabled:boolean=false
Inherited from
M2Node._isUserInteractionEnabled
Source
_position
_position:
Point
Inherited from
Source
_scale
_scale:
number=1.0
Inherited from
Source
_size
protected_size:Size
Inherited from
Source
_transitioning
_transitioning:
boolean=false
Source
_zPosition
private_zPosition:number=0
Source
_zRotation
_zRotation:
number=0
Inherited from
Source
absoluteAlpha
absoluteAlpha:
number=1.0
Inherited from
Source
absoluteAlphaChange
absoluteAlphaChange:
number=0
Inherited from
Source
absolutePosition
absolutePosition:
Point
Inherited from
Source
absoluteScale
absoluteScale:
number=1.0
Inherited from
Source
actions
actions:
Action[]
Inherited from
Source
backgroundPaint?
privateoptionalbackgroundPaint:Paint
Source
children
children:
M2Node[]
Inherited from
Source
constructionIso8601TimeStamp
constructionIso8601TimeStamp:
string
Inherited from
M2Node.constructionIso8601TimeStamp
Source
constructionSequence
constructionSequence:
number
Inherited from
Source
constructionTimeStamp
constructionTimeStamp:
number
Inherited from
Source
dragging
dragging:
boolean=false
Is the node in a dragging state?
Inherited from
Source
draggingLastPointerOffset
draggingLastPointerOffset:
Point
What was the previous pointer offset when the node was in a dragging state?
Inherited from
M2Node.draggingLastPointerOffset
Source
eventListeners
eventListeners:
M2NodeEventListener<M2NodeEvent>[]
Inherited from
Source
isDrawable
isDrawable:
boolean=true
Overrides
Source
isShape
isShape:
boolean=false
Inherited from
Source
isText
isText:
boolean=false
Inherited from
Source
layout
layout:
Layout={}
FOR INTERNAL USE ONLY
Implementation of
Inherited from
Source
loopMessages
loopMessages:
Set<string>
Inherited from
Source
name
name:
string
Name of the node. Only needed if the node will be referred to by name in a later function
Implementation of
Inherited from
Source
needsInitialization
needsInitialization:
boolean=true
Inherited from
Source
nodeEvents
Inherited from
Source
options
options:
M2NodeOptions
Inherited from
Source
parent?
optionalparent:M2Node
Inherited from
Source
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
Source
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
Source
pressedInitialPointerOffset
pressedInitialPointerOffset:
Point
When the node initially enters the pressed state, what is the pointer offset? (offset from the canvas's origin to the pointer position). We save this because it will be needed if this press then led to a drag.
Inherited from
M2Node.pressedInitialPointerOffset
Source
queuedAction?
optionalqueuedAction:Action
Inherited from
Source
type
readonlytype:Scene=M2NodeType.Scene
Overrides
Source
userData
userData:
any={}
Inherited from
Source
uuid
Internal
readonlyuuid:string
Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only
Implementation of
Inherited from
Source
withinHitArea
withinHitArea:
boolean=false
Inherited from
Source
Accessors
alpha
getalpha():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.
setalpha(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
ancestors
getancestors():M2Node[]
Returns all ancestor nodes, not including the node itself.
Returns
M2Node[]
Source
anchorPoint
getanchorPoint():Point
Point within the node that determines its position. Default is { x: 0.5, y: 0.5 }, which centers the node on its position
setanchorPoint(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
Source
backgroundColor
getbackgroundColor():RgbaColor
Background color of the scene. Default is Constants.DEFAULT_SCENE_BACKGROUND_COLOR (WebColors.White)
setbackgroundColor(backgroundColor):void
Background color of the scene. Default is Constants.DEFAULT_SCENE_BACKGROUND_COLOR (WebColors.White)
Parameters
• backgroundColor: RgbaColor
Returns
Source
canvasKit
getcanvasKit():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
completeNodeOptions
getcompleteNodeOptions():object
Returns
object
alpha?
optionalalpha: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?
optionalanchorPoint: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:
RgbaColor
draggable?
optionaldraggable:boolean
Can the node be dragged?
hidden?
optionalhidden:boolean
Is the node, and its children, hidden? (not displayed). Default is false
isUserInteractionEnabled?
optionalisUserInteractionEnabled:boolean
Does the node respond to user events, such as taps? Default is false
layout?
optionallayout:Layout
FOR INTERNAL USE ONLY
name?
optionalname:string
Name of the node. Only needed if the node will be referred to by name in a later function
position?
optionalposition:Point
Position of the node within its parent coordinate system. Default is (0, 0)
scale?
optionalscale:number
Scale of the node. Default is 1.0
suppressEvents?
optionalsuppressEvents: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.
uuid?
Internal
optionaluuid:string
Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only
zPosition?
optionalzPosition:number
Value along the z-axis to determine drawing and tap order. Larger values are on top.
zRotation?
optionalzRotation:number
Rotation of the node around the Z axis. Unit is radians. Default is 0 (no rotation). zRotation has inheritance. In addition to this node's zRotation, all ancestors' zRotations will be applied.
Source
descendants
getdescendants():M2Node[]
Returns all descendant nodes.
Remarks
Descendants are children and children of children, recursively.
Returns
M2Node[]
Source
draggable
getdraggable():boolean
Can the node be dragged?
setdraggable(draggable):void
Can the node be dragged?
Parameters
• draggable: boolean
Returns
boolean
Source
game
getgame():Game
The game which this scene is a part of.
Remarks
Throws error if scene is not part of the game object.
setgame(game):void
Parameters
• game: Game
Returns
Source
hidden
gethidden():boolean
Is the node, and its children, hidden? (not displayed). Default is false
sethidden(hidden):void
Is the node, and its children, hidden? (not displayed). Default is false
Parameters
• hidden: boolean
Returns
boolean
Source
isUserInteractionEnabled
getisUserInteractionEnabled():boolean
Does the node respond to user events, such as taps? Default is false
setisUserInteractionEnabled(isUserInteractionEnabled):void
Does the node respond to user events, such as taps? Default is false
Parameters
• isUserInteractionEnabled: boolean
Returns
boolean
Source
parentSceneAsNode
getparentSceneAsNode():M2Node
Returns
Source
position
getposition():Point
Position of the node within its parent coordinate system. Default is (0, 0)
setposition(position):void
Position of the node within its parent coordinate system. Default is (0, 0)
Parameters
• position: Point
Returns
Source
scale
getscale():number
Scale of the node. Default is 1.0
setscale(scale):void
Scale of the node. Default is 1.0
Parameters
• scale: number
Returns
number
Source
size
getsize():Size
setsize(size):void
Parameters
• size: Size
Returns
Source
suppressEvents
getsuppressEvents():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.
setsuppressEvents(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
zPosition
getzPosition():number
Value along the z-axis to determine drawing and tap order. Larger values are on top.
setzPosition(zPosition):void
Value along the z-axis to determine drawing and tap order. Larger values are on top.
Parameters
• zPosition: number
Returns
number
Source
zRotation
getzRotation():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.
setzRotation(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
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
Source
addEventListener()
addEventListener<
T>(type,callback,callbackOptions?):void
Type parameters
• T extends M2NodeEvent
Parameters
• type: string
• callback
• callbackOptions?: CallbackOptions
Returns
void
Inherited from
Source
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
Remarks
Descendants are children and children of children, recursively. Throws exception if no descendant with the given name is found.
Source
dispose()
Internal
dispose():
void
Frees up resources allocated by the Drawable M2Node.
For m2c2kit library use only
Returns
void
Implementation of
Remarks
This will be done automatically by the m2c2kit library; the end-user must not call this.
Source
draw()
draw(
canvas):void
Parameters
• canvas: Canvas
Returns
void
Implementation of
Source
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
Source
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
Overrides
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
getDrawableOptions()
protectedgetDrawableOptions():DrawableOptions
Returns
Inherited from
Source
getNodeOptions()
protectedgetNodeOptions():M2NodeOptions
Returns
Inherited from
Source
getTextOptions()
protectedgetTextOptions():TextOptions
Returns
Inherited from
Source
initialize()
initialize():
void
Returns
void
Overrides
Source
involvedInActionAffectingAppearance()
involvedInActionAffectingAppearance():
boolean
Determines if this node or ancestor is part of an active action that affects it appearance.
Returns
boolean
true if part of active action affecting appearance
Inherited from
M2Node.involvedInActionAffectingAppearance
Remarks
This is used to determine if the node should be rendered with anti-aliasing or not. Anti-aliasing on some devices causes a new shader to be compiled during the action, which causes jank.
Source
involvedInSceneTransition()
involvedInSceneTransition():
boolean
Determines if the node is a transitioning Scene or a descendant of a transitioning Scene.
Returns
boolean
true if transitioning
Inherited from
M2Node.involvedInSceneTransition
Source
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
Returns
void
Source
onDrag()
onDrag(
callback,options?):void
Executes a callback when the user continues dragging a node.
Parameters
• callback
function to execute
• options?: CallbackOptions
Returns
void
Inherited from
Source
onDragEnd()
onDragEnd(
callback,options?):void
Executes a callback when the user stop dragging a node.
Parameters
• callback
function to execute
• options?: CallbackOptions
Returns
void
Inherited from
Source
onDragStart()
onDragStart(
callback,options?):void
Executes a callback when the user begins dragging a node.
Parameters
• callback
function to execute
• options?: CallbackOptions
Returns
void
Inherited from
Source
onPointerDown()
onPointerDown(
callback,options?):void
Executes a callback when the pointer first is down on the node.
Parameters
• callback
function to execute
• options?: CallbackOptions
Returns
void
Inherited from
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
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
Returns
void
Inherited from
Source
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
Returns
void
Inherited from
Source
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
Returns
void
Inherited from
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
onSetup()
onSetup(
callback,options?):void
Code that will be called every time the scene is presented.
Parameters
• callback
function to execute
• options?: 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.
Source
onTapDown()
onTapDown(
callback,options?):void
Executes a callback when the user presses down on the node.
Parameters
• callback
function to execute
• options?: CallbackOptions
Returns
void
Inherited from
Remarks
TapDown is a pointer down (mouse click or touches begin) within the bounds of the node.
Source
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
Returns
void
Inherited from
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
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
Returns
void
Inherited from
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
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
Returns
void
Inherited from
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
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
Source
removeAllActions()
removeAllActions():
void
Remove all actions from this node. If actions are running, they will be stopped.
Returns
void
Inherited from
Source
removeAllChildren()
removeAllChildren():
void
Removes all children from the node.
Returns
void
Inherited from
Source
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
Source
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
Source
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
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
saveEvent()
protectedsaveEvent(event):void
Saves the node's event.
Parameters
event to save
Returns
void
Inherited from
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
saveNodeNewEvent()
protectedsaveNodeNewEvent():void
Save the node's construction event in the event store.
Returns
void
Inherited from
Source
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
M2Node.savePropertyChangeEvent
Source
toString()
toString():
string
Overrides toString() and returns a human-friendly description of the node.
Returns
string
Inherited from
Remarks
Inspiration from https://stackoverflow.com/a/35361695
Source
update()
update():
void
Returns
void
Overrides
Source
warmup()
warmup(
canvas):void
Parameters
• canvas: Canvas
Returns
void