Skip to main content

Editor.Assets.AnimationAsset

Class

Represents an animation asset with playback timing information.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// Find AnimationAsset assets in the project
const animAssets = model.project.assetManager.assets.filter(
a => a.isOfType('AnimationAsset')
) as Editor.Assets.AnimationAsset[];

if (animAssets.length > 0) {
const anim = animAssets[0];
console.log(`Animation: ${anim.name}, duration: ${anim.duration}s, fps: ${anim.fps}, frames: ${anim.frames}`);

// Create a scene object with an AnimationPlayer to use the animation
const obj = scene.createSceneObject('AnimatedObject');
const player = obj.addComponent('AnimationPlayer');
player.autoplay = true;
player.clipRangeType = Editor.Components.ClipRangeType.Seconds;
}

Extends

Properties

cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Asset.cacheFile


duration

readonly duration: number

Total duration of the animation in seconds.


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

Asset.fileMeta


fps

readonly fps: number

Frames per second of the animation.


frames

readonly frames: number

Total number of frames in the animation.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Asset.id


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

Asset.meta


name

readonly name: string

The name of the asset.

Inherited from

Asset.name


type

readonly type: string

The entity's type.

Inherited from

Asset.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Asset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Asset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Asset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Asset.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Asset.isSame