RealityOS Docs and Examples

Appearance

@tmrw-realityos/world

@tmrw-realityos/world / ComponentsContainer

Class: ComponentsContainer ​

Defined in: world/components.ts:48

Base class for anyone who wants to have components

Extended by ​

Constructors ​

Constructor ​

new ComponentsContainer(): ComponentsContainer

Defined in: world/components.ts:51

Returns ​

ComponentsContainer

Properties ​

components ​

components: BaseComponent[] = []

Defined in: world/components.ts:49

Methods ​

addComponent() ​

addComponent(component): BaseComponent

Defined in: world/components.ts:53

Parameters ​

component ​

BaseComponent

Returns ​

BaseComponent

configureComponents() ​

configureComponents(info): void

Defined in: world/components.ts:101

Parameters ​

info ​
components? ​

[string, BaseComponent][]

Returns ​

void

getComponent() ​

getComponent<Type>(ctor): undefined | Type

Defined in: world/components.ts:81

Type Parameters ​

Type ​

Type extends BaseComponent

Parameters ​

ctor ​

(...args) => Type

Returns ​

undefined | Type

getComponentByName() ​

getComponentByName(class_name): undefined | BaseComponent

Defined in: world/components.ts:89

Parameters ​

class_name ​

string

Returns ​

undefined | BaseComponent

removeAllComponents() ​

removeAllComponents(): void

Defined in: world/components.ts:96

Returns ​

void

removeComponent() ​

removeComponent(component): void

Defined in: world/components.ts:64

Parameters ​

component ​

BaseComponent

Returns ​

void