EngineHooks
Defined in: packages/threeplay/src/core/types.ts:196
System-level hooks used by plugins. They are never cleared by go().
Plugins may add their own hooks through declaration merging.
Properties
Section titled “Properties”afterFixedUpdate
Section titled “afterFixedUpdate”afterFixedUpdate: [
fixedDt:number]
Defined in: packages/threeplay/src/core/types.ts:206
After objects’ fixedUpdate (e.g. step the physics world).
afterUpdate
Section titled “afterUpdate”afterUpdate: [
dt:number]
Defined in: packages/threeplay/src/core/types.ts:210
After objects’ update (e.g. character controllers, then the camera).
beforeFixedUpdate
Section titled “beforeFixedUpdate”beforeFixedUpdate: [
fixedDt:number]
Defined in: packages/threeplay/src/core/types.ts:204
Before objects’ fixedUpdate (e.g. sync kinematic bodies).
beforeUpdate
Section titled “beforeUpdate”beforeUpdate: [
dt:number]
Defined in: packages/threeplay/src/core/types.ts:208
Before objects’ update.
debugInspect
Section titled “debugInspect”debugInspect: [
enabled:boolean]
Defined in: packages/threeplay/src/plugins/debug/types.ts:54
The inspector was turned on or off (physics draws colliders while on).
error: [
err:unknown]
Defined in: packages/threeplay/src/core/types.ts:226
An uncaught error stopped the loop (the render plugin shows it on screen).
frameEnd
Section titled “frameEnd”frameEnd: []
Defined in: packages/threeplay/src/core/types.ts:216
End of a frame (e.g. clear “pressed this frame” input).
frameStart
Section titled “frameStart”frameStart: [
dt:number]
Defined in: packages/threeplay/src/core/types.ts:202
Start of a frame, before any update.
init: []
Defined in: packages/threeplay/src/core/types.ts:198
All plugins installed.
lateUpdate
Section titled “lateUpdate”lateUpdate: [
dt:number]
Defined in: packages/threeplay/src/core/types.ts:212
After every afterUpdate: positions are final (e.g. follow(), rotation sync).
loaded
Section titled “loaded”loaded: []
Defined in: packages/threeplay/src/core/types.ts:200
Every pending load() finished; the first scene can start.
objectAdd
Section titled “objectAdd”objectAdd: [
obj:GameObj<Record<string,any>>]
Defined in: packages/threeplay/src/core/types.ts:222
An object entered the tree (after its components’ add).
objectDestroy
Section titled “objectDestroy”objectDestroy: [
obj:GameObj<Record<string,any>>]
Defined in: packages/threeplay/src/core/types.ts:224
An object is being destroyed (before its node is detached).
render
Section titled “render”render: [
alpha:number]
Defined in: packages/threeplay/src/core/types.ts:214
Time to draw. alpha is the fraction of a fixed step left over.
sceneEnter
Section titled “sceneEnter”sceneEnter: [
name:string,args:unknown[]]
Defined in: packages/threeplay/src/core/types.ts:218
A scene is about to start.
sceneLeave
Section titled “sceneLeave”sceneLeave: [
name:string]
Defined in: packages/threeplay/src/core/types.ts:220
A scene is ending: its objects and listeners are about to be cleared.