Editor.Assets.AnimationAsset
ClassRepresents an animation asset with playback timing information.
Index
Properties
Methods
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
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
duration
readonlyduration:number
Total duration of the animation in seconds.
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
fps
readonlyfps:number
Frames per second of the animation.
frames
readonlyframes:number
Total number of frames in the animation.
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
readonlyname:string
The name of the asset.
Inherited from
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Asset.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean