Class Component`Abstract`

Hierarchy

Component
- SizedComponent
- UiComponent
- Camera
- Light
- MeshRenderer
- Collider
- Rotate

Index

Constructors

Properties

_isActive gameObject onActiveChanges

Accessors

isActive transform

Methods

awake destroy error lateUpdate log onDestroy register render start uiRender update warn

Constructors

constructor

new Component(): Component
Returns Component
- Defined in classes/Components/Component.ts:24

Properties

`Private` _isActive

_isActive: boolean

gameObject

gameObject: GameObject

onActiveChanges

onActiveChanges: Event<Component>

Accessors

isActive

get isActive(): boolean
Returns boolean
- Defined in classes/Components/Component.ts:16
set isActive(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in classes/Components/Component.ts:19

transform

get transform(): Transform
Returns Transform
- Defined in classes/Components/Component.ts:11

Methods

awake

awake(): Promise<void>
Called on scene load

Returns Promise<void>
- Defined in classes/Components/Component.ts:49

destroy

destroy(): void
Destroy component

Returns void
- Defined in classes/Components/Component.ts:40

error

error(...obj: any): void
Utility function for logging. Logs using console.error and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
- Defined in classes/Components/Component.ts:102

lateUpdate

lateUpdate(): Promise<void>
Called every frame after render

Returns Promise<void>
- Defined in classes/Components/Component.ts:64

log

log(...obj: any): void
Utility function for logging. Logs using console.log and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
- Defined in classes/Components/Component.ts:89

onDestroy

onDestroy(): Promise<void>
Called when component is destroyed

Returns Promise<void>
- Defined in classes/Components/Component.ts:69

register

register(obj: GameObject): void
Called when component added to GameObject
Parameters
- obj: GameObject
  
  GameObject
Returns void
- Defined in classes/Components/Component.ts:33

render

render(_renderer: Renderer, _camera: Camera): void
Used for rendering
Parameters
- _renderer: Renderer
- _camera: Camera
Returns void
- Defined in classes/Components/Component.ts:76

start

start(): Promise<void>
Called when object is created

Returns Promise<void>
- Defined in classes/Components/Component.ts:54

uiRender

uiRender(_canvas: VirtualCanvas): void
Used for rendering UI
Parameters
- _canvas: VirtualCanvas
Returns void
- Defined in classes/Components/Component.ts:82

update

update(): Promise<void>
Called every frame before render

Returns Promise<void>
- Defined in classes/Components/Component.ts:59

warn

warn(...obj: any): void
Utility function for logging. Logs using console.warn and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
- Defined in classes/Components/Component.ts:115

Generated using TypeDoc