Class: SoundPlayer
Extends
Implements
Constructors
new SoundPlayer()
new SoundPlayer(
options
):SoundPlayer
Node for playing sounds.
Parameters
• options: SoundPlayerOptions
Returns
Overrides
Source
Properties
_alpha
_alpha:
number
=1.0
Inherited from
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
_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
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
=false
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?
optional
parent: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?
optional
queuedAction:Action
Inherited from
Source
soundName
soundName:
string
Name of sound to play. Must have been previously loaded
Implementation of
Source
type
readonly
type:SoundPlayer
=M2NodeType.SoundPlayer
Overrides
Source
userData
userData:
any
={}
Inherited from
Source
uuid
Internal
readonly
uuid: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
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
ancestors
get
ancestors():M2Node
[]
Returns all ancestor nodes, not including the node itself.
Returns
M2Node
[]
Source
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
completeNodeOptions
get
protected
completeNodeOptions():M2NodeOptions
Returns
Source
descendants
get
descendants():M2Node
[]
Returns all descendant nodes.
Remarks
Descendants are children and children of children, recursively.
Returns
M2Node
[]
Source
draggable
get
draggable():boolean
Can the node be dragged?
set
draggable(draggable
):void
Can the node be dragged?
Parameters
• draggable: boolean
Returns
boolean
Source
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
Source
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
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
parentSceneAsNode
get
parentSceneAsNode():M2Node
Returns
Source
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
Source
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
size
get
size():Size
set
size(size
):void
Parameters
• size: Size
Returns
Source
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
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
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()
dispose():
void
Returns
void
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
?):SoundPlayer
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()
protected
getDrawableOptions():DrawableOptions
Returns
Inherited from
Source
getNodeOptions()
protected
getNodeOptions():M2NodeOptions
Returns
Inherited from
Source
getTextOptions()
protected
getTextOptions():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
onDrag()
onDrag(
callback
,options
?):void
Executes a callback when the user continues dragging a node.
Parameters
• callback
function to execute