GameObjImpl

Defined in: packages/threeplay/src/core/gameobj.ts:46

Implementation of GameObjRaw. Components add their fields on top.

Implements

• GameObjRaw

Accessors

hidden

Get Signature

get hidden(): boolean

Defined in: packages/threeplay/src/core/gameobj.ts:66

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

Returns

boolean

Set Signature

set hidden(h): void

Defined in: packages/threeplay/src/core/gameobj.ts:70

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

Parameters

h

boolean

Returns

void

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

Implementation of

GameObjRaw.hidden

Constructors

Constructor

new GameObjImpl(ctx, object3d?): GameObjImpl

Defined in: packages/threeplay/src/core/gameobj.ts:60

Parameters

ctx

GameObjContext

object3d?

Object3D = ...

Returns

GameObjImpl

Methods

add()

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

Defined in: packages/threeplay/src/core/gameobj.ts:74

Adds a child object.

Type Parameters

T

T extends CompList

Parameters

comps?

readonly [T] = ...

Returns

GameObj<MergeComps<T[number]>>

Implementation of

GameObjRaw.add

---

c()

c(id): Comp | undefined

Defined in: packages/threeplay/src/core/gameobj.ts:166

The component with that id, if any.

Parameters

id

string

Returns

Comp | undefined

Implementation of

GameObjRaw.c

---

destroy()

destroy(): void

Defined in: packages/threeplay/src/core/gameobj.ts:88

Destroys this object and its subtree.

Returns

void

Implementation of

GameObjRaw.destroy

---

exists()

exists(): boolean

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

false once destroyed.

Returns

boolean

Implementation of

GameObjRaw.exists

---

get()

get(tag, opts?): GameObj[]

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

Descendants with the given tag(s).

Parameters

tag

string | string[]

opts?

GetOpts = {}

Returns

GameObj[]

Implementation of

GameObjRaw.get

---

has()

has(id): boolean

Defined in: packages/threeplay/src/core/gameobj.ts:161

true if the object has a component with that id.

Parameters

id

string | string[]

Returns

boolean

Implementation of

GameObjRaw.has

---

inspect()

inspect(): Record<string, string>

Defined in: packages/threeplay/src/core/gameobj.ts:191

Status lines from every component, for debugging.

Returns

Record<string, string>

Implementation of

GameObjRaw.inspect

---

is()

is(tag): boolean

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

true if the object has every given tag.

Parameters

tag

string | string[]

Returns

boolean

Implementation of

GameObjRaw.is

---

on()

on(event, fn): EventController

Defined in: packages/threeplay/src/core/gameobj.ts:170

Listens to an event of this object.

Parameters

event

string

fn

(…args) => void

Returns

EventController

Implementation of

GameObjRaw.on

---

onDestroy()

onDestroy(fn): EventController

Defined in: packages/threeplay/src/core/gameobj.ts:187

Runs once when the object is destroyed.

Parameters

fn

() => void

Returns

EventController

Implementation of

GameObjRaw.onDestroy

---

onFixedUpdate()

onFixedUpdate(fn): EventController

Defined in: packages/threeplay/src/core/gameobj.ts:183

Runs at the fixed rate while the object exists.

Parameters

fn

() => void

Returns

EventController

Implementation of

GameObjRaw.onFixedUpdate

---

onUpdate()

onUpdate(fn): EventController

Defined in: packages/threeplay/src/core/gameobj.ts:179

Runs every frame while the object exists.

Parameters

fn

() => void

Returns

EventController

Implementation of

GameObjRaw.onUpdate

---

remove()

remove(child): void

Defined in: packages/threeplay/src/core/gameobj.ts:84

Removes (destroys) a child.

Parameters

child

GameObj

Returns

void

Implementation of

GameObjRaw.remove

---

tag()

tag(tag): void

Defined in: packages/threeplay/src/core/gameobj.ts:128

Adds tags.

Parameters

tag

string | string[]

Returns

void

Implementation of

GameObjRaw.tag

---

trigger()

trigger(event, …args): void

Defined in: packages/threeplay/src/core/gameobj.ts:174

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

Parameters

event

string

args

…unknown[]

Returns

void

Implementation of

GameObjRaw.trigger

---

untag()

untag(tag): void

Defined in: packages/threeplay/src/core/gameobj.ts:132

Removes tags.

Parameters

tag

string | string[]

Returns

void

Implementation of

GameObjRaw.untag

---

unuse()

unuse(id): void

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

Removes a component by id.

Parameters

id

string

Returns

void

Implementation of

GameObjRaw.unuse

---

use()

use(comp): void

Defined in: packages/threeplay/src/core/gameobj.ts:136

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

Parameters

comp

string | object | Comp

Returns

void

Implementation of

GameObjRaw.use

Properties

children

readonly children: GameObj[] = []

Defined in: packages/threeplay/src/core/gameobj.ts:50

Direct children.

Implementation of

GameObjRaw.children

---

id

readonly id: number

Defined in: packages/threeplay/src/core/gameobj.ts:47

Unique, incremental id.

Implementation of

GameObjRaw.id

---

object3d

readonly object3d: Object3D

Defined in: packages/threeplay/src/core/gameobj.ts:48

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

Implementation of

GameObjRaw.object3d

---

parent

parent: GameObj | null = null

Defined in: packages/threeplay/src/core/gameobj.ts:49

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

Implementation of

GameObjRaw.parent

---

paused

paused: boolean = false

Defined in: packages/threeplay/src/core/gameobj.ts:52

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

Implementation of

GameObjRaw.paused

---

tags

readonly tags: Set<string>

Defined in: packages/threeplay/src/core/gameobj.ts:51

Tags of this object.

Implementation of

GameObjRaw.tags