API reference
API reference
Select your platform
No SDKs available
No versions available

Animated

Animated

class Animated(startTime: Long, pausedTime: Float = 0.0f, playbackState: PlaybackState = PlaybackState.PLAYING, playbackType: PlaybackType = PlaybackType.LOOP, track: Int = 0) : ComponentBase
Plays animation for a glTF asset. Also configures different settings for animation.
Parameters
JVM
NameSummary
startTime
World time at which animation started (ms since epoch)
pausedTime
Paused location/time (sec) within animation track
playbackState
Playback state of the animated entity
playbackType
Playback type of the animated entity
track
the animation track of the glTF to play

Constructors

NameSummary
Animated
constructor(startTime: Long, pausedTime: Float = 0.0f, playbackState: PlaybackState = PlaybackState.PLAYING, playbackType: PlaybackType = PlaybackType.LOOP, track: Int = 0)

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
val cachable: Boolean = false
creationTime
var creationTime: Long
isDirty
var isDirty: Boolean
pausedTime
var pausedTime: Float
Paused location/time (sec) within animation track
playbackState
var playbackState: PlaybackState
State of the animation (playing or paused)
playbackType
var playbackType: PlaybackType
The type of animation playback to be used
recycled
var recycled: Boolean
startTime
var startTime: Long
World time at which animation started (ms since epoch)
track
var track: Int
which animation track of the glTF to play

Functions

NameSummary
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributeType?
fun getComponentDataAttributeType(keyString: String): AttributeType?
getComponentDataKey
fun getComponentDataKey(key: String): Int?
getComponentDataValue
fun getComponentDataValue(key: Int): Any?
fun getComponentDataValue(keyString: String): Any?
getEnumClass
fun getEnumClass(key: String): Class<out Enum<*>>?
hasComponentData
fun hasComponentData(key: Int): Boolean
fun hasComponentData(keyString: String): Boolean
read
fun read(e: Entity, cachable: Boolean)
recycle
fun recycle()
reset
open fun reset()
setComponentDataValue
fun setComponentDataValue(key: Int, value: Any?): Boolean
fun setComponentDataValue(keyString: String, value: Any?): Boolean
setPool
fun setPool(pool: ComponentPool<*>)
toString
open override fun toString(): String
typeID
open override fun typeID(): Int
write
fun write(e: Entity)

Companion

object Companion : ComponentCompanion

Properties

NameSummary
createDefaultInstance
open override val createDefaultInstance: () -> Animated
id
open override val id: <Error class: unknown class>

Functions

NameSummary
dependents
open fun dependents(): IntArray
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta