Animation 类型

继承于 Component, EventTarget(mixin)

模块: cc

Animation 组件用于播放动画。

Animation 提供了一系列可注册的事件:

  • play : 开始播放时
  • stop : 停止播放时
  • pause : 暂停播放时
  • resume : 恢复播放时
  • lastframe : 假如动画循环次数大于 1,当动画播放到最后一帧时
  • finished : 动画播放完成时

索引

属性(properties)
  • defaultClip AnimationClip 在勾选自动播放或调用 play() 时默认播放的动画剪辑。
  • currentClip AnimationClip 当前播放的动画剪辑。
  • _clips AnimationClip[] 通过脚本可以访问并播放的 AnimationClip 列表。
  • playOnLoad Boolean 是否在运行游戏后自动播放默认动画剪辑。
  • __eventTargets Array 注册所有相关的 EventTargets,所有事件回调将在 _onPreDestroy 中删除。
  • node Node 该组件被附加到的节点。
  • uuid String 组件的 uuid,用于编辑器。
  • _enabled Boolean
  • enabled Boolean 表示该组件自身是否启用。
  • enabledInHierarchy Boolean 表示该组件是否被启用并且所在的节点也处于激活状态。
  • _isOnLoadCalled Number 返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。
  • _name String
  • _objFlags Number
  • name String 该对象的名称。
  • isValid Boolean 表示该对象是否可用(被 destroy 后将不可用)。
方法
  • getClips 获取动画组件上的所有动画剪辑。
  • play 播放指定的动画,并且停止当前正在播放动画。
  • playAdditive 播放指定的动画(将不会停止当前播放的动画)。
  • stop 停止指定的动画。
  • pause 暂停当前或者指定的动画。
  • resume 重新播放指定的动画,如果没有指定名字,则重新播放当前正在播放的动画。
  • setCurrentTime 设置指定动画的播放时间。
  • getAnimationState 获取当前或者指定的动画状态,如果未找到指定动画剪辑则返回 null。
  • hasAnimationState 通过名称判断是否包含某动画状态。
  • addClip 添加动画剪辑,并且可以重新设置该动画剪辑的名称。
  • removeClip 如果依赖于 clip 的 AnimationState 正在播放或者 clip 是 defaultClip 的话,默认是不会删除 clip 的。
  • sample 对指定或当前动画进行采样。
  • on 注册动画事件回调。
  • off 取消注册动画事件回调。
  • hasEventListener 检查事件目标对象是否有为特定类型的事件注册的回调。
  • targetOff 在当前 EventTarget 上删除指定目标(target 参数)注册的所有事件监听器。
  • once 注册事件目标的特定事件类型回调,回调会在第一时间被触发后删除自身。
  • dispatchEvent 通过事件对象派发事件
  • clear 销毁记录的事件
  • update 如果该组件启用,则每帧调用 update。
  • lateUpdate 如果该组件启用,则每帧调用 LateUpdate。
  • __preload __preload is called before every onLoad....
  • onLoad 当附加到一个激活的节点上或者其节点第一次激活时候调用。
  • start 如果该组件第一次启用,则在所有组件的 update 之前调用。
  • onEnable 当该组件被启用,并且它的节点也激活时。
  • onDisable 当该组件被禁用或节点变为无效时调用。
  • onDestroy 该方法为生命周期方法,父类未必会有实现。
  • onFocusInEditor
  • onLostFocusInEditor
  • resetInEditor 用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。
  • addComponent 向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。
  • getComponent 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
  • getComponents 返回节点上指定类型的所有组件。
  • getComponentInChildren 递归查找所有子节点中第一个匹配指定类型的组件。
  • getComponentsInChildren 递归查找自身或所有子节点中指定类型的组件
  • _getLocalBounds 以便编辑器的场景视图可以正确地执行点选测试。
  • onRestore onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。
  • schedule 调度一个自定义的回调函数。
  • scheduleOnce 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
  • unschedule 取消调度一个自定义的回调函数。
  • unscheduleAllCallbacks 取消调度所有已调度的回调函数:定制的回调函数以及 update 回调函数。
  • destroy 销毁该对象,并释放所有它对其它对象的引用。
  • _destruct 清除实例中的所有引用。
  • _onPreDestroy 在对象被销毁之前调用。
  • _serialize 为此对象定制序列化。
  • _deserialize 从自定义序列化数据初始化此对象。

Details

属性(properties)

defaultClip

在勾选自动播放或调用 play() 时默认播放的动画剪辑。

meta description
类型 AnimationClip
定义于 cocos2d/core/components/CCAnimation.js:152
currentClip

当前播放的动画剪辑。

meta description
类型 AnimationClip
定义于 cocos2d/core/components/CCAnimation.js:181
_clips

通过脚本可以访问并播放的 AnimationClip 列表。

meta description
类型 AnimationClip[]
定义于 cocos2d/core/components/CCAnimation.js:212
playOnLoad

是否在运行游戏后自动播放默认动画剪辑。

meta description
类型 Boolean
定义于 cocos2d/core/components/CCAnimation.js:226
__eventTargets

注册所有相关的 EventTargets,所有事件回调将在 _onPreDestroy 中删除。

meta description
类型 Array
定义于 cocos2d/core/components/CCComponent.js:63
node

该组件被附加到的节点。组件总会附加到一个节点。

meta description
类型 Node
定义于 cocos2d/core/components/CCComponent.js:80
示例
cc.log(comp.node);
uuid

组件的 uuid,用于编辑器。

meta description
类型 String
定义于 cocos2d/core/components/CCComponent.js:111
示例
cc.log(comp.uuid);
_enabled
meta description
类型 Boolean
定义于 cocos2d/core/components/CCComponent.js:152
enabled

表示该组件自身是否启用。

meta description
类型 Boolean
定义于 cocos2d/core/components/CCComponent.js:159
示例
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

表示该组件是否被启用并且所在的节点也处于激活状态。

meta description
类型 Boolean
定义于 cocos2d/core/components/CCComponent.js:191
示例
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。

meta description
类型 Number
定义于 cocos2d/core/components/CCComponent.js:211
示例
cc.log(this._isOnLoadCalled > 0);
_name
meta description
类型 String
定义于 cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
类型 Number
定义于 cocos2d/core/platform/CCObject.js:83
name

该对象的名称。

meta description
类型 String
定义于 cocos2d/core/platform/CCObject.js:240
示例
obj.name = "New Obj";
isValid

表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

meta description
类型 Boolean
定义于 cocos2d/core/platform/CCObject.js:258
示例
var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

方法

getClips

获取动画组件上的所有动画剪辑。

meta description
返回 AnimationClip[]
定义于 cocos2d/core/components/CCAnimation.js:269
play

播放指定的动画,并且停止当前正在播放动画。如果没有指定动画,则播放默认动画。

meta description
返回 AnimationState
定义于 cocos2d/core/components/CCAnimation.js:279
参数列表
  • name String The name of animation to play. If no name is supplied then the default animation will be played.
  • startTime Number play an animation from startTime
示例
var animCtrl = this.node.getComponent(cc.Animation);
animCtrl.play("linear");
playAdditive

播放指定的动画(将不会停止当前播放的动画)。如果没有指定动画,则播放默认动画。

meta description
返回 AnimationState
定义于 cocos2d/core/components/CCAnimation.js:296
参数列表
  • name String The name of animation to play. If no name is supplied then the default animation will be played.
  • startTime Number play an animation from startTime
示例
// linear_1 and linear_2 at the same time playing.
var animCtrl = this.node.getComponent(cc.Animation);
animCtrl.playAdditive("linear_1");
animCtrl.playAdditive("linear_2");
stop

停止指定的动画。如果没有指定名字,则停止当前正在播放的动画。

meta description
定义于 cocos2d/core/components/CCAnimation.js:345
参数列表
  • name String The animation to stop, if not supplied then stops all playing animations.
pause

暂停当前或者指定的动画。如果没有指定名字,则暂停当前正在播放的动画。

meta description
定义于 cocos2d/core/components/CCAnimation.js:367
参数列表
  • name String The animation to pauses, if not supplied then pauses all playing animations.
resume

重新播放指定的动画,如果没有指定名字,则重新播放当前正在播放的动画。

meta description
定义于 cocos2d/core/components/CCAnimation.js:388
参数列表
  • name String The animation to resumes, if not supplied then resumes all paused animations.
setCurrentTime

设置指定动画的播放时间。如果没有指定名字,则设置当前播放动画的播放时间。

meta description
定义于 cocos2d/core/components/CCAnimation.js:409
参数列表
  • time Number The time to go to
  • name String Specified animation name, if not supplied then make all animations go to the time.
getAnimationState

获取当前或者指定的动画状态,如果未找到指定动画剪辑则返回 null。

meta description
返回 AnimationState
定义于 cocos2d/core/components/CCAnimation.js:429
参数列表
hasAnimationState

通过名称判断是否包含某动画状态。也可用来判断是否已经添加了同名 clip.

meta description
返回 boolean
定义于 cocos2d/core/components/CCAnimation.js:458
参数列表
addClip

添加动画剪辑,并且可以重新设置该动画剪辑的名称。

meta description
返回 AnimationState
定义于 cocos2d/core/components/CCAnimation.js:470
参数列表
removeClip

从动画列表中移除指定的动画剪辑,
如果依赖于 clip 的 AnimationState 正在播放或者 clip 是 defaultClip 的话,默认是不会删除 clip 的。 但是如果 force 参数为 true,则会强制停止该动画,然后移除该动画剪辑和相关的动画。这时候如果 clip 是 defaultClip,defaultClip 将会被重置为 null。

meta description
定义于 cocos2d/core/components/CCAnimation.js:511
参数列表
  • clip AnimationClip
  • force Boolean If force is true, then will always remove the clip and any animation states based on it.
sample

对指定或当前动画进行采样。你可以手动将动画设置到某一个状态,然后采样一次。

meta description
定义于 cocos2d/core/components/CCAnimation.js:564
参数列表
on

注册动画事件回调。 回调的事件里将会附上发送事件的 AnimationState。 当播放一个动画时,会自动将事件注册到对应的 AnimationState 上,停止播放时会将事件从这个 AnimationState 上取消注册。

meta description
返回 Function
定义于 cocos2d/core/components/CCAnimation.js:586
参数列表
  • type String A string representing the event type to listen for.
  • callback Function The callback that will be invoked when the event is dispatched.
                           The callback is ignored if it is a duplicate (the callbacks are unique).
    
  • state cc.AnimationState
  • target Object The target (this object) to invoke the callback, can be null
  • useCapture Boolean When set to true, the capture argument prevents callback
                           from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
                           When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
                           Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
    
示例
onPlay: function (type, state) {
    // callback
}

// register event to all animation
animation.on('play', this.onPlay, this);
off

取消注册动画事件回调。

meta description
定义于 cocos2d/core/components/CCAnimation.js:635
参数列表
  • type String A string representing the event type being removed.
  • callback Function The callback to remove.
  • target Object The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
  • useCapture Boolean Specifies whether the callback being removed was registered as a capturing callback or not.
                           If not specified, useCapture defaults to false. If a callback was registered twice,
                           one with capture and one without, each must be removed separately. Removal of a capturing callback
                           does not affect a non-capturing version of the same listener, and vice versa.
    
示例
// unregister event to all animation
animation.off('play', this.onPlay, this);
hasEventListener

检查事件目标对象是否有为特定类型的事件注册的回调。

meta description
返回 Boolean
定义于 cocos2d/core/event/event-target.js:69
参数列表
  • type String The type of event.
targetOff

在当前 EventTarget 上删除指定目标(target 参数)注册的所有事件监听器。 这个函数无法删除当前 EventTarget 的所有事件监听器,也无法删除 target 参数所注册的所有事件监听器。 这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。

meta description
定义于 cocos2d/core/event/event-target.js:163
参数列表
  • target Object The target to be searched for all related listeners
once

注册事件目标的特定事件类型回调,回调会在第一时间被触发后删除自身。

meta description
定义于 cocos2d/core/event/event-target.js:182
参数列表
  • type String A string representing the event type to listen for.
  • callback Function The callback that will be invoked when the event is dispatched.
                           The callback is ignored if it is a duplicate (the callbacks are unique).
    
    • arg1 Any arg1
    • arg2 Any arg2
    • arg3 Any arg3
    • arg4 Any arg4
    • arg5 Any arg5
  • target Object The target (this object) to invoke the callback, can be null
示例
eventTarget.once('fire', function () {
    cc.log("this is the callback and will be invoked only once");
}, node);
dispatchEvent

通过事件对象派发事件

meta description
定义于 cocos2d/core/event/event-target.js:208
参数列表
clear

销毁记录的事件

meta description
定义于 cocos2d/core/event/event-target.js:221
update

如果该组件启用,则每帧调用 update。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:232
参数列表
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

如果该组件启用,则每帧调用 LateUpdate。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:243
参数列表
  • dt Number the delta time in seconds it took to complete the last frame
__preload

__preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

meta description
定义于 cocos2d/core/components/CCComponent.js:254
onLoad

当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行,这能用于安排脚本的初始化顺序。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:265
start

如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:278
onEnable

当该组件被启用,并且它的节点也激活时。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:291
onDisable

当该组件被禁用或节点变为无效时调用。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:301
onDestroy

当该组件被销毁时调用
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

meta description
定义于 cocos2d/core/components/CCComponent.js:311
onFocusInEditor
meta description
定义于 cocos2d/core/components/CCComponent.js:321
onLostFocusInEditor
meta description
定义于 cocos2d/core/components/CCComponent.js:326
resetInEditor

用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

meta description
定义于 cocos2d/core/components/CCComponent.js:331
addComponent

向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。

meta description
返回 Component
定义于 cocos2d/core/components/CCComponent.js:341
参数列表
  • typeOrClassName Function | String the constructor or the class name of the component to add
示例
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
getComponent

获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。

meta description
返回 Component
定义于 cocos2d/core/components/CCComponent.js:359
参数列表
示例
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

返回节点上指定类型的所有组件。

meta description
返回 Component[]
定义于 cocos2d/core/components/CCComponent.js:383
参数列表
示例
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

递归查找所有子节点中第一个匹配指定类型的组件。

meta description
返回 Component
定义于 cocos2d/core/components/CCComponent.js:401
参数列表
示例
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

递归查找自身或所有子节点中指定类型的组件

meta description
返回 Component[]
定义于 cocos2d/core/components/CCComponent.js:419
参数列表
示例
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。

meta description
定义于 cocos2d/core/components/CCComponent.js:439
参数列表
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。然而,在极端的情况下,它可能无法良好运作。
那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

同样的,编辑可能无法在极端情况下正确地重置您的组件。如果你需要支持组件重置菜单,则需要在该方法中手工同步组件属性到“内部状态”。一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。

meta description
定义于 cocos2d/core/components/CCComponent.js:452
schedule

调度一个自定义的回调函数。
如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

meta description
定义于 cocos2d/core/components/CCComponent.js:544
参数列表
  • callback function The callback function
  • interval Number Tick interval in seconds. 0 means tick every frame.
  • repeat Number The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.
  • delay Number The amount of time that the first tick will wait before execution. Unit: s
示例
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
scheduleOnce

调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

meta description
定义于 cocos2d/core/components/CCComponent.js:582
参数列表
  • callback function A function wrapped as a selector
  • delay Number The amount of time that the first tick will wait before execution. Unit: s
示例
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
unschedule

取消调度一个自定义的回调函数。

meta description
定义于 cocos2d/core/components/CCComponent.js:599
参数列表
  • callback_fn function A function wrapped as a selector
示例
this.unschedule(_callback);
unscheduleAllCallbacks

取消调度所有已调度的回调函数:定制的回调函数以及 update 回调函数。动作不受此方法影响。

meta description
定义于 cocos2d/core/components/CCComponent.js:615
示例
this.unscheduleAllCallbacks();
destroy

销毁该对象,并释放所有它对其它对象的引用。
实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始,该对象将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

meta description
返回 Boolean
定义于 cocos2d/core/platform/CCObject.js:293
示例
obj.destroy();
_destruct

清除实例中的所有引用。

注意:此方法不会清除在 CCObject 实例中定义的 gettersetter。如果需要,你可以重写 _destruct 方法。例如:

_destruct: function () {
    for (var key in this) {
        if (this.hasOwnProperty(key)) {
            switch (typeof this[key]) {
                case 'string':
                    this[key] = '';
                    break;
                case 'object':
                case 'function':
                    this[key] = null;
                    break;
        }
    }
}
meta description
定义于 cocos2d/core/platform/CCObject.js:427
_onPreDestroy

在对象被销毁之前调用。

meta description
定义于 cocos2d/core/platform/CCObject.js:483
_serialize

为此对象定制序列化。

meta description
返回 object
定义于 cocos2d/core/platform/CCObject.js:511
参数列表
_deserialize

从自定义序列化数据初始化此对象。

meta description
定义于 cocos2d/core/platform/CCObject.js:524
参数列表
  • data Object the serialized json data
  • ctx _Deserializer

条与 "" 相匹配的结果

    没有与 "" 匹配的结果