EngineCore

Defined in: packages/threeplay/src/core/types.ts:239

The core API: object tree, events, scenes, time, timers and loading.

Methods

add()

add<T>(comps?): GameObj<MergeComps<T[number]>>

Defined in: packages/threeplay/src/core/types.ts:257

Adds an object to the scene.

Type Parameters

T

T extends CompList

Parameters

comps?

readonly [T]

Returns

GameObj<MergeComps<T[number]>>

---

destroy()

destroy(obj): void

Defined in: packages/threeplay/src/core/types.ts:259

Destroys an object.

Parameters

obj

GameObj

Returns

void

---

destroyAll()

destroyAll(tag): void

Defined in: packages/threeplay/src/core/types.ts:261

Destroys every object with a tag.

Parameters

tag

string

Returns

void

---

dt()

dt(): number

Defined in: packages/threeplay/src/core/types.ts:298

Seconds since the last frame (scaled).

Returns

number

---

fixedDt()

fixedDt(): number

Defined in: packages/threeplay/src/core/types.ts:300

Seconds of a fixed step (scaled).

Returns

number

---

get()

get(tag, opts?): GameObj<Record<string, any>>[]

Defined in: packages/threeplay/src/core/types.ts:263

Objects with the given tag(s), searching the whole tree by default.

Parameters

tag

string | string[]

opts?

GetOpts

Returns

GameObj<Record<string, any>>[]

---

getSceneName()

getSceneName(): string | null

Defined in: packages/threeplay/src/core/types.ts:294

Name of the running scene.

Returns

string | null

---

getTimeScale()

getTimeScale(): number

Defined in: packages/threeplay/src/core/types.ts:305

Returns

number

---

go()

go(name, …args): void

Defined in: packages/threeplay/src/core/types.ts:292

Switches to a scene: clears objects and scene listeners, then runs it.

Parameters

name

string

args

…unknown[]

Returns

void

---

isLoaded()

isLoaded(): boolean

Defined in: packages/threeplay/src/core/types.ts:329

Returns

boolean

---

isPaused()

isPaused(): boolean

Defined in: packages/threeplay/src/core/types.ts:308

Returns

boolean

---

load()

load<T>(task): Promise<T>

Defined in: packages/threeplay/src/core/types.ts:326

Registers a loading task. The first scene waits for every task.

Type Parameters

T

T

Parameters

task

Promise<T>

Returns

Promise<T>

---

loadProgress()

loadProgress(): number

Defined in: packages/threeplay/src/core/types.ts:328

0–1.

Returns

number

---

loop()

loop(seconds, fn, count?): TimerController

Defined in: packages/threeplay/src/core/types.ts:314

Runs fn every seconds (right away first), count times or forever.

Parameters

seconds

number

fn

() => void

count?

number

Returns

TimerController

---

on()

Call Signature

on(event, fn): EventController

Defined in: packages/threeplay/src/core/types.ts:267

Global event listener, or per-tag object event listener with on(event, tag, fn).

Parameters

event

string

fn

(…args) => void

Returns

EventController

Call Signature

on(event, tag, fn): EventController

Defined in: packages/threeplay/src/core/types.ts:268

Parameters

event

string

tag

string

fn

(obj, …args) => void

Returns

EventController

---

onAdd()

Call Signature

onAdd(fn): EventController

Defined in: packages/threeplay/src/core/types.ts:278

When any object (or one with tag) is added.

Parameters

fn

(obj) => void

Returns

EventController

Call Signature

onAdd(tag, fn): EventController

Defined in: packages/threeplay/src/core/types.ts:279

Parameters

tag

string

fn

(obj) => void

Returns

EventController

---

onDestroy()

Call Signature

onDestroy(fn): EventController

Defined in: packages/threeplay/src/core/types.ts:281

When any object (or one with tag) is destroyed.

Parameters

fn

(obj) => void

Returns

EventController

Call Signature

onDestroy(tag, fn): EventController

Defined in: packages/threeplay/src/core/types.ts:282

Parameters

tag

string

fn

(obj) => void

Returns

EventController

---

onFixedUpdate()

Call Signature

onFixedUpdate(fn): EventController

Defined in: packages/threeplay/src/core/types.ts:275

At the fixed rate, or for every object with tag.

Parameters

fn

() => void

Returns

EventController

Call Signature

onFixedUpdate(tag, fn): EventController

Defined in: packages/threeplay/src/core/types.ts:276

Parameters

tag

string

fn

(obj) => void

Returns

EventController

---

onLoad()

onLoad(fn): EventController

Defined in: packages/threeplay/src/core/types.ts:284

When all assets are loaded (runs right away if they already are).

Parameters

fn

() => void

Returns

EventController

---

onQuit()

onQuit(fn): EventController

Defined in: packages/threeplay/src/core/types.ts:337

Runs fn when the engine quits.

Parameters

fn

() => void

Returns

EventController

---

onSceneLeave()

onSceneLeave(fn): EventController

Defined in: packages/threeplay/src/core/types.ts:286

When the current scene ends.

Parameters

fn

(next) => void

Returns

EventController

---

onUpdate()

Call Signature

onUpdate(fn): EventController

Defined in: packages/threeplay/src/core/types.ts:272

Every frame, or for every object with tag every frame.

Parameters

fn

() => void

Returns

EventController

Call Signature

onUpdate(tag, fn): EventController

Defined in: packages/threeplay/src/core/types.ts:273

Parameters

tag

string

fn

(obj) => void

Returns

EventController

---

quit()

quit(): void

Defined in: packages/threeplay/src/core/types.ts:335

Stops the loop and disposes every plugin.

Returns

void

---

scene()

scene(name, def): void

Defined in: packages/threeplay/src/core/types.ts:290

Defines a scene.

Parameters

name

string

def

SceneDef

Returns

void

---

setPaused()

setPaused(paused): void

Defined in: packages/threeplay/src/core/types.ts:307

Pauses every update (rendering continues).

Parameters

paused

boolean

Returns

void

---

setTimeScale()

setTimeScale(scale): void

Defined in: packages/threeplay/src/core/types.ts:304

Speeds up (>1) or slows down (<1) the game.

Parameters

scale

number

Returns

void

---

step()

step(dt?): void

Defined in: packages/threeplay/src/core/types.ts:333

Advances one frame by dt seconds (for loop: "manual" and tests).

Parameters

dt?

number

Returns

void

---

time()

time(): number

Defined in: packages/threeplay/src/core/types.ts:302

Seconds since start.

Returns

number

---

trigger()

trigger(event, …args): void

Defined in: packages/threeplay/src/core/types.ts:270

Emits a global event.

Parameters

event

string

args

…unknown[]

Returns

void

---

tween()

tween<V>(from, to, duration, set, easing?): TimerController

Defined in: packages/threeplay/src/core/types.ts:316

Animates a value from from to to, calling set each frame.

Type Parameters

V

V extends Tweenable

Parameters

from

V

to

V

duration

number

set

(value) => void

easing?

Easing

Returns

TimerController

---

wait()

wait(seconds, fn?): TimerController

Defined in: packages/threeplay/src/core/types.ts:312

Runs fn after seconds of game time. Awaitable.

Parameters

seconds

number

fn?

() => void

Returns

TimerController

Properties

camera3d

camera3d: PerspectiveCamera

Defined in: packages/threeplay/src/core/types.ts:249

The camera used to render. Replace it or move it at will.

---

hooks

readonly hooks: Hooks

Defined in: packages/threeplay/src/core/types.ts:251

System hooks for plugins.

---

opts

readonly opts: Readonly<ThreeplayOpts>

Defined in: packages/threeplay/src/core/types.ts:243

Options passed to threeplay().

---

plugins

readonly plugins: Readonly<Record<string, object>>

Defined in: packages/threeplay/src/core/types.ts:253

APIs of the installed plugins, by plugin name.

---

root

readonly root: GameObj

Defined in: packages/threeplay/src/core/types.ts:245

Root of the object tree. Every scene object is a descendant.

---

scene3d

readonly scene3d: Scene

Defined in: packages/threeplay/src/core/types.ts:247

The three.js scene. root.object3d lives inside it.

---

THREE

readonly THREE: __module

Defined in: packages/threeplay/src/core/types.ts:241

The three.js namespace bundled with the engine (escape hatch).