SpineAnimation
Defined in: display/SpineAnimation.ts:30
Extends
Section titled “Extends”_SpineAnimation
Type Parameters
Section titled “Type Parameters”ANames
Section titled “ANames”ANames extends string = string
A extends Application = Application
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SpineAnimation<
ANames,A>(props?):SpineAnimation<ANames,A>
Defined in: display/SpineAnimation.ts:68
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”SpineAnimation<ANames, A>
Overrides
Section titled “Overrides”_SpineAnimation.constructor
Properties
Section titled “Properties”add:
object
Defined in: mixins/factory/Factory.ts:6
animatedSprite()
Section titled “animatedSprite()”animatedSprite: (
props?) =>AnimatedSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<AnimatedSpriteProps>
Returns
Section titled “Returns”bitmapText()
Section titled “bitmapText()”bitmapText: (
props?) =>BitmapText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”BitmapText
button()
Section titled “button()”button: (
props?) =>Button
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ButtonProps>
Returns
Section titled “Returns”container()
Section titled “container()”container: (
props?) =>Container<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ContainerProps>
Returns
Section titled “Returns”Container<Application<DataSchema, ActionContext, Action, Renderer>>
existing()
Section titled “existing()”existing: <
TEntity>(entity,props?) =>TEntity
Type Parameters
Section titled “Type Parameters”TEntity
Section titled “TEntity”TEntity
Parameters
Section titled “Parameters”entity
Section titled “entity”TEntity
props?
Section titled “props?”Partial<ExistingProps>
Returns
Section titled “Returns”TEntity
flexContainer()
Section titled “flexContainer()”flexContainer: (
props?) =>FlexContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<FlexContainerProps>
Returns
Section titled “Returns”graphics()
Section titled “graphics()”graphics: (
props?) =>Graphics
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<GraphicsProps>
Returns
Section titled “Returns”Graphics
htmlText()
Section titled “htmlText()”htmlText: (
props?) =>HTMLText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<HTMLTextProps>
Returns
Section titled “Returns”HTMLText
particleContainer()
Section titled “particleContainer()”particleContainer: (
props?) =>ParticleContainer<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ParticleContainerProps>
Returns
Section titled “Returns”ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>
spine()
Section titled “spine()”spine: (
props?) =>Spine
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”spineAnimation()
Section titled “spineAnimation()”spineAnimation: <
ANames,A>(props?) =>SpineAnimation<ANames,A>
Type Parameters
Section titled “Type Parameters”ANames
Section titled “ANames”ANames extends string = string
A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”SpineAnimation<ANames, A>
sprite()
Section titled “sprite()”sprite: (
props?) =>Sprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpriteProps>
Returns
Section titled “Returns”Sprite
text()
Section titled “text()”text: (
props?) =>Text
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”Text
texture()
Section titled “texture()”texture: (
props?) =>Texture=resolveTexture
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextureProps>
Returns
Section titled “Returns”Texture
tilingSprite()
Section titled “tilingSprite()”tilingSprite: (
props?) =>TilingSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TilingSpriteProps>
Returns
Section titled “Returns”TilingSprite
toaster()
Section titled “toaster()”toaster: (
toasterConfig?,defaultToastConfig) =>Toaster
Parameters
Section titled “Parameters”toasterConfig?
Section titled “toasterConfig?”Partial<ToasterConfig>
defaultToastConfig?
Section titled “defaultToastConfig?”Partial<ToastConfig> = {}
Returns
Section titled “Returns”uiCanvas()
Section titled “uiCanvas()”uiCanvas: (
props?) =>UICanvas
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<UICanvasFactoryProps>
Returns
Section titled “Returns”svg(
props):Svg
Parameters
Section titled “Parameters”WithRequiredProps<SvgProps, "ctx">
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_SpineAnimation.add
make:
object
Defined in: mixins/factory/Factory.ts:7
animatedSprite()
Section titled “animatedSprite()”animatedSprite: (
props?) =>AnimatedSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<AnimatedSpriteProps>
Returns
Section titled “Returns”bitmapText()
Section titled “bitmapText()”bitmapText: (
props?) =>BitmapText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”BitmapText
button()
Section titled “button()”button: (
props?) =>Button
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ButtonProps>
Returns
Section titled “Returns”container()
Section titled “container()”container: (
props?) =>Container<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ContainerProps>
Returns
Section titled “Returns”Container<Application<DataSchema, ActionContext, Action, Renderer>>
existing()
Section titled “existing()”existing: <
TEntity>(entity,props?) =>TEntity
Type Parameters
Section titled “Type Parameters”TEntity
Section titled “TEntity”TEntity
Parameters
Section titled “Parameters”entity
Section titled “entity”TEntity
props?
Section titled “props?”Partial<ExistingProps>
Returns
Section titled “Returns”TEntity
flexContainer()
Section titled “flexContainer()”flexContainer: (
props?) =>FlexContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<FlexContainerProps>
Returns
Section titled “Returns”graphics()
Section titled “graphics()”graphics: (
props?) =>Graphics
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<GraphicsProps>
Returns
Section titled “Returns”Graphics
htmlText()
Section titled “htmlText()”htmlText: (
props?) =>HTMLText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<HTMLTextProps>
Returns
Section titled “Returns”HTMLText
particleContainer()
Section titled “particleContainer()”particleContainer: (
props?) =>ParticleContainer<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ParticleContainerProps>
Returns
Section titled “Returns”ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>
spine()
Section titled “spine()”spine: (
props?) =>Spine
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”spineAnimation()
Section titled “spineAnimation()”spineAnimation: <
ANames,A>(props?) =>SpineAnimation<ANames,A>
Type Parameters
Section titled “Type Parameters”ANames
Section titled “ANames”ANames extends string = string
A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”SpineAnimation<ANames, A>
sprite()
Section titled “sprite()”sprite: (
props?) =>Sprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpriteProps>
Returns
Section titled “Returns”Sprite
text()
Section titled “text()”text: (
props?) =>Text
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”Text
texture()
Section titled “texture()”texture: (
props?) =>Texture=resolveTexture
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextureProps>
Returns
Section titled “Returns”Texture
tilingSprite()
Section titled “tilingSprite()”tilingSprite: (
props?) =>TilingSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TilingSpriteProps>
Returns
Section titled “Returns”TilingSprite
toaster()
Section titled “toaster()”toaster: (
toasterConfig?,defaultToastConfig) =>Toaster
Parameters
Section titled “Parameters”toasterConfig?
Section titled “toasterConfig?”Partial<ToasterConfig>
defaultToastConfig?
Section titled “defaultToastConfig?”Partial<ToastConfig> = {}
Returns
Section titled “Returns”uiCanvas()
Section titled “uiCanvas()”uiCanvas: (
props?) =>UICanvas
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<UICanvasFactoryProps>
Returns
Section titled “Returns”svg(
props):Svg
Parameters
Section titled “Parameters”WithRequiredProps<SvgProps, "ctx">
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_SpineAnimation.make
onAnimationComplete
Section titled “onAnimationComplete”onAnimationComplete:
Signal<(entry) =>void>
Defined in: display/SpineAnimation.ts:37
onAnimationDispose
Section titled “onAnimationDispose”onAnimationDispose:
Signal<(entry) =>void>
Defined in: display/SpineAnimation.ts:40
onAnimationEnd
Section titled “onAnimationEnd”onAnimationEnd:
Signal<(entry) =>void>
Defined in: display/SpineAnimation.ts:41
onAnimationEvent
Section titled “onAnimationEvent”onAnimationEvent:
Signal<(entry,event) =>void>
Defined in: display/SpineAnimation.ts:42
onAnimationInterrupt
Section titled “onAnimationInterrupt”onAnimationInterrupt:
Signal<(entry) =>void>
Defined in: display/SpineAnimation.ts:39
onAnimationStart
Section titled “onAnimationStart”onAnimationStart:
Signal<(entry) =>void>
Defined in: display/SpineAnimation.ts:38
onPaused
Section titled “onPaused”onPaused:
Signal<(entry) =>void>
Defined in: display/SpineAnimation.ts:44
onResumed
Section titled “onResumed”onResumed:
Signal<(entry) =>void>
Defined in: display/SpineAnimation.ts:45
paused
Section titled “paused”paused:
boolean
Defined in: display/SpineAnimation.ts:35
signalConnections
Section titled “signalConnections”signalConnections:
SignalConnections
Defined in: mixins/signals.ts:9
Inherited from
Section titled “Inherited from”_SpineAnimation.signalConnections
spine:
Spine
Defined in: display/SpineAnimation.ts:34
Accessors
Section titled “Accessors”animationNames
Section titled “animationNames”Get Signature
Section titled “Get Signature”get animationNames():
ANames[]
Defined in: display/SpineAnimation.ts:53
Returns
Section titled “Returns”ANames[]
Get Signature
Section titled “Get Signature”get app():
A
Defined in: display/SpineAnimation.ts:49
Returns
Section titled “Returns”A
currentEntry
Section titled “currentEntry”Get Signature
Section titled “Get Signature”get currentEntry():
null|TrackEntry
Defined in: display/SpineAnimation.ts:57
Returns
Section titled “Returns”null | TrackEntry
elapsedAnimationTime
Section titled “elapsedAnimationTime”Get Signature
Section titled “Get Signature”get elapsedAnimationTime():
number
Defined in: display/SpineAnimation.ts:61
Returns
Section titled “Returns”number
Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: mixins/signals.ts:13
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_SpineAnimation.addSignalConnection
connectAction()
Section titled “connectAction()”connectAction(…
args):void
Defined in: mixins/signals.ts:15
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_SpineAnimation.connectAction
connectSignal()
Section titled “connectSignal()”connectSignal(…
args):void
Defined in: mixins/signals.ts:14
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_SpineAnimation.connectSignal
destroy()
Section titled “destroy()”destroy():
void
Defined in: display/SpineAnimation.ts:110
Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy.
Returns
Section titled “Returns”void
Example
Section titled “Example”container.destroy();container.destroy(true);container.destroy({ children: true });container.destroy({ children: true, texture: true, textureSource: true });Overrides
Section titled “Overrides”_SpineAnimation.destroy
getCurrentAnimation()
Section titled “getCurrentAnimation()”getCurrentAnimation(
trackIndex):ANames
Defined in: display/SpineAnimation.ts:115
Parameters
Section titled “Parameters”trackIndex
Section titled “trackIndex”number = 0
Returns
Section titled “Returns”ANames
pause()
Section titled “pause()”pause():
void
Defined in: display/SpineAnimation.ts:123
Returns
Section titled “Returns”void
resume()
Section titled “resume()”resume():
void
Defined in: display/SpineAnimation.ts:133
Returns
Section titled “Returns”void
setAnimation()
Section titled “setAnimation()”setAnimation(
name,loop,tracklndex):void
Defined in: display/SpineAnimation.ts:119
Parameters
Section titled “Parameters”ANames
boolean = false
tracklndex
Section titled “tracklndex”number = 0
Returns
Section titled “Returns”void
togglePause()
Section titled “togglePause()”togglePause():
void
Defined in: display/SpineAnimation.ts:142
Returns
Section titled “Returns”void