Class: Grid
Extends
Composite
Implements
Constructors
new Grid()
new Grid(
options):Grid
A rectangular grid that supports placement of nodes within the grid's cells.
Parameters
• options: GridOptions
Returns
Remarks
This composite node is composed of rectangles and lines. It has convenience functions for placing and clearing nodes on the grid by row and column position (zero-based indexing)
Overrides
Composite.constructor
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:70
Properties
_alpha
_alpha:
number
Inherited from
Composite._alpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2548
_draggable
protected_draggable:boolean
Inherited from
Composite._draggable
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2551
_game?
optional_game:Game
Inherited from
Composite._game
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2554
_hidden
protected_hidden:boolean
Inherited from
Composite._hidden
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2552
_isUserInteractionEnabled
protected_isUserInteractionEnabled:boolean
Inherited from
Composite._isUserInteractionEnabled
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2550
_position
_position:
Point
Inherited from
Composite._position
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2546
_scale
_scale:
number
Inherited from
Composite._scale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2547
_size
protected_size:Size
Inherited from
Composite._size
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2558
_zRotation
_zRotation:
number
Inherited from
Composite._zRotation
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2549
absoluteAlpha
absoluteAlpha:
number
Inherited from
Composite.absoluteAlpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2560
absoluteAlphaChange
absoluteAlphaChange:
number
Inherited from
Composite.absoluteAlphaChange
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2561
absolutePosition
absolutePosition:
Point
Inherited from
Composite.absolutePosition
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2557
absoluteScale
absoluteScale:
number
Inherited from
Composite.absoluteScale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2559
actions
actions:
Action[]
Inherited from
Composite.actions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2562
cellHeight
cellHeight:
number
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:55
cellWidth
cellWidth:
number
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:54
children
children:
M2Node[]
Inherited from
Composite.children
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2556
compositeType
compositeType:
string="Grid"
Overrides
Composite.compositeType
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:45
constructionIso8601TimeStamp
constructionIso8601TimeStamp:
string
Inherited from
Composite.constructionIso8601TimeStamp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2543
constructionSequence
constructionSequence:
number
Inherited from
Composite.constructionSequence
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2544
constructionTimeStamp
constructionTimeStamp:
number
Inherited from
Composite.constructionTimeStamp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2542
dragging
dragging:
boolean
Is the node in a dragging state?
Inherited from
Composite.dragging
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2587
draggingLastPointerOffset
draggingLastPointerOffset:
Point
What was the previous pointer offset when the node was in a dragging state?
Inherited from
Composite.draggingLastPointerOffset
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2585
eventListeners
eventListeners:
M2NodeEventListener<M2NodeEvent>[]
Inherited from
Composite.eventListeners
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2564
isDrawable
isDrawable:
boolean
Inherited from
Composite.isDrawable
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:124
isShape
isShape:
boolean
Inherited from
Composite.isShape
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2538
isText
isText:
boolean
Inherited from
Composite.isText
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2539
layout
layout:
Layout
FOR INTERNAL USE ONLY
Implementation of
Inherited from
Composite.layout
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2553
loopMessages
loopMessages:
Set<string>
Inherited from
Composite.loopMessages
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2568
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
Composite.name
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2545
needsInitialization
needsInitialization:
boolean
Inherited from
Composite.needsInitialization
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2566
nodeEvents
nodeEvents:
M2Event<M2Node>[]
Inherited from
Composite.nodeEvents
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2569
options
options:
M2NodeOptions
Inherited from
Composite.options
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2541
parent?
optionalparent:M2Node
Inherited from
Composite.parent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2555
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
Composite.pressed
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2572
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
Composite.pressedAndWithinHitArea
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2578
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
Composite.pressedInitialPointerOffset
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2582
queuedAction?
optionalqueuedAction:Action
Inherited from
Composite.queuedAction
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2563
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
Composite.toString
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2629
type
readonlytype:Composite=M2NodeType.Composite
Inherited from
Composite.type
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:122
userData
userData:
any
Inherited from
Composite.userData
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2567
uuid
readonlyuuid:string
Internal
Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only
Implementation of
Inherited from
Composite.uuid
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2565
withinHitArea
withinHitArea:
boolean
Inherited from
Composite.withinHitArea
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2573
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
Composite.alpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2886
ancestors
Get Signature
get ancestors():
M2Node[]
Returns all ancestor nodes, not including the node itself.
Returns
M2Node[]
Inherited from
Composite.ancestors
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2684
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
Point
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
Inherited from
Composite.anchorPoint
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:134
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
Composite.canvasKit
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2876
columns
Get Signature
get columns():
number
Number of columns in the grid. Must be 1 or greater
Returns
number
Set Signature
set columns(
columns):void
Number of columns in the grid. Must be 1 or greater
Parameters
• columns: number
Returns
void
Number of columns in the grid. Must be 1 or greater
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:278
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
backgroundColor
backgroundColor:
RgbaColor
columns
columns:
number
draggable?
optionaldraggable:boolean
Can the node be dragged?
gridLineColor
gridLineColor:
RgbaColor
gridLineWidth
gridLineWidth:
number
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)
rows
rows:
number
scale?
optionalscale:number
Scale of the node. Default is 1.0
size
size:
Size
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?
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
Composite.completeNodeOptions
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:109
descendants
Get Signature
get descendants():
M2Node[]
Returns all descendant nodes.
Remarks
Descendants are children and children of children, recursively.
Returns
M2Node[]
Inherited from
Composite.descendants
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2680
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
Composite.draggable
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2892
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
Game
Inherited from
Composite.game
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2617
gridBackgroundColor
Get Signature
get gridBackgroundColor():
RgbaColor
Returns
RgbaColor
Set Signature
set gridBackgroundColor(
backgroundColor):void
Parameters
• backgroundColor: RgbaColor
Returns
void
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:289
gridChildren
Get Signature
get gridChildren():
GridChild[]
The child nodes that have been added to the grid.
Remarks
Do not set this property directly. Use the methods for adding
and removing grid children, such as addAtCell(), removeAllAtCell(),
removeGridChild(), and removeAllGridChildren().
Returns
Set Signature
set gridChildren(
gridChildren):void
Parameters
• gridChildren: GridChild[]
Returns
void
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:385
gridLineColor
Get Signature
get gridLineColor():
RgbaColor
Color of the grid lines. Default is red
Returns
RgbaColor
Set Signature
set gridLineColor(
gridLineColor):void
Color of the grid lines. Default is red
Parameters
• gridLineColor: RgbaColor
Returns
void
Color of the grid lines. Default is red
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:311
gridLineWidth
Get Signature
get gridLineWidth():
number
Width of the grid lines. Default is 1
Returns
number
Set Signature
set gridLineWidth(
gridLineWidth):void
Width of the grid lines. Default is 1
Parameters
• gridLineWidth: number
Returns
void
Width of the grid lines. Default is 1
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:300
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
Composite.hidden
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2890
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
Does the node respond to user events, such as taps? Default is false
Implementation of
GridOptions.isUserInteractionEnabled
Inherited from
Composite.isUserInteractionEnabled
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2888
parentSceneAsNode
Get Signature
get parentSceneAsNode():
M2Node
Returns
M2Node
Inherited from
Composite.parentSceneAsNode
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2877
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
Position of the node within its parent coordinate system. Default is (0, 0)
Implementation of
Inherited from
Composite.position
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2880
rows
Get Signature
get rows():
number
note: below we do not have getter and setter for size because the getter and setter in M2Node will handle it.
Returns
number
Set Signature
set rows(
rows):void
Number of rows in the grid. Must be 1 or greater
Parameters
• rows: number
Returns
void
Number of rows in the grid. Must be 1 or greater
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:267
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
Scale of the node. Default is 1.0
Implementation of
Inherited from
Composite.scale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2884
size
Get Signature
get size():
Size
Size of the grid in pixels
Returns
Size
Set Signature
set size(
size):void
Size of the grid in pixels
Parameters
• size: Size
Returns
void
Size of the grid in pixels
Implementation of
Inherited from
Composite.size
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2878
suppressEvents
Get Signature
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.
Returns
boolean
Set Signature
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
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.
Implementation of
Inherited from
Composite.suppressEvents
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2894
zPosition
Get Signature
get zPosition():
number
Value along the z-axis to determine drawing and tap order. Larger values are on top.
Returns
number
Set Signature
set zPosition(
zPosition):void
Value along the z-axis to determine drawing and tap order. Larger values are on top.
Parameters
• zPosition: number
Returns
void
Value along the z-axis to determine drawing and tap order. Larger values are on top.
Implementation of
Inherited from
Composite.zPosition
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:136
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
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.
Implementation of
Inherited from
Composite.zRotation
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2882
Methods
addAtCell()
addAtCell(
node,row,column):void
Adds a node as a grid child to the grid at the specified row and column position.
Parameters
• node: M2Node
node to add to the grid
• row: number
row position within grid to add node; zero-based indexing
• column: number
column position within grid to add node; zero-based indexing
Returns
void
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:434
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
Overrides
Composite.addChild
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:477
addEventListener()
addEventListener<
T>(type,callback,callbackOptions?):void
Type Parameters
• T extends M2NodeEvent
Parameters
• type: string
• callback
• callbackOptions?: CallbackOptions
Returns
void
Inherited from
Composite.addEventListener
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2809
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
Composite.descendant
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2674
dispose()
dispose():
void
Returns
void
Overrides
Composite.dispose
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:325
draw()
draw(
canvas):void
Parameters
• canvas: Canvas
Returns
void
Overrides
Composite.draw
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:365
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
Composite.drawChildren
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2831
duplicate()
duplicate(
newName?):Grid
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
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.
Overrides
Composite.duplicate
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:337
getDrawableOptions()
protectedgetDrawableOptions():DrawableOptions
Returns
DrawableOptions
Inherited from
Composite.getDrawableOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2869
getNodeOptions()
protectedgetNodeOptions():M2NodeOptions
Returns
M2NodeOptions
Inherited from
Composite.getNodeOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2868
getTextOptions()
protectedgetTextOptions():TextOptions
Returns
TextOptions
Inherited from
Composite.getTextOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2870
handleCompositeEvent()
handleCompositeEvent(
event):void
Event handler for custom events a Composite may generate.
Parameters
• event: CompositeEvent
event to handle
Returns
void
Remarks
If the Composite generates custom events, this method is
necessary for the Composite to work in replay mode.
Inherited from
Composite.handleCompositeEvent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:150
initialize()
initialize():
void
Returns
void
Overrides
Composite.initialize
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:123
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
Composite.involvedInActionAffectingAppearance
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2695
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
Composite.involvedInSceneTransition
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2702
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
Composite.onDrag
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2801
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
Composite.onDragEnd
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2808
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
Composite.onDragStart
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2794
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
Composite.onPointerDown
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2759
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
Composite.onPointerLeave
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2787
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
Composite.onPointerMove
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2779
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
Composite.onPointerUp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2771
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
Composite.onTapDown
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2712
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
Composite.onTapLeave
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2749
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
Composite.onTapUp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2724
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
Composite.onTapUpAny
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2737
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
Composite.removeAction
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2851
removeAllActions()
removeAllActions():
void
Remove all actions from this node. If actions are running, they will be stopped.
Returns
void
Inherited from
Composite.removeAllActions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2856
removeAllAtCell()
removeAllAtCell(
row,column):void
Removes all grid child nodes at the specified row and column position.
Parameters
• row: number
row position within grid at which to remove grid children; zero-based indexing
• column: number
column position within grid at which to remove grid children; zero-based indexing
Returns
void
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:453
removeAllChildren()
removeAllChildren():
void
Removes all children from the node.
Returns
void
Overrides
Composite.removeAllChildren
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:484
removeAllGridChildren()
removeAllGridChildren():
void
Removes all grid children from the grid.
Returns
void
Remarks
This retains grid lines and grid appearance.
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:416
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
Overrides
Composite.removeChild
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:491
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
Overrides
Composite.removeChildren
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:498
removeGridChild()
removeGridChild(
node):void
Removes the grid child node from the grid.
Parameters
• node: M2Node
node to remove
Returns
void
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:465
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
Composite.run
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2844
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
Composite.saveEvent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2611
saveNodeNewEvent()
protectedsaveNodeNewEvent():void
Save the node's construction event in the event store.
Returns
void
Inherited from
Composite.saveNodeNewEvent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2594
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
Composite.savePropertyChangeEvent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2601
update()
update():
void
Returns
void
Overrides
Composite.update
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:361
warmup()
warmup(
canvas):void
Parameters
• canvas: Canvas
Returns
void
Overrides
Composite.warmup
Defined in
m2c2kit/packages/addons/src/composites/grid.ts:369