For internal usage.
该组件被附加到的节点。组件总会附加到一个节点。
播放默认动画的循环次数 -1 表示使用配置文件中的默认值; 0 表示无限循环 >0 表示循环次数
是否启用贴图预乘。 当图片的透明区域出现色块时需要关闭该选项,当图片的半透明区域颜色变黑时需要启用该选项。
组件模板缓冲状态 (注意:请不要直接修改它的值)
渲染数据组装器
混合模式枚举类型
后置渲染数据组装器
返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。
当前播放的动画名称。
当前播放的动画名称。
当前的 Armature 名称。
当前的 Armature 名称。
渲染颜色,一般情况下会和贴图颜色相乘。
渲染颜色,一般情况下会和贴图颜色相乘。
是否显示 bone 的 debug 信息。
是否显示 bone 的 debug 信息。
骨骼数据包含了骨骼信息(绑定骨骼动作,slots,渲染顺序,
attachments,皮肤等等)和动画但不持有任何状态。
多个 ArmatureDisplay 可以共用相同的骨骼数据。
骨骼数据包含了骨骼信息(绑定骨骼动作,slots,渲染顺序,
attachments,皮肤等等)和动画但不持有任何状态。
多个 ArmatureDisplay 可以共用相同的骨骼数据。
骨骼数据所需的 Atlas Texture 数据。
骨骼数据所需的 Atlas Texture 数据。
表示该组件自身是否启用。
表示该组件自身是否启用。
表示该组件是否被启用并且所在的节点也处于激活状态。
表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy
调用以后,会在这一帧结束后才真正销毁。
因此从下一帧开始 isValid
就会返回 false,而当前帧内 isValid
仍然会是 true。
如果希望判断当前帧是否调用过 destroy
,请使用 isValid(obj, true)
,不过这往往是特殊的业务需求引起的,通常情况下不需要这样。
模型材质。
模型材质。
当前动画组件维护的挂点数组。要挂载自定义节点到受动画驱动的骨骼上,必须先在此注册挂点。
当前动画组件维护的挂点数组。要挂载自定义节点到受动画驱动的骨骼上,必须先在此注册挂点。
当前骨骼中所有动画的时间缩放率。
当前骨骼中所有动画的时间缩放率。
组件的 uuid,用于编辑器。
Clear all references in the instance.
NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _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; } } }
如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。
The rect to store the result bounding rect
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
The class of component to be retrieved or to be created
向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。
A string for the class name of the component
添加 DragonBones 事件监听器。
The callback that will be invoked when the event is dispatched.
获取 ArmatureDisplay 当前使用的 Armature 对象
构建指定名称的 armature 对象
获取指定的 armature 的所有动画名称。
缓存龙骨数据的key值,换装的时会使用到该值,作为dragonbonesName使用
获取 DragonBones 数据中所有的 armature 名称
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
The class of component to be retrieved or to be created
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
传入参数也可以是脚本的名称。
A string for the class name of the component
递归查找所有子节点中第一个匹配指定类型的组件。
The class of component to be retrieved
递归查找所有子节点中第一个匹配指定类型的组件。
A string for the class name of the component
返回节点上指定类型的所有组件。
The class of components to be retrieved
返回节点上指定类型的所有组件。
A string for the class name of the components
递归查找自身或所有子节点中指定类型的组件。
The class of components to be retrieved
递归查找自身或所有子节点中指定类型的组件。
A string for the class name of the components
获取指定子模型的共享材质资源。
获取指定子模型的材质实例。
获取指定位置可供渲染的材质,如果有材质实例则使用材质实例,如果没有则使用材质资源
使动画缓存失效,之后会在每帧重新计算。
当前是否处于缓存模式。
如果该组件启用,则每帧调用 LateUpdate。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
the delta time in seconds it took to complete the last frame
标记当前组件的渲染数据为已修改状态,这样渲染数据才会重新计算。
Marked necessary to update or not
移除 DragonBones 事件监听器,与 removeEventListener 作用相同。
添加 DragonBones 事件监听器,与 addEventListener 作用相同。
The callback that will be invoked when the event is dispatched.
添加 DragonBones 一次性事件监听器,回调会在第一时间被触发后删除自身。
The callback that will be invoked when the event is dispatched.
播放指定的动画. animName 指定播放动画的名称。 playTimes 指定播放动画的次数。 -1 为使用配置文件中的次数。 0 为无限循环播放。
0 为动画的重复次数。
后置渲染数据组装程序,它会在所有子节点的渲染数据组装完成后被调用。 它可能会组装额外的渲染数据到顶点数据缓冲区,也可能只是重置一些渲染状态。 注意:不要手动调用该函数,除非你理解整个流程。
查询 Socket 路径
Slot name or Bone name
移除 DragonBones 事件监听器。
请求新的渲染数据对象。
The new render data
用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。
调度一个自定义的回调任务。
如果回调任务已调度,那么将不会重复调度它,只会更新时间间隔参数。
The callback function of the task
The time interval between each invocation
The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever
The delay time for the first invocation, Unit: s
调度一个只运行一次的回调任务,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
The callback function of the task
The delay time for the first invocation, Unit: s
若想切换渲染模式,最好在设置'dragonAsset'之前,先设置好渲染模式,否则有运行时开销。 若在编辑中设置渲染模式,则无需担心设置次序的问题。
设置指定子模型的 sharedMaterial,如果对应位置有材质实例则会创建一个对应的材质实例。
获取指定子模型的材质实例。
如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
取消调度一个自定义的回调任务。
The callback function of the task
取消调度所有已调度的回调函数。
更新某个动画缓存, 预计算动画中所有帧数据,由于在单帧计算所有数据,所以较消耗性能。 若想更新缓存,可使用 invalidAnimationCache 方法,具有较高性能。
渲染数据组装程序,这个方法会在所有子节点数据组装之前更新并组装当前组件的渲染数据到 UI 的顶点数据缓冲区中。 一般在 UI 渲染流程中调用,用于组装所有的渲染数据到顶点数据缓冲区。 注意:不要手动调用该函数,除非你理解整个流程。
Generated using TypeDoc
DragonBones 骨骼动画
Armature Display 具有对骨骼数据的引用并且存储了骨骼实例的状态, 它由当前的骨骼动作,slot 颜色,和可见的 slot attachments 组成。
多个 Armature Display 可以使用相同的骨骼数据,其中包括所有的动画,皮肤和 attachments。