Class AnimationService

Helper methods for managing animations.

Hierarchy

AnimationService

Index

Methods

Methods

Static blendAnimation

blendAnimation(world: WorldBase, context: Entity, animationClip: Entity, transitionSpeed: number, animationSpeed: number, loopMode: LoopMode): Entity

- Defined in RuntimeFull.ts:5802
Blends the currently playing animation with the new animation. If no animation was running before, the new animation is blended with the entity's current property values.

Parameters
- world: WorldBase
- context: Entity
- animationClip: Entity
- transitionSpeed: number
- animationSpeed: number
- loopMode: LoopMode
Returns Entity

Static createAnimationBlenderContext

createAnimationBlenderContext(world: WorldBase, target: Entity, name: string): Entity

- Defined in RuntimeFull.ts:5798
Creates the context required for animation blending.

Parameters
- world: WorldBase
- target: Entity
- name: string
Returns Entity

Static createAnimationClipPlayer

createAnimationClipPlayer(world: WorldBase, target: Entity, animationClip: Entity, speed: number, loopMode: LoopMode, newEntityName: string): Entity

- Defined in RuntimeFull.ts:5796
Creates a new entity with the AnimationClipPlayer component and sets it up to run immediately.

Parameters
- world: WorldBase
- target: Entity
- animationClip: Entity
- speed: number
- loopMode: LoopMode
- newEntityName: string
Returns Entity

Static destroyAnimationBlenderContext

destroyAnimationBlenderContext(world: WorldBase, entity: Entity): void

- Defined in RuntimeFull.ts:5804
Destroys the animation blender context and associated entities.

Parameters
- world: WorldBase
- entity: Entity
Returns void

Static getAnimationClipInfo

getAnimationClipInfo(world: WorldBase, animationClip: Entity): AnimationClipInfo

- Defined in RuntimeFull.ts:5793
Gets animation clip info (start and end time) for the animationClip entity.

Parameters
- world: WorldBase
- animationClip: Entity
Returns AnimationClipInfo

Generated using TypeDoc