Animations

Animations

Type Definitions

Animation

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
key string <optional>
动画将与之关联的键.即.sprite .动画. play(键)
frames string | Array.<Phaser.Types.Animations.AnimationFrame> <optional>
要么是一个字符串,在这种情况下,它将使用具有匹配关键点的纹理的所有帧,要么是一个动画帧配置对象的数组.
sortFrames boolean <optional>
true 如果您为 `frames` 提供一个字符串,您可以选择对框架名称进行数字排序.
defaultTextureKey string <optional>
null 动画的所有帧都将使用纹理的关键点.可以在每帧的基础上被覆盖.
frameRate number <optional>
以每秒帧数表示的回放帧速率(如果持续时间为空,则默认为24)
duration number <optional>
动画应该播放多长时间,以毫秒为单位.如果没有给定其派生自帧率.
skipMissedFrames boolean <optional>
true 如果时间滞后,跳过帧,还是总是提前?
delay number <optional>
0 开始播放前的延迟.以毫秒为单位给出的值.
repeat number <optional>
0 重复动画的次数(-1表示无限)
repeatDelay number <optional>
0 动画重复前的延迟.以毫秒为单位给出的值.
yoyo boolean <optional>
false 动画应不应该yoyo?(反向倒回起点)再重复?
showOnStart boolean <optional>
false 当动画开始播放时,sprite.visible是否应该= true?
hideOnComplete boolean <optional>
false 动画结束时sprite.visible是否应该= false?
Type:
  • object

AnimationFrame

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
key string <optional>
纹理管理器中用于此动画帧的纹理的关键点.
frame string | number <optional>
纹理中用于此动画帧的关键帧或索引号.
duration number <optional>
0 动画帧的持续时间,以毫秒为单位.
visible boolean <optional>
在动画的这一帧中,父游戏对象是否应该可见?
Type:
  • object

GenerateFrameNames

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
prefix string <optional>
'' 如果使用 `frames` 的范围或数组,则为每个结果帧名称追加的字符串.
start number <optional>
0 如果未提供 `frames` ,则返回第一帧的编号.
end number <optional>
0 如果未提供 `frames` ,则返回最后一帧的编号.
suffix string <optional>
'' 如果使用 `frames` 的范围或数组,则为每个结果帧名称追加的字符串.
zeroPad number <optional>
0 每个结果帧编号的最小预期长度.数字将被左填充零,直到它们这么长,然后前置和追加,以创建结果帧名.
outputArray Array.<Phaser.Types.Animations.AnimationFrame> <optional>
[] 要将创建的配置对象追加到的数组.
frames boolean | Array.<number> <optional>
false 如果以数组形式提供,则由 `start` 和 `end` 定义的范围将被忽略,并将使用这些帧号.
Type:
  • object

GenerateFrameNumbers

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
start number <optional>
0 动画的开始帧.
end number <optional>
-1 动画的结束帧.
first boolean | number <optional>
false 放在动画开头的帧,在 `start` 或 `outputArray` 或 `frames` 之前.
outputArray Array.<Phaser.Types.Animations.AnimationFrame> <optional>
[] 要将输出连接到的数组.
frames boolean | Array.<number> <optional>
false 自定义的帧序列.
Type:
  • object

JSONAnimation

Since:
  • 3.0.0
Properties:
Name Type Description
key string 动画将与之关联的键.即.sprite .动画. play(键)
type string 基于帧的动画(与基于骨骼的动画相反)
frames Array.<Phaser.Types.Animations.JSONAnimationFrame> 该动画中动画框架对象的数组.
frameRate number 以每秒帧数表示的回放帧速率(如果持续时间为空,则默认为24)
duration number 动画应该播放多长时间,以毫秒为单位.如果没有给定其派生自帧率.
skipMissedFrames boolean 如果时间滞后,跳过帧,还是总是提前?
delay number 开始播放前的延迟.以毫秒为单位给出的值.
repeat number 重复动画的次数(-1表示无限)
repeatDelay number 动画重复前的延迟.以毫秒为单位给出的值.
yoyo boolean 动画应不应该yoyo?(反向倒回起点)再重复?
showOnStart boolean 当动画开始播放时,sprite.visible是否应该= true?
hideOnComplete boolean 动画结束时sprite.visible是否应该= false?
Type:
  • object

JSONAnimationFrame

Since:
  • 3.0.0
Properties:
Name Type Description
key string 动画框架使用的纹理的关键.
frame string | number 该动画帧使用的纹理中的帧的关键点.
duration number 该帧在回放过程中出现的附加时间(毫秒).
Type:
  • object

JSONAnimations

Since:
  • 3.0.0
Properties:
Name Type Description
anims Array.<Phaser.Types.Animations.JSONAnimation> 添加到动画管理器的所有动画的数组.
globalTimeScale number 动画管理器的全局时间刻度.
Type:
  • object

PlayAnimationConfig

Since:
  • 3.50.0
Properties:
Name Type Attributes Description
key string | Phaser.Animations.Animation 要播放的动画或动画实例的基于字符串的键.
frameRate number <optional>
以每秒帧数表示的回放帧速率(如果持续时间为空,则默认为24)
duration number <optional>
动画应该播放多长时间,以毫秒为单位.如果没有给定其派生自帧率.
delay number <optional>
开始播放前的延迟.以毫秒为单位给出的值.
repeat number <optional>
重复动画的次数(-1表示无限)
repeatDelay number <optional>
动画重复前的延迟.以毫秒为单位给出的值.
yoyo boolean <optional>
动画应不应该yoyo?(反向倒回起点)再重复?
showOnStart boolean <optional>
当动画开始播放时,sprite.visible是否应该= true?
hideOnComplete boolean <optional>
动画结束时sprite.visible是否应该= false?
startFrame number <optional>
开始回放的动画帧.
timeScale number <optional>
用于播放此动画的时间刻度.
Type:
  • object