Animation - YAMI

new Animation(data)

动画播放器

Source:

animation.js, line 166

Parameters:

Name	Type	Description
`data`	`AnimFile`	动画文件数据

Members

anchorX :number

动画锚点在光照纹理中的位置

Source:

animation.js, line 44

Type:

number

anchorY :number

动画锚点在光照纹理中的位置

Source:

animation.js, line 48

Type:

number

angle :number

动画当前角度

Source:

animation.js, line 72

Type:

number

animation :Animation

动画播放器对自己的引用

Source:

animation.js, line 156

Type:

Animation

callbacks :Array.<function()>|null

动画播放结束回调函数列表

Source:

animation.js, line 152

Type:

Array.<function()> | null

contexts :Array.<Object>

图层动画帧上下文列表

Source:

animation.js, line 132

Type:

Array.<Object>

cycleIndex :number

动画循环次数

Source:

animation.js, line 36

Type:

number

data :AnimFile

动画文件数据

Source:

animation.js, line 92

Type:

AnimFile

dirCases :Array.<Object>

动画方向数据列表

Source:

animation.js, line 100

Type:

Array.<Object>

dirMap :Array.<Object>

动画方向映射表

Source:

animation.js, line 96

Type:

Array.<Object>

direction :number

动画当前方向(0, 1, 2, ...)

Source:

animation.js, line 80

Type:

number

emitterCount :number

已激活的粒子发射器数量

Source:

animation.js, line 144

Type:

number

emitters :ParticleEmitterList

已激活的粒子发射器列表

Source:

animation.js, line 140

Type:

ParticleEmitterList

ended :boolean

结束播放

Source:

animation.js, line 16

Type:

boolean

existParticle :boolean

存在粒子

Source:

animation.js, line 148

Type:

boolean

images :Object

精灵ID->图像ID映射表

Source:

animation.js, line 124

Type:

Object

index :number

动画帧当前的位置

Source:

animation.js, line 24

Type:

number

isUIComponent :boolean

是不是UI组件

Source:

animation.js, line 136

Type:

boolean

layers :Array.<Object>

动画当前动作图层

Source:

animation.js, line 104

Type:

Array.<Object>

length :number

当前动作动画帧的数量

Source:

animation.js, line 28

Type:

number

loopStart :number

动画循环开始位置

Source:

animation.js, line 32

Type:

number

mirror :string

动画镜像模式

Source:

animation.js, line 84

Type:

string

motion :Object

动画当前播放的动作对象

Source:

animation.js, line 112

Type:

Object

motionName :string

动画当前播放的动作名称

Source:

animation.js, line 108

Type:

string

motions :Object

名称->动作数据映射表

Source:

animation.js, line 116

Type:

Object

offsetY :number

动画的垂直偏移位置

Source:

animation.js, line 52

Type:

number

opacity :number

动画的不透明度

Source:

animation.js, line 64

Type:

number

parent :Object

父节点对象

Source:

animation.js, line 160

Type:

Object

paused :boolean

暂停播放

Source:

animation.js, line 12

Type:

boolean

position :Object

动画位置对象

Source:

animation.js, line 20

Type:

Object

priority :priority

动画渲染排序的优先级

Source:

animation.js, line 68

Type:

priority

rotatable :boolean

动画是否可旋转

Source:

animation.js, line 56

Type:

boolean

rotation :number

动画的旋转角度(弧度)

Source:

animation.js, line 60

Type:

number

scale :number

动画缩放系数

Source:

animation.js, line 76

Type:

number

speed :number

动画播放速度

Source:

animation.js, line 40

Type:

number

sprites :Object

精灵ID->精灵数据映射表

Source:

animation.js, line 120

Type:

Object

textures :Object

精灵ID->图像纹理映射表

Source:

animation.js, line 128

Type:

Object

tints :Array.<Array.<number>>

动画色调列表

Source:

animation.js, line 88

Type:

Array.<Array.<number>>

visible :boolean

动画可见性

Source:

animation.js, line 8

Type:

boolean

Methods

activate(drawX, drawY, lightX, lightY)

激活动画(当动画可见时)

Source:

animation.js, line 483

Parameters:

Name	Type	Description
`drawX`	`number`	动画的场景像素X
`drawY`	`number`	动画的场景像素Y
`lightX`	`number`	动画的光照采样X
`lightY`	`number`	动画的光照采样Y

deleteTexture(spriteId)

删除精灵图纹理

Source:

animation.js, line 549

Parameters:

Name	Type	Description
`spriteId`	`string`	精灵图ID

destroy()

销毁动画实例

Source:

animation.js, line 716

destroyActiveEmitters()

销毁已激活的粒子发射器

Source:

animation.js, line 746

destroyContextEmitters()

销毁图层上下文的粒子发射器

Source:

animation.js, line 730

draw(lightopt)

绘制动画

Source:

animation.js, line 596

Parameters:

Name	Type	Attributes	Description
`light`	`string`	<optional>	光线采样模式

drawSprite(context, texture, lightopt)

绘制精灵图像

Source:

animation.js, line 621

Parameters:

Name	Type	Attributes	Description
`context`	`Object`		动画图层上下文
`texture`	`ImageTexture`		精灵图纹理
`light`	`string`	<optional>	光线采样模式

emitParticles(deltaTime)

发射粒子

Source:

animation.js, line 561

Parameters:

Name	Type	Description
`deltaTime`	`number`	增量时间(毫秒)

finish()

执行当前动作播放结束回调

Source:

animation.js, line 771

getCurrentTime() → {number}

获取动画当前播放时间

Source:

animation.js, line 314

Returns:

Type:: number

毫秒

getDirectionAngle(direction) → {number}

获取动画方向的角度

Source:

animation.js, line 331

Parameters:

Name	Type	Description
`direction`	`number`	动画方向

Returns:

Type:: number

动画方向的角度(弧度)

getDuration() → {number}

获取动画动作持续时间

Source:

animation.js, line 322

Returns:

Type:: number

毫秒

getTexture(spriteId) → {ImageTexture|null}

获取精灵图纹理

Source:

animation.js, line 495

Parameters:

Name	Type	Description
`spriteId`	`string`	精灵图ID

Returns:

Type:: ImageTexture | null

已加载完成的纹理

loadContexts(contexts)

加载动画图层上下文列表

Source:

animation.js, line 438

Parameters:

Name	Type	Description
`contexts`	`Array.<Object>`	动画图层上下文列表

loadDirCase()

加载动画方向

Source:

animation.js, line 251

loadTexture(spriteId) → {ImageTexture|null}

加载精灵图纹理

Source:

animation.js, line 511

Parameters:

Name	Type	Description
`spriteId`	`string`	精灵图ID

Returns:

Type:: ImageTexture | null

已加载完成或正在加载中的纹理

onFinish(callback)

设置当前动作播放结束时的回调函数

Source:

animation.js, line 758

Parameters:

Name	Type	Description
`callback`	`function`	回调函数

release()

释放资源

Source:

animation.js, line 710

restart()

重新开始播放

Source:

animation.js, line 219

restoreSpriteImages()

恢复精灵图像映射表

Source:

animation.js, line 389

setAngle(angle) → {boolean}

设置动画角度

Source:

animation.js, line 272

Parameters:

Name	Type	Description
`angle`	`number`	弧度

Returns:

Type:: boolean

动画是否成功切换了方向

setDirection(direction) → {boolean}

设置动画方向

Source:

animation.js, line 297

Parameters:

Name	Type	Description
`direction`	`number`	方向

Returns:

Type:: boolean

动画是否成功切换了方向

setDrawingPosition(x, y)

设置动画绘制在屏幕中的位置

Source:

animation.js, line 359

Parameters:

Name	Type	Description
`x`	`number`	场景X
`y`	`number`	场景Y

setMotion(motionName) → {boolean}

设置动画动作

Source:

animation.js, line 229

Parameters:

Name	Type	Description
`motionName`	`string`	动作名称

Returns:

Type:: boolean

操作是否成功

setPosition(position)

设置动画在场景中的位置

Source:

animation.js, line 350

Parameters:

Name	Type	Description
`position`	`Object`	具有场景坐标的对象

setSpriteImages(images)

设置精灵图像映射表

Source:

animation.js, line 383

Parameters:

Name	Type	Description
`images`	`Object`	优先使用的角色精灵图像映射表

update(deltaTime)

更新动画播放进度

Source:

animation.js, line 446

Parameters:

Name	Type	Description
`deltaTime`	`number`	增量时间(毫秒)

updateFrameParameters(contexts, index)

更新当前播放的动画帧参数

Source:

animation.js, line 398

Parameters:

Name	Type	Description
`contexts`	`Array.<Object>`	动画图层上下文列表
`index`	`number`	动画帧当前的位置

updateRotation()

更新旋转角度

Source:

animation.js, line 337

(static) _loadContext(animation, layers, parent, contexts)

加载动画图层上下文

Source:

animation.js, line 871

Parameters:

Name	Type	Description
`animation`	`Animation`	动画播放器实例
`layers`	`Array.<Object>`	动画图层列表
`parent`	`Object`	父级动画图层
`contexts`	`Array.<Object>`	动画图层上下文列表