TimelineAPI
此内容尚不支持你的语言。
Defined in: timeline/TimelineControl.ts:34
Per-App timeline playback control. Holds this App’s per-entity playback state
and is published as the Timeline resource; game code drives playback via
app.getResource(Timeline).
The timeline runtime is pure TS now — there is no
C++ handle or wasm module here. TimelinePlugin advances each entity’s
TimelineState every frame; these methods flip/seek that state and
write the play flags through to the entity’s TimelinePlayer component.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TimelineAPI(
flags_?):TimelineAPI
Defined in: timeline/TimelineControl.ts:39
Parameters
Section titled “Parameters”flags_?
Section titled “flags_?”PlayerFlagChannel | null
Returns
Section titled “Returns”TimelineAPI
Methods
Section titled “Methods”getAsset()
Section titled “getAsset()”getAsset(
name):TimelineAsset|undefined
Defined in: timeline/TimelineControl.ts:62
What name plays: a code registration first, then this realm’s asset.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TimelineAsset | undefined
getCurrentTime()
Section titled “getCurrentTime()”getCurrentTime(
entity):number
Defined in: timeline/TimelineControl.ts:125
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getState()
Section titled “getState()”getState(
entity):TimelineState|undefined
Defined in: timeline/TimelineControl.ts:76
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”TimelineState | undefined
isPlaying()
Section titled “isPlaying()”isPlaying(
entity):boolean
Defined in: timeline/TimelineControl.ts:121
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”boolean
pause()
Section titled “pause()”pause(
entity):void
Defined in: timeline/TimelineControl.ts:96
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
play()
Section titled “play()”play(
entity):void
Defined in: timeline/TimelineControl.ts:90
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
registerAsset()
Section titled “registerAsset()”registerAsset(
name,asset):void
Defined in: timeline/TimelineControl.ts:48
Register a timeline built in code under name, so a TimelinePlayer
whose timeline is that name plays it like an authored one.
Per app, like every other code registration: a name registered here is this app’s, and it wins over an asset of the same name.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setTime()
Section titled “setTime()”setTime(
entity,time):void
Defined in: timeline/TimelineControl.ts:113
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop(
entity):void
Defined in: timeline/TimelineControl.ts:102
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
unregisterAsset()
Section titled “unregisterAsset()”unregisterAsset(
name):void
Defined in: timeline/TimelineControl.ts:52
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void