构造函数

new Animation(game, parent, name, frameData, frames, frameRate, loop)

一个动画实例包含一个单一的动画和控件来播放它。

参数

名称 类型 参数 默认值 描述
game Phaser.Game 一个参考目前正在运行的游戏。
parent Phaser.Sprite 一个参考的所有者,这个动画。
name string 此动画的唯一名称,用于播放命令。
frameData Phaser.FrameData 包含这个动画使用的所有帧的framedata对象。
frames Array.<number> | Array.<string> 指示在哪个顺序中播放的数字或字符串的数组。
frameRate number <optional> 60 动画应该发挥的速度。每秒的速度是按帧的。
loop boolean <optional> false 动画是否循环或只是扮演一次。

公共属性

currentFrame : Phaser.Frame

当前显示的动画帧。

Source code: animation/Animation.js (Line 125)

delay : number

动画的每一帧之间的毫秒的延迟,基于给定的帧率。

Source code: animation/Animation.js (Line 58)

enableUpdate : boolean

获取或设置这个动画将派遣OnUpdate事件对结构变化。

Source code: animation/Animation.js (Line 731)

frame : number

获取或设置当前帧索引并更新用于显示的纹理缓存。

Source code: animation/Animation.js (Line 670)

[readonly] frameTotal : number

在当前加载的framedata帧的总数,或1如果没有framedata加载。

Source code: animation/Animation.js (Line 657)

game : Phaser.Game

一个参考目前正在运行的游戏。

Source code: animation/Animation.js (Line 29)

isFinished : boolean

动画的完成状态。设置为真的一次播放完成,假在播放过程中。

Source code: animation/Animation.js (Line 80)

isPaused : boolean

暂停状态的动画。

Source code: animation/Animation.js (Line 92)

isPlaying : boolean

动画的播放状态。设置为假一次播放完成后,真实再现。

Source code: animation/Animation.js (Line 86)

killOnComplete : boolean

动画制作完成后,该动画的父是什么?

Source code: animation/Animation.js (Line 74)

loop : boolean

动画的循环状态。

Source code: animation/Animation.js (Line 63)

loopCount : number

开始的时候动画环自去年数。

Source code: animation/Animation.js (Line 68)

name : string

给定这个动画的用户定义的名称。

Source code: animation/Animation.js (Line 46)

onComplete : Phaser.Signal

此事件被发送时,此动画完成播放。如果动画设置为循环这是永远不会被解雇,听半实物代替。

Source code: animation/Animation.js (Line 146)

onLoop : Phaser.Signal

此事件被发送时,此动画循环。

Source code: animation/Animation.js (Line 151)

onStart : Phaser.Signal

此事件被发送时,此动画开始播放。

Source code: animation/Animation.js (Line 130)

onUpdate : Phaser.Signal | null

此事件是在动画更改帧时发出的。

Source code: animation/Animation.js (Line 141)

paused : boolean

获取并设置此动画的暂停状态。

Source code: animation/Animation.js (Line 623)

speed : number

获取或设置每秒帧动画的当前速度。在播放动画中改变这将从下一帧的效果。最小值为1。

Source code: animation/Animation.js (Line 708)

公共方法

<static> generateFrameNames(prefix, start, stop, suffix, zeroPad) → {Array.<string>}

真正方便的功能是当您创建动画数据的数组,但它使用的帧名称和不数字。

参数

名称 类型 参数 默认值 描述
prefix string 文件名的开始。如果文件名是“爆炸”的话,0001个大的前缀会被“爆炸”。
start number 按顺序依次计数的数目。如果你的框架是“explosion_0001 '到' explosion_0034”开始是1。

stop number <以数为数。如果你的框架是“explosion_0001 '到' explosion_0034 '停止值是34。

suffix string <optional>
'' 文件名的结尾。如果文件名是“explosion_0001-large的前缀将'大'。

zeroPad number <optional>
0 “零”的数目,以填补最小和最大值。如果你的框架是“explosion_0001 '到' explosion_0034然后zeropad 4。

Source code: animation/Animation.js (Line 759)


complete()

在动画播放结束时调用。

Source code: animation/Animation.js (Line 593)


destroy()

清理这个动画准备删除。空值和参考。

Source code: animation/Animation.js (Line 559)


next(quantity)

由给定的动画帧的数目的进步,考虑到考虑的循环值。

参数

名称 类型 参数 默认值 描述
quantity number <optional>
1 “帧的数目要提前。”

Source code: animation/Animation.js (Line 482)


onPause()

当游戏进入暂停状态时调用。

Source code: animation/Animation.js (Line 329)


onResume()

在暂停状态时调用游戏恢复。

Source code: animation/Animation.js (Line 343)


play(frameRate, loop, killOnComplete) → {Phaser.Animation}

玩这个动画。

参数

名称 类型 参数 默认值 描述
frameRate number <optional>
null

帧率播放动画。每秒的速度是按帧的。如果不提供预先设定的帧率的动画使用。

loop boolean <optional>
false

的动画循环播放后。如果没有提供先前设置的动画的循环值,则使用。

killOnComplete boolean <optional>
false 当动画完成时,如果设置为真(仅当循环=假)父精灵将被杀死。

Source code: animation/Animation.js (Line 161)


previous(quantity)

在动画中向后移动给定的帧的数目,考虑到循环的值。

参数

名称 类型 参数 默认值 描述
quantity number <optional>
1 <移回的帧的数目。

Source code: animation/Animation.js (Line 514)


restart()

这一集动画回到第一帧和重新启动动画。

Source code: animation/Animation.js (Line 212)


setFrame(frameId, useLocalFrameIndex)

将此动画播放设置为给定的帧。

参数

名称 类型 参数 默认值 描述
frameId string | number <optional>
该帧的标识符设置为。可以是框架的名称,框的精灵索引,或是动画局部帧索引。
useLocalFrameIndex boolean <optional>
false

如果你frameid提供一个号码,它应该使用的framedata数字指标,或从0开始索引帧索引本地动画。

Source code: animation/Animation.js (Line 240)


stop(resetFrame, dispatchComplete)

停止播放该动画并将其设置为一个已完成的状态。如果提供了resetframe将停止播放和设置框架,首先在动画。

参数

名称 类型 参数 默认值 描述
resetFrame boolean <optional>
false
如果真的在动画停止帧值将被设置为该动画的第一帧。

dispatchComplete boolean <optional>
false

派遣animation.oncomplete和parent.onanimationcomplete事件吗?< /对

Source code: animation/Animation.js (Line 298)


update()

更新这个动画。由animationmanager自动调用。

Source code: animation/Animation.js (Line 357)


updateFrameData(frameData)

变化的framedata对象这个动画是使用。

参数

名称 类型 参数 默认值 描述
frameData Phaser.FrameData

包含这个动画使用的所有帧的framedata对象。

Source code: animation/Animation.js (Line 546)