Class: Button
Extends
Composite
Implements
ITextButtonOptions
Constructors
new Button()
new Button(
options):Button
A simple button of rectangle with text centered inside.
Parameters
• options: ButtonOptions
Returns
Remarks
This composite node is composed of a rectangle and text. To respond to user taps, the isUserInteractionEnabled property must be set to true and an appropriate callback must be set to handle the tap event.
Overrides
Composite.constructor
Defined in
m2c2kit/packages/addons/src/composites/button.ts:62
Properties
_alpha
_alpha:
number
Inherited from
Composite._alpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2731
_draggable
protected_draggable:boolean
Inherited from
Composite._draggable
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2734
_game?
optional_game:Game
Inherited from
Composite._game
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2737
_hidden
protected_hidden:boolean
Inherited from
Composite._hidden
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2735
_isUserInteractionEnabled
protected_isUserInteractionEnabled:boolean
Inherited from
Composite._isUserInteractionEnabled
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2733
_position
_position:
Point
Inherited from
Composite._position
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2729
_scale
_scale:
number
Inherited from
Composite._scale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2730
_size
protected_size:Size
Inherited from
Composite._size
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2741
_zRotation
_zRotation:
number
Inherited from
Composite._zRotation
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2732
absoluteAlpha
absoluteAlpha:
number
Inherited from
Composite.absoluteAlpha
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2743
absoluteAlphaChange
absoluteAlphaChange:
number
Inherited from
Composite.absoluteAlphaChange
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2744
absolutePosition
absolutePosition:
Point
Inherited from
Composite.absolutePosition
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2740
absoluteScale
absoluteScale:
number
Inherited from
Composite.absoluteScale
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2742
actions
actions:
Action[]
Inherited from
Composite.actions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2745
children
children:
M2Node[]
Inherited from
Composite.children
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2739
compositeType
compositeType:
string="Button"
Overrides
Composite.compositeType
Defined in
m2c2kit/packages/addons/src/composites/button.ts:37
constructionIso8601TimeStamp
constructionIso8601TimeStamp:
string
Inherited from
Composite.constructionIso8601TimeStamp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2726
constructionSequence
constructionSequence:
number
Inherited from
Composite.constructionSequence
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2727
constructionTimeStamp
constructionTimeStamp:
number
Inherited from
Composite.constructionTimeStamp
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2725
dragging
dragging:
boolean
Is the node in a dragging state?
Inherited from
Composite.dragging
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2770
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:2768
eventListeners
eventListeners:
M2NodeEventListener<M2NodeEvent>[]
Inherited from
Composite.eventListeners
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2747
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:2721
isText
isText:
boolean=true
Overrides
Composite.isText
Defined in
m2c2kit/packages/addons/src/composites/button.ts:38
layout
layout:
Layout
FOR INTERNAL USE ONLY
Implementation of
Inherited from
Composite.layout
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2736
loopMessages
loopMessages:
Set<string>
Inherited from
Composite.loopMessages
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2751
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:2728
needsInitialization
needsInitialization:
boolean
Inherited from
Composite.needsInitialization
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2749
nodeEvents
nodeEvents:
M2Event<M2Node>[]
Inherited from
Composite.nodeEvents
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2752
options
options:
M2NodeOptions
Inherited from
Composite.options
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2724
parent?
optionalparent:M2Node
Inherited from
Composite.parent
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2738
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:2755
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:2761
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:2765
queuedAction?
optionalqueuedAction:Action
Inherited from
Composite.queuedAction
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2746
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:2812
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:2750
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:2748
withinHitArea
withinHitArea:
boolean
Inherited from
Composite.withinHitArea
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2756
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:3069
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:2867
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
backgroundColor
Get Signature
get backgroundColor():
RgbaColor
Background color of button. Default is WebColors.Black
Returns
RgbaColor
Set Signature
set backgroundColor(
backgroundColor):void
Background color of button. Default is WebColors.Black
Parameters
• backgroundColor: RgbaColor
Returns
void
Background color of button. Default is WebColors.Black
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:168
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:3059
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
cornerRadius
cornerRadius:
number
draggable?
optionaldraggable:boolean
Can the node be dragged?
fontColor?
optionalfontColor:RgbaColor
Color of text. Default is Constants.DEFAULT_FONT_COLOR (WebColors.Black)
fontName?
optionalfontName:string
Name of font to use for text. Must have been previously loaded
fontNames
fontNames:
undefined|string[]
fontSize?
optionalfontSize:number
Size of text. Default is Constants.DEFAULT_FONT_SIZE (16)
hidden?
optionalhidden:boolean
Is the node, and its children, hidden? (not displayed). Default is false
interpolation?
optionalinterpolation:StringInterpolationMap
Map of placeholders to values for use in string interpolation during localization.
isUserInteractionEnabled?
optionalisUserInteractionEnabled:boolean
Does the node respond to user events, such as taps? Default is false
layout?
optionallayout:Layout
FOR INTERNAL USE ONLY
localize?
optionallocalize:boolean
If true, try to use a localized version of the text. Default is true.
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
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.
text?
optionaltext:string
Text to be displayed
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/button.ts:100
cornerRadius
Get Signature
get cornerRadius():
number
Corner radius of button; can be used to make rounded corners. Default is 9
Returns
number
Set Signature
set cornerRadius(
cornerRadius):void
Corner radius of button; can be used to make rounded corners. Default is 9
Parameters
• cornerRadius: number
Returns
void
Corner radius of button; can be used to make rounded corners. Default is 9
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:216
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:2863
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:3075
fontColor
Get Signature
get fontColor():
RgbaColor
Color of button text. Default is WebColors.White
Returns
RgbaColor
Set Signature
set fontColor(
fontColor):void
Color of button text. Default is WebColors.White
Parameters
• fontColor: RgbaColor
Returns
void
Color of button text. Default is WebColors.White
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:180
fontName
Get Signature
get fontName():
undefined|string
Name of font to use for text. Must have been previously loaded
Returns
undefined | string
Set Signature
set fontName(
fontName):void
Name of font to use for text. Must have been previously loaded
Parameters
• fontName: undefined | string
Returns
void
Name of font to use for text. Must have been previously loaded
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:192
fontNames
Get Signature
get fontNames():
undefined|string[]
Names of multiple fonts to use for text. For example, if a text font and an emoji font are to be used together. Must have been previously loaded
Returns
undefined | string[]
Set Signature
set fontNames(
fontNames):void
Names of multiple fonts to use for text. For example, if a text font and an emoji font are to be used together. Must have been previously loaded
Parameters
• fontNames: undefined | string[]
Returns
void
Names of multiple fonts to use for text. For example, if a text font and an emoji font are to be used together. Must have been previously loaded
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:204
fontSize
Get Signature
get fontSize():
number
Size of button text. Default is 20.
Returns
number
Set Signature
set fontSize(
fontSize):void
Size of button text. Default is 20.
Parameters
• fontSize: number
Returns
void
Size of button text. Default is 20.
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:228
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:2800
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:3073
interpolation
Get Signature
get interpolation():
StringInterpolationMap
Map of placeholders to values for use in string interpolation during localization.
Returns
StringInterpolationMap
Set Signature
set interpolation(
interpolation):void
Map of placeholders to values for use in string interpolation during localization.
Parameters
• interpolation: StringInterpolationMap
Returns
void
Map of placeholders to values for use in string interpolation during localization.
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:240
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
ButtonOptions.isUserInteractionEnabled
Inherited from
Composite.isUserInteractionEnabled
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3071
localize
Get Signature
get localize():
boolean
If true, try to use a localized version of the text. Default is true.
Returns
boolean
Set Signature
set localize(
localize):void
If true, try to use a localized version of the text. Default is true.
Parameters
• localize: boolean
Returns
void
If true, try to use a localized version of the text. Default is true.
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:261
parentSceneAsNode
Get Signature
get parentSceneAsNode():
M2Node
Returns
M2Node
Inherited from
Composite.parentSceneAsNode
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3060
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:3063
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:3067
size
Get Signature
get size():
Size
Size of button. Default is 200 wide by 50 high.
Returns
Size
Set Signature
set size(
size):void
Size of button. Default is 200 wide by 50 high.
Parameters
• size: Size
Returns
void
Size of button. Default is 200 wide by 50 high.
Implementation of
Inherited from
Composite.size
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3061
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:3077
text
Get Signature
get text():
string
Text to be displayed
Returns
string
Set Signature
set text(
text):void
Text to be displayed
Parameters
• text: string
Returns
void
Text to be displayed
Implementation of
Defined in
m2c2kit/packages/addons/src/composites/button.ts:156
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:3065
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
Composite.addChild
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2820
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:2992
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:2857
dispose()
dispose():
void
Returns
void
Overrides
Composite.dispose
Defined in
m2c2kit/packages/addons/src/composites/button.ts:152
draw()
draw(
canvas):void
Parameters
• canvas: Canvas
Returns
void
Overrides
Composite.draw
Defined in
m2c2kit/packages/addons/src/composites/button.ts:314
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:3014
duplicate()
duplicate(
newName?):Button
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/button.ts:283
getDrawableOptions()
protectedgetDrawableOptions():DrawableOptions
Returns
DrawableOptions
Inherited from
Composite.getDrawableOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3052
getNodeOptions()
protectedgetNodeOptions():M2NodeOptions
Returns
M2NodeOptions
Inherited from
Composite.getNodeOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3051
getTextOptions()
protectedgetTextOptions():TextOptions
Returns
TextOptions
Inherited from
Composite.getTextOptions
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:3053
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/button.ts:113
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:2878
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:2885
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:2984
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:2991
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:2977
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:2942
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:2970
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:2962
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:2954
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:2895
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:2932
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:2907
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:2920
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:3034
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:3039
removeAllChildren()
removeAllChildren():
void
Removes all children from the node.
Returns
void
Inherited from
Composite.removeAllChildren
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2833
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
Composite.removeChild
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2840
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
Composite.removeChildren
Defined in
node_modules/@m2c2kit/core/dist/index.d.ts:2847
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:3027
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:2794
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:2777
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:2784
update()
update():
void
Returns
void
Overrides
Composite.update
Defined in
m2c2kit/packages/addons/src/composites/button.ts:310
warmup()
warmup(
canvas):void
Parameters
• canvas: Canvas
Returns
void
Overrides
Composite.warmup
Defined in
m2c2kit/packages/addons/src/composites/button.ts:318