Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Skeleton

Spine 骨骼动画

(Skeleton 具有对骨骼数据的引用并且存储了骨骼实例的状态, 它由当前的骨骼动作,slot 颜色,和可见的 slot attachments 组成。
多个 Skeleton 可以使用相同的骨骼数据,其中包括所有的动画,皮肤和 attachments。

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private __prefab

__prefab: CompPrefabInfo | null = null

Protected _accTime

_accTime: number = 0

Protected _animationName

_animationName: string = ""

Protected _animationQueue

_animationQueue: AnimationItem[] = []

Protected _assembler

_assembler: IAssembler | null = null

Protected _blendHash

_blendHash: number = 0

Protected _blendState

_blendState: BlendState = new BlendState()

Protected _cacheMode

_cacheMode: AnimationCacheMode = AnimationCacheMode.REALTIME

Protected _cachedSockets

_cachedSockets: Map<string, number> = new Map<string, number>()

Optional _clipper

_clipper: spine.SkeletonClipping

Protected _color

_color: Color = Color.WHITE.clone()

_curFrame

_curFrame: AnimationFrame | null = null

Protected _customMaterial

_customMaterial: Material | null = null

Protected _debugBones

_debugBones: boolean = false

Protected _debugMesh

_debugMesh: boolean = false

_debugRenderer

_debugRenderer: Graphics | null

Protected _debugSlots

_debugSlots: boolean = false

Protected _defaultCacheMode

_defaultCacheMode: AnimationCacheMode = AnimationCacheMode.REALTIME

Protected _delegateSrc

_delegateSrc: Node | null = null

Protected _dstBlendFactor

_dstBlendFactor: BlendFactor = BlendFactor.ONE_MINUS_SRC_ALPHA

_effectDelegate

_effectDelegate: VertexEffectDelegate | null | undefined = null

Private _enabled

_enabled: boolean = true

_endEntry

_endEntry: any

_endSlotIndex

_endSlotIndex: any

Protected _enumAnimations

_enumAnimations: any = Enum({})

Protected _enumSkins

_enumSkins: any = Enum({})

_frameCache

_frameCache: AnimationCache | null = null

Protected _headAniInfo

_headAniInfo: AnimationItem | null = null

Private _id

_id: string = idGenerator.getNewId()

For internal usage.

Protected _instanceMaterialType

_instanceMaterialType: InstanceMaterialType = InstanceMaterialType.ADD_COLOR_AND_TEXTURE

Protected _isAniComplete

_isAniComplete: boolean = true

Protected _lastParent

_lastParent: Node | null = null

Protected _listener

_listener: AnimationStateListener | null

Protected materialCache

materialCache: {} = {} as any

Type declaration

Protected _materialInstances

_materialInstances: (null | MaterialInstance)[] = []

Protected _materials

_materials: (null | Material)[] = []

Protected _meshRenderDataArray

_meshRenderDataArray: SkeletonMeshData[] = []

_meshRenderDataArrayIdx

_meshRenderDataArrayIdx: number = 0

Protected _models

_models: Model[] = []

Protected _name

_name: string

_objFlags

_objFlags: number

Protected _playCount

_playCount: number = 0

Protected _playTimes

_playTimes: number = 0

Protected _postAssembler

_postAssembler: IAssembler | null = null

Protected _preCacheMode

_preCacheMode: number = -1

Private _premultipliedAlpha

_premultipliedAlpha: boolean = true

是否启用贴图预乘。 当图片的透明区域出现色块时需要关闭该选项,当图片的半透明区域颜色变黑时需要启用该选项。

Protected _renderData

_renderData: RenderData | null = null

Protected _renderDataFlag

_renderDataFlag: boolean = true

Protected _renderFlag

_renderFlag: boolean = true

Protected _rootBone

_rootBone: Bone | null

Private sceneGetter

sceneGetter: null | (() => RenderScene) = null

_skeleton

_skeleton: Skeleton | null

Protected _skeletonCache

_skeletonCache: SkeletonCache | null = null

Protected _skeletonData

_skeletonData: SkeletonData | null = null

Protected _socketNodes

_socketNodes: Map<number, Node> = new Map()

Protected _sockets

_sockets: SpineSocket[] = []

Protected _srcBlendFactor

_srcBlendFactor: BlendFactor = BlendFactor.SRC_ALPHA

_startEntry

_startEntry: any

_startSlotIndex

_startSlotIndex: any

Protected Optional _state

_state: spine.AnimationState

Private _timeScale

_timeScale: number = 1

当前骨骼中所有动画的时间缩放率。

Protected _useTint

_useTint: boolean = false

Protected _visFlags

_visFlags: number = Layers.Enum.NONE

attachUtil

attachUtil: AttachUtil

Protected defaultAnimation

defaultAnimation: string = ""

默认的动画名称。

property

{String} defaultAnimation

Protected defaultSkin

defaultSkin: string = ""

默认的皮肤名称。

property

{String} defaultSkin

enableBatch

enableBatch: boolean = false

开启合批,如果渲染大量相同纹理,且结构简单的骨骼动画,开启合批可以降低drawcall,否则请不要开启,cpu消耗会上升。

loop

loop: boolean = true

是否循环播放当前骨骼动画。

node

node: Node = NullNode

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

example
import { log } from 'cc';
log(comp.node);

paused

paused: boolean = false

该骨骼动画是否暂停。

property

paused

readonly
default

false

stencilStage

stencilStage: Stage = Stage.DISABLED

组件模板缓冲状态 (注意:请不要直接修改它的值)

Static AnimationCacheMode

AnimationCacheMode: AnimationCacheMode = AnimationCacheMode

Static Assembler

Assembler: IAssemblerManager | null = null

渲染数据组装器

Static BlendState

BlendState: BlendFactor = BlendFactor

混合模式枚举类型

see

BlendFactor

Static PostAssembler

PostAssembler: IAssemblerManager | null = null

后置渲染数据组装器

Static SpineSocket

SpineSocket: SpineSocket = SpineSocket

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

animationIndex

  • get animationIndex(): number
  • set animationIndex(value: number): void

defaultSkinIndex

  • get defaultSkinIndex(): number
  • set defaultSkinIndex(value: number): void

isOnLoadCalled

  • get isOnLoadCalled(): number

animation

  • get animation(): string
  • set animation(value: string): void

blendHash

  • get blendHash(): number

color

  • get color(): Readonly<Color>
  • set color(value: {}): void

customMaterial

  • get customMaterial(): null | Material
  • set customMaterial(val: null | Material): void

debugBones

  • get debugBones(): boolean
  • set debugBones(v: boolean): void

debugMesh

  • get debugMesh(): boolean
  • set debugMesh(value: boolean): void

debugSlots

  • get debugSlots(): boolean
  • set debugSlots(v: boolean): void

defaultCacheMode

delegateSrc

  • set delegateSrc(value: Node): void

dstBlendFactor

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

isValid

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

    default

    true

    readonly
    example
    import { Node, log } from 'cc';
    const node = new Node();
    log(node.isValid);    // true
    node.destroy();
    log(node.isValid);    // true, still valid in this frame
    // after a frame...
    log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

material

materials

meshRenderDataArray

name

  • get name(): string
  • set name(value: string): void

premultipliedAlpha

  • get premultipliedAlpha(): boolean
  • set premultipliedAlpha(v: boolean): void

renderData

  • get renderData(): null | RenderData

sharedMaterial

sharedMaterials

  • get sharedMaterials(): (null | Material)[]
  • set sharedMaterials(val: (null | Material)[]): void

skeletonData

  • dstBlendFactor

    骨骼数据包含了骨骼信息(绑定骨骼动作,slots,渲染顺序, attachments,皮肤等等)和动画但不持有任何状态。
    多个 Skeleton 可以共用相同的骨骼数据。

    property

    {sp.SkeletonData} skeletonData

    Returns SkeletonData

  • dstBlendFactor

    骨骼数据包含了骨骼信息(绑定骨骼动作,slots,渲染顺序, attachments,皮肤等等)和动画但不持有任何状态。
    多个 Skeleton 可以共用相同的骨骼数据。

    property

    {sp.SkeletonData} skeletonData

    Parameters

    Returns void

socketNodes

  • get socketNodes(): Map<number, Node>

sockets

  • 当前动画组件维护的挂点数组。要挂载自定义节点到受动画驱动的骨骼上,必须先在此注册挂点。

    Returns SpineSocket[]

  • 当前动画组件维护的挂点数组。要挂载自定义节点到受动画驱动的骨骼上,必须先在此注册挂点。

    Parameters

    Returns void

srcBlendFactor

timeScale

  • get timeScale(): number
  • set timeScale(value: number): void

useTint

  • get useTint(): boolean
  • set useTint(value: boolean): void

uuid

  • get uuid(): string

visibility

  • get visibility(): number
  • set visibility(val: number): void

Methods

preload

  • __preload(): void

Protected attachToScene

  • _attachToScene(): void

Protected canRender

  • _canRender(): boolean

Protected checkAndUpdateRenderData

  • _checkAndUpdateRenderData(): void

Private cleanMaterialCache

  • _cleanMaterialCache(): void

Protected clearMaterials

  • _clearMaterials(): void

collectModels

  • _collectModels(): Model[]

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • 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; } } }

    Returns void

Protected detachFromScene

  • _detachFromScene(): void

Protected emitCacheCompleteEvent

  • _emitCacheCompleteEvent(): void

Protected ensureListener

  • _ensureListener(): void

Protected flushAssembler

  • _flushAssembler(): void

Optional Private getLocalBounds

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

    Parameters

    • out_rect: Rect

      The rect to store the result bounding rect

    Returns void

Private getRenderScene

  • _getRenderScene(): RenderScene

Protected indexBoneSockets

  • _indexBoneSockets(): void

instantiate

  • instantiate(cloned: any): any

Protected nodeStateChange

offSyncTransform

  • _offSyncTransform(): void

Protected onMaterialModified

  • onMaterialModified(index: number, material: Material | null): void

onPreDestroy

  • _onPreDestroy(): void

Protected onRebuildPSO

  • onRebuildPSO(index: number, material: Material | null): void

onSyncTransform

  • _onSyncTransform(): void

Protected onVisibilityChange

  • onVisibilityChange(val: any): void

Protected postCanRender

  • _postCanRender(): void

Protected postRender

  • postRender(render: Batcher2D): void

Protected refreshInspector

  • _refreshInspector(): void

Protected render

  • render(ui: Batcher2D): void

Protected updateAnimEnum

  • _updateAnimEnum(): void

Protected updateBatch

  • _updateBatch(): void

updateBlendFunc

  • _updateBlendFunc(): void

Protected updateCache

  • updateCache(dt: number): void

Protected updateColor

  • _updateColor(): void

Protected updateDebugDraw

  • _updateDebugDraw(): void

Protected updateRealtime

  • updateRealtime(dt: number): void

Protected updateSkeletonData

  • _updateSkeletonData(): void

Protected updateSkinEnum

  • _updateSkinEnum(): void

Protected updateSocketBindings

  • _updateSocketBindings(): void

Protected updateUseTint

  • _updateUseTint(): void

Protected validateRender

  • _validateRender(): void

Private verifySockets

addAnimation

  • addAnimation(trackIndex: number, name: string, loop: boolean, delay?: undefined | number): undefined | null | TrackEntry
  • 添加一个动画到动画队列尾部,还可以延迟指定的秒数。
    返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。

    method

    addAnimation

    Parameters

    • trackIndex: number
    • name: string
    • loop: boolean
    • Optional delay: undefined | number

    Returns undefined | null | TrackEntry

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

clearTrack

  • clearTrack(trackIndex: number): void
  • 清除出指定 track 的动画状态。

    method

    clearTrack

    Parameters

    • trackIndex: number

    Returns void

clearTracks

  • clearTracks(): void

destroy

  • destroy(): boolean

destroyRenderData

  • destroyRenderData(): void

disableRender

  • disableRender(): void

findAnimation

  • findAnimation(name: string): null | Animation

findBone

  • findBone(boneName: string): null | Bone
  • 通过名称查找 bone。 这里对每个 bone 的名称进行了对比。
    返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Bone 对象。

    method

    findBone

    Parameters

    • boneName: string

    Returns null | Bone

findSlot

  • findSlot(slotName: string): null | Slot
  • 通过名称查找 slot。这里对每个 slot 的名称进行了比较。
    返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Slot 对象。

    method

    findSlot

    Parameters

    • slotName: string

    Returns null | Slot

getAttachment

  • getAttachment(slotName: string, attachmentName: string): null | Attachment
  • 通过 slot 和 attachment 的名称获取 attachment。Skeleton 优先查找它的皮肤,然后才是 Skeleton Data 中默认的皮肤。
    返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Attachment 对象。

    method

    getAttachment

    Parameters

    • slotName: string
    • attachmentName: string

    Returns null | Attachment

getBlendState

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null
  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Type parameters

    Parameters

    • classConstructor: Constructor<T>

      The class of component to be retrieved or to be created

    Returns T | null

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

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Parameters

    • className: string

      A string for the class name of the component

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

getCurrent

  • getCurrent(trackIndex: number): null | TrackEntry
  • 通过 track 索引获取 TrackEntry。
    返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。

    method

    getCurrent

    Parameters

    • trackIndex: number

    Returns null | TrackEntry

getMaterial

  • getMaterial(idx: number): Material | null

getMaterialForBlendAndTint

getMaterialInstance

  • getMaterialInstance(idx: number): Material | null

getRenderMaterial

  • getRenderMaterial(index: number): Material | null

getState

  • getState(): undefined | AnimationState

getTextureAtlas

  • getTextureAtlas(regionAttachment: RegionAttachment | BoundingBoxAttachment): TextureRegion
  • Return the renderer of attachment.

    method

    getTextureAtlas

    Parameters

    • regionAttachment: RegionAttachment | BoundingBoxAttachment

    Returns TextureRegion

invalidAnimationCache

  • invalidAnimationCache(): void
  • 使动画缓存失效,之后会在每帧重新计算。

    method

    invalidAnimationCache

    Returns void

isAnimationCached

  • isAnimationCached(): boolean

Protected Optional lateUpdate

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

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

markForUpdateRenderData

  • markForUpdateRenderData(enable?: boolean): void

onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

Protected Optional onLoad

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

    Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

onRestore

  • onRestore(): void

postUpdateAssembler

  • postUpdateAssembler(render: Batcher2D): void
  • 后置渲染数据组装程序,它会在所有子节点的渲染数据组装完成后被调用。 它可能会组装额外的渲染数据到顶点数据缓冲区,也可能只是重置一些渲染状态。 注意:不要手动调用该函数,除非你理解整个流程。

    Parameters

    • render: Batcher2D

    Returns void

querySockets

  • querySockets(): string[]

requestMeshRenderData

requestRenderData

  • requestRenderData(): RenderData

Optional resetInEditor

  • resetInEditor(): void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • 调度一个自定义的回调任务。
    如果回调任务已调度,那么将不会重复调度它,只会更新时间间隔参数。

    example
    import { log } from 'cc';
    this.schedule((dt) => void log(`time: ${dt}`), 1);

    Parameters

    • callback: any

      The callback function of the task

    • Default value interval: number = 0

      The time interval between each invocation

    • Default value repeat: number = legacyCC.macro.REPEAT_FOREVER

      The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • 调度一个只运行一次的回调任务,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    import { log } from 'cc';
    this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);

    Parameters

    • callback: any

      The callback function of the task

    • Default value delay: number = 0

      The delay time for the first invocation, Unit: s

    Returns void

setAnimation

  • setAnimation(trackIndex: number, name: string, loop: boolean): null | TrackEntry
  • 设置当前动画。队列中的任何的动画将被清除。
    返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.TrackEntry 对象。

    method

    setAnimation

    Parameters

    • trackIndex: number
    • name: string
    • loop: boolean

    Returns null | TrackEntry

setAnimationCacheMode

  • 若想切换渲染模式,最好在设置'dragonAsset'之前,先设置好渲染模式,否则有运行时开销。 若在编辑中设置渲染模式,则无需担心设置次序的问题。

    example

    skeleton.setAnimationCacheMode(sp.Skeleton.AnimationCacheMode.SHARED_CACHE);

    Parameters

    Returns void

setAnimationStateData

  • setAnimationStateData(stateData: any): void
  • 设置动画状态数据。
    参数是 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.AnimationStateData。

    Parameters

    • stateData: any

    Returns void

setAttachment

  • setAttachment(slotName: string, attachmentName: string): void
  • 通过 slot 和 attachment 的名字来设置 attachment。 Skeleton 优先查找它的皮肤,然后才是 Skeleton Data 中默认的皮肤。

    method

    setAttachment

    Parameters

    • slotName: string
    • attachmentName: string

    Returns void

setBlendHash

  • setBlendHash(): void

setBonesToSetupPose

  • setBonesToSetupPose(): void
  • 设置 bone 到起始动作 使用 SkeletonData 中的 BoneData 列表中的值。

    method

    setBonesToSetupPose

    Returns void

setCompleteListener

setDisposeListener

setEndListener

setEventListener

setInterruptListener

setMaterial

  • setMaterial(material: Material | null, index: number): void

setMaterialInstance

  • setMaterialInstance(index: number, matInst: Material | null): void

setMix

  • setMix(fromAnimation: string, toAnimation: string, duration: number): void
  • 为所有关键帧设定混合及混合时间(从当前值开始差值)。

    method

    setMix

    Parameters

    • fromAnimation: string
    • toAnimation: string
    • duration: number

    Returns void

setSkeletonData

  • setSkeletonData(skeletonData: SkeletonData): void
  • 设置底层运行时用到的 SkeletonData。
    这个接口有别于 skeletonData 属性,这个接口传入的是 Spine runtime 提供的原始数据,而 skeletonData 的类型是 Creator 提供的资源类型。

    method

    setSkeletonData

    Parameters

    • skeletonData: SkeletonData

    Returns void

setSkin

  • setSkin(skinName: string): void
  • 按名称查找皮肤,激活该皮肤。这里对每个皮肤的名称进行了比较。
    注意:设置皮肤不会改变 attachment 的可见性。
    返回一个 {{#crossLinkModule "sp.spine"}}sp.spine{{/crossLinkModule}}.Skin 对象。

    method

    setSkin

    Parameters

    • skinName: string

    Returns void

setSlotsRange

  • setSlotsRange(startSlotIndex: any, endSlotIndex: any): void
  • 设置骨骼插槽可视范围。

    Parameters

    • startSlotIndex: any
    • endSlotIndex: any

    Returns void

setSlotsToSetupPose

  • setSlotsToSetupPose(): void
  • 设置 slot 到起始动作。 使用 SkeletonData 中的 SlotData 列表中的值。

    method

    setSlotsToSetupPose

    Returns void

setStartListener

setToSetupPose

  • setToSetupPose(): void

setTrackCompleteListener

  • setTrackCompleteListener(entry: TrackEntry, listener: TrackListener2): void
  • 用来为指定的 TrackEntry 设置动画一次循环播放结束的事件监听。

    method

    setTrackCompleteListener

    Parameters

    Returns void

setTrackDisposeListener

  • setTrackDisposeListener(entry: TrackEntry, listener: TrackListener): void
  • 用来为指定的 TrackEntry 设置动画即将被销毁的事件监听。

    method

    setTrackDisposeListener

    Parameters

    Returns void

setTrackEndListener

  • setTrackEndListener(entry: TrackEntry, listener: TrackListener): void
  • 用来为指定的 TrackEntry 设置动画播放结束的事件监听。

    method

    setTrackEndListener

    Parameters

    Returns void

setTrackEventListener

  • setTrackEventListener(entry: TrackEntry, listener: TrackListener): void

setTrackInterruptListener

  • setTrackInterruptListener(entry: TrackEntry, listener: TrackListener): void
  • 用来为指定的 TrackEntry 设置动画被打断的事件监听。

    method

    setTrackInterruptListener

    Parameters

    Returns void

setTrackStartListener

  • setTrackStartListener(entry: TrackEntry, listener: TrackListener): void
  • 用来为指定的 TrackEntry 设置动画开始播放的事件监听。

    method

    setTrackStartListener

    Parameters

    Returns void

setVertexEffectDelegate

Protected Optional start

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

    Returns void

Private syncTransform

  • syncTransform(): void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

update

  • update(dt: number): void

updateAnimationCache

  • updateAnimationCache(animName: any): void
  • 更新某个动画缓存, 预计算动画中所有帧数据,由于在单帧计算所有数据,所以较消耗性能。 若想更新缓存,可使用 invalidAnimationCache 方法,具有较高性能。

    method

    updateAnimationCache

    Parameters

    • animName: any

    Returns void

updateAssembler

  • updateAssembler(render: Batcher2D): void
  • 渲染数据组装程序,这个方法会在所有子节点数据组装之前更新并组装当前组件的渲染数据到 UI 的顶点数据缓冲区中。 一般在 UI 渲染流程中调用,用于组装所有的渲染数据到顶点数据缓冲区。 注意:不要手动调用该函数,除非你理解整个流程。

    Parameters

    • render: Batcher2D

    Returns void

updateBlendHash

  • updateBlendHash(): void

Protected updateMaterial

  • updateMaterial(): void

Protected updateWorldTransform

  • updateWorldTransform(): void
  • 重新更新所有骨骼的世界 Transform, 当获取 bone 的数值未更新时,即可使用该函数进行更新数值。

    method

    updateWorldTransform

    example

    var bone = spine.findBone('head'); cc.log(bone.worldX); // return 0; spine.updateWorldTransform(); bone = spine.findBone('head'); cc.log(bone.worldX); // return -23.12;

    Returns void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc