Sprite


继承 Sprite View 模块 hilo/view/Sprite 依赖 hilo/core/Hilo, hilo/core/Class, hilo/view/View, hilo/view/Drawable 源码 Sprite.js
动画精灵类。


属性概览

显示继承属性
属性 定义于
currentFrame:number
当前播放帧的索引。从0开始。只读属性。
Sprite
interval:number
精灵动画的帧间隔。如果timeBased为true,则单位为毫秒,否则为帧数。
Sprite
loop:boolean
判断精灵是否可以循环播放。默认为true。
Sprite
onEnterFrame:Function
精灵动画的播放头进入新帧时的回调方法。默认值为null。此方法已废弃,请使用addFrameCallback方法。
Sprite
paused:boolean
判断精灵是否暂停。默认为false。
Sprite
timeBased:boolean
指定精灵动画是否是以时间为基准。默认为false,即以帧为基准。
Sprite

方法概览

显示继承方法
方法 定义于
Sprite(properties)
构造函数
Sprite
addFrame(frame:Object, startIndex:Int):Sprite
往精灵动画序列中增加帧。
Sprite
getFrame(indexOrName:Object):Object
获取精灵动画序列中指定的帧。
Sprite
getFrameIndex(frameValue:Object):Object
获取精灵动画序列中指定帧的索引位置。
Sprite
getNumFrames():Uint
返回精灵动画的总帧数。
Sprite
goto(indexOrName:Object, pause:Boolean):Sprite
跳转精灵动画到指定的帧。
Sprite
play():Sprite
播放精灵动画。
Sprite
setFrame(frame:Object, index:Int):Sprite
设置精灵动画序列指定索引位置的帧。
Sprite
setFrameCallback(frame:Int|String, callback:Function):Sprite
设置指定帧的回调函数。即每当播放头进入指定帧时调用callback函数。若callback为空,则会删除回调函数。
Sprite
stop():Sprite
暂停播放精灵动画。
Sprite

属性详情

currentFrame:number
当前播放帧的索引。从0开始。只读属性。
interval:number
精灵动画的帧间隔。如果timeBased为true,则单位为毫秒,否则为帧数。
loop:boolean
判断精灵是否可以循环播放。默认为true。
onEnterFrame:Function
精灵动画的播放头进入新帧时的回调方法。默认值为null。此方法已废弃,请使用addFrameCallback方法。
paused:boolean
判断精灵是否暂停。默认为false。
timeBased:boolean
指定精灵动画是否是以时间为基准。默认为false,即以帧为基准。

构造函数

Sprite(properties)
parameters
properties — 创建对象的属性参数。可包含此类所有可写属性。此外还包括:
  • frames - 精灵动画的帧数据对象。

方法详情

addFrame(frame:Object, startIndex:Int):Sprite
往精灵动画序列中增加帧。
parameters
frame:Object — 要增加的精灵动画帧数据。
startIndex:Int — 开始增加帧的索引位置。若不设置,默认为在末尾添加。
return
Sprite — Sprite对象本身。
getFrame(indexOrName:Object):Object
获取精灵动画序列中指定的帧。
parameters
indexOrName:Object — 要获取的帧的索引位置或别名。
return
Object — 精灵帧对象。
getFrameIndex(frameValue:Object):Object
获取精灵动画序列中指定帧的索引位置。
parameters
frameValue:Object — 要获取的帧的索引位置或别名。
return
Object — 精灵帧对象。
getNumFrames():Uint
返回精灵动画的总帧数。
return
Uint — 精灵动画的总帧数。
goto(indexOrName:Object, pause:Boolean):Sprite
跳转精灵动画到指定的帧。
parameters
indexOrName:Object — 要跳转的帧的索引位置或别名。
pause:Boolean — 指示跳转后是否暂停播放。
return
Sprite — Sprite对象本身。
play():Sprite
播放精灵动画。
return
Sprite — Sprite对象本身。
setFrame(frame:Object, index:Int):Sprite
设置精灵动画序列指定索引位置的帧。
parameters
frame:Object — 要设置的精灵动画帧数据。
index:Int — 要设置的索引位置。
return
Sprite — Sprite对象本身。
setFrameCallback(frame:Int|String, callback:Function):Sprite
设置指定帧的回调函数。即每当播放头进入指定帧时调用callback函数。若callback为空,则会删除回调函数。
parameters
frame:Int|String — 要指定的帧的索引位置或别名。
callback:Function — 指定回调函数。
return
Sprite — 精灵本身。
stop():Sprite
暂停播放精灵动画。
return
Sprite — Sprite对象本身。