GameObjRaw

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

The methods every game object has, whatever its components.

Methods

add()

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

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

Adds a child object.

Type Parameters

T

T extends CompList

Parameters

comps?

readonly [T]

Returns

GameObj<MergeComps<T[number]>>

c()

c(id): Comp | undefined

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

The component with that id, if any.

Parameters

id

string

Returns

Comp | undefined

destroy()

destroy(): void

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

Destroys this object and its subtree.

Returns

void

exists()

exists(): boolean

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

false once destroyed.

Returns

boolean

get()

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

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

Descendants with the given tag(s).

Parameters

tag

string | string[]

opts?

GetOpts

Returns

GameObj<Record<string, any>>[]

has()

has(id): boolean

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

true if the object has a component with that id.

Parameters

id

string | string[]

Returns

boolean

inspect()

inspect(): Record<string, string>

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

Status lines from every component, for debugging.

Returns

Record<string, string>

is()

is(tag): boolean

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

true if the object has every given tag.

Parameters

tag

string | string[]

Returns

boolean

on()

on(event, fn): EventController

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

Listens to an event of this object.

Parameters

event

string

fn

(…args) => void

Returns

EventController

onDestroy()

onDestroy(fn): EventController

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

Runs once when the object is destroyed.

Parameters

fn

() => void

Returns

EventController

onFixedUpdate()

onFixedUpdate(fn): EventController

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

Runs at the fixed rate while the object exists.

Parameters

fn

() => void

Returns

EventController

onUpdate()

onUpdate(fn): EventController

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

Runs every frame while the object exists.

Parameters

fn

() => void

Returns

EventController

remove()

remove(child): void

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

Removes (destroys) a child.

Parameters

child

GameObj

Returns

void

tag()

tag(tag): void

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

Adds tags.

Parameters

tag

string | string[]

Returns

void

trigger()

trigger(event, …args): void

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

Emits an event on this object (also reaches k.on(event, tag, fn) listeners).

Parameters

event

string

args

…unknown[]

Returns

void

untag()

untag(tag): void

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

Removes tags.

Parameters

tag

string | string[]

Returns

void

unuse()

unuse(id): void

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

Removes a component by id.

Parameters

id

string

Returns

void

use()

use(comp): void

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

Adds a component (or a tag) to a live object.

Parameters

comp

string | object | Comp

Returns

void

Properties

children

readonly children: readonly GameObj<Record<string, any>>[]

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

Direct children.

hidden

hidden: boolean

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

Hides the object (and its subtree) without destroying it.

id

readonly id: number

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

Unique, incremental id.

object3d

readonly object3d: Object3D

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

The three.js node of this object. Children objects are nested inside it.

parent

readonly parent: GameObj<Record<string, any>> | null

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

Parent object (null for the root or once destroyed).

paused

paused: boolean

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

A paused object (and its subtree) skips update and fixedUpdate.