Class: Sprite
Extends
Implements
Constructors
new Sprite()
new Sprite(
options):Sprite
Visual image displayed on the screen.
Parameters
• options: SpriteOptions = {}
Returns
Remarks
Images that will be used to create the sprite must be loaded during the Game.initialize() method prior to their use.
Overrides
Defined in
m2c2kit/packages/core/src/Sprite.ts:32
Properties
_alpha
_alpha:
number=1.0
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:99
_draggable
protected_draggable:boolean=false
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:102
_game?
optional_game:Game
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:106
_hidden
protected_hidden:boolean=false
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:103
_isUserInteractionEnabled
protected_isUserInteractionEnabled:boolean=false
Inherited from
M2Node._isUserInteractionEnabled
Defined in
m2c2kit/packages/core/src/M2Node.ts:101
_position
_position:
Point
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:97
_scale
_scale:
number=1.0
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:98
_size
protected_size:Size
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:110
_zRotation
_zRotation:
number=0
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:100
absoluteAlpha
absoluteAlpha:
number=1.0
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:112
absoluteAlphaChange
absoluteAlphaChange:
number=0
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:113
absolutePosition
absolutePosition:
Point
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:109
absoluteScale
absoluteScale:
number=1.0
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:111
actions
actions:
Action[]
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:114
children
children:
M2Node[]
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:108
constructionIso8601TimeStamp
constructionIso8601TimeStamp:
string
Inherited from
M2Node.constructionIso8601TimeStamp
Defined in
m2c2kit/packages/core/src/M2Node.ts:93
constructionSequence
constructionSequence:
number
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:94
constructionTimeStamp
constructionTimeStamp:
number
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:92
dragging
dragging:
boolean=false
Is the node in a dragging state?
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:142
draggingLastPointerOffset
draggingLastPointerOffset:
Point
What was the previous pointer offset when the node was in a dragging state?
Inherited from
M2Node.draggingLastPointerOffset
Defined in
m2c2kit/packages/core/src/M2Node.ts:140
eventListeners
eventListeners:
M2NodeEventListener<M2NodeEvent>[]
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:116
isDrawable
isDrawable:
boolean=true
Overrides
Defined in
m2c2kit/packages/core/src/Sprite.ts:15
isShape
isShape:
boolean=false
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:88
isText
isText:
boolean=false
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:89
layout
layout:
Layout={}
FOR INTERNAL USE ONLY
Implementation of
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:104
loopMessages
loopMessages:
Set<string>
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:122
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
Defined in
m2c2kit/packages/core/src/M2Node.ts:96
needsInitialization
needsInitialization:
boolean=true
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:118
nodeEvents
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:123
options
options:
M2NodeOptions
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:91
parent?
optionalparent:M2Node
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:107
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
Defined in
m2c2kit/packages/core/src/M2Node.ts:127
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
Defined in
m2c2kit/packages/core/src/M2Node.ts:133
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
Defined in
m2c2kit/packages/core/src/M2Node.ts:137
queuedAction?
optionalqueuedAction:Action
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:115
type
readonlytype:Sprite=M2NodeType.Sprite
Overrides
Defined in
m2c2kit/packages/core/src/Sprite.ts:14
userData
userData:
any={}
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:121
uuid
readonlyuuid:string
Internal
Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only
Implementation of
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:117
withinHitArea
withinHitArea:
boolean=false
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:128
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
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.
Implementation of
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:1442
ancestors
Get Signature
get ancestors():
M2Node[]
Returns all ancestor nodes, not including the node itself.
Returns
M2Node[]
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:538
anchorPoint
Get Signature
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
Returns
Set Signature
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
void
Point within the node that determines its position. Default is { x: 0.5, y: 0.5 }, which centers the node on its position
Implementation of
Defined in
m2c2kit/packages/core/src/Sprite.ts:85
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
Defined in
m2c2kit/packages/core/src/M2Node.ts:1334
completeNodeOptions
Get Signature
get completeNodeOptions():
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
draggable?
optionaldraggable:boolean
Can the node be dragged?
hidden?
optionalhidden:boolean
Is the node, and its children, hidden? (not displayed). Default is false
imageName
imageName:
string
isPartOfComposite?
optionalisPartOfComposite: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.
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
uuid?
optionaluuid:string
Internal
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.
Overrides
Defined in
m2c2kit/packages/core/src/Sprite.ts:42
descendants
Get Signature
get descendants():
M2Node[]
Returns all descendant nodes.
Remarks
Descendants are children and children of children, recursively.
Returns
M2Node[]
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:525
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
Can the node be dragged?
Implementation of
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:1478
game
Get Signature
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
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:278
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
Is the node, and its children, hidden? (not displayed). Default is false
Implementation of
Inherited from
Defined in
m2c2kit/packages/core/src/M2Node.ts:1467
imageName
Get Signature
get imageName():
string
Name of image to use for sprite. Must have been previously loaded
Returns
string
Set Signature
set imageName(
imageName):void
Name of image to use for sprite. Must have been previously loaded
Parameters
• imageName: string
Returns
void
Name of image to use for sprite. Must have been previously loaded
Implementation of
Defined in
m2c2kit/packages/core/src/Sprite.ts:74
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
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.
Implementation of
SpriteOptions.isPartOfComposite