TimerComp
Defined in: packages/threeplay/src/plugins/gameplay/types.ts:58
Fields added by timer(): timers bound to the object. They tick in its own
update (so obj.paused stops them) and die with it.
Extends
Section titled “Extends”Methods
Section titled “Methods”add()?
Section titled “add()?”
optionaladd(this):void
Defined in: packages/threeplay/src/core/types.ts:63
Called when the object enters the scene (or when used on a live object).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”destroy()?
Section titled “destroy()?”
optionaldestroy(this):void
Defined in: packages/threeplay/src/core/types.ts:69
Called when the object is destroyed or the component removed.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”fixedUpdate()?
Section titled “fixedUpdate()?”
optionalfixedUpdate(this):void
Defined in: packages/threeplay/src/core/types.ts:67
Called at the fixed physics rate (50 Hz by default).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”inspect()?
Section titled “inspect()?”
optionalinspect(this):string|null|undefined
Defined in: packages/threeplay/src/core/types.ts:71
Short status line shown by the debug inspector.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string | null | undefined
Inherited from
Section titled “Inherited from”loop()
Section titled “loop()”loop(
seconds,fn,count?):TimerController
Defined in: packages/threeplay/src/plugins/gameplay/types.ts:63
Runs fn right away and then every seconds, count times or forever.
Parameters
Section titled “Parameters”seconds
Section titled “seconds”number
() => void
count?
Section titled “count?”number
Returns
Section titled “Returns”tween()
Section titled “tween()”tween<
V>(from,to,duration,set,easing?):TimerController
Defined in: packages/threeplay/src/plugins/gameplay/types.ts:65
Animates a value from from to to, calling set each frame.
Type Parameters
Section titled “Type Parameters”V extends Tweenable
Parameters
Section titled “Parameters”V
V
duration
Section titled “duration”number
(v) => void
easing?
Section titled “easing?”Returns
Section titled “Returns”update()?
Section titled “update()?”
optionalupdate(this):void
Defined in: packages/threeplay/src/core/types.ts:65
Called once per frame.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”wait()
Section titled “wait()”wait(
seconds,fn?):TimerController
Defined in: packages/threeplay/src/plugins/gameplay/types.ts:61
Runs fn after seconds. Awaitable.
Parameters
Section titled “Parameters”seconds
Section titled “seconds”number
() => void
Returns
Section titled “Returns”Properties
Section titled “Properties”conflicts?
Section titled “conflicts?”
optionalconflicts?:string[]
Defined in: packages/threeplay/src/core/types.ts:61
Ids of components that can’t be on the same object (checked both ways).
Inherited from
Section titled “Inherited from”id:
"timer"
Defined in: packages/threeplay/src/plugins/gameplay/types.ts:59
Unique name. Two components with the same id replace each other.
Overrides
Section titled “Overrides”require?
Section titled “require?”
optionalrequire?:string[]
Defined in: packages/threeplay/src/core/types.ts:59
Ids of components that must be present on the object.