@tmrw-realityos/world

---

@tmrw-realityos/world / Components / Light

Class: Light

Defined in: world/components/light.ts:11

Light component

Extends

• BaseComponent

Constructors

Constructor

new Light(): Light

Defined in: world/components/light.ts:16

Returns

Light

Overrides

BaseComponent.constructor

Properties

enabled

enabled: boolean = true

Defined in: world/components.ts:7

Inherited from

BaseComponent.enabled

---

light

light: LightActor

Defined in: world/components/light.ts:14

---

mustSave

mustSave: boolean = true

Defined in: world/components.ts:8

Inherited from

BaseComponent.mustSave

---

parent?

optional parent: ComponentsContainer

Defined in: world/components.ts:14

Inherited from

BaseComponent.parent

---

uid

uid: string = ""

Defined in: world/components.ts:9

Inherited from

BaseComponent.uid

---

compName

static compName: string = "Light"

Defined in: world/components/light.ts:12

Overrides

BaseComponent.compName

Accessors

color

Get Signature

get color(): vec3

Defined in: world/components/light.ts:30

Returns

vec3

Set Signature

set color(v): void

Defined in: world/components/light.ts:26

Parameters

v

vec3

Returns

void

---

coneAngle

Get Signature

get coneAngle(): vec2

Defined in: world/components/light.ts:71

Returns

vec2

Set Signature

set coneAngle(v): void

Defined in: world/components/light.ts:66

Parameters

v

number[] | vec2

Returns

void

---

coneMax

Get Signature

get coneMax(): number

Defined in: world/components/light.ts:62

Returns

number

Set Signature

set coneMax(v): void

Defined in: world/components/light.ts:58

Parameters

v

number

Returns

void

---

coneMin

Get Signature

get coneMin(): number

Defined in: world/components/light.ts:54

Returns

number

Set Signature

set coneMin(v): void

Defined in: world/components/light.ts:50

Parameters

v

number

Returns

void

---

entity

Get Signature

get entity(): undefined | Entity

Defined in: world/components.ts:24

Returns

undefined | Entity

Set Signature

set entity(_v): void

Defined in: world/components.ts:27

Parameters

_v

Entity

Returns

void

Inherited from

BaseComponent.entity

---

intensity

Get Signature

get intensity(): number

Defined in: world/components/light.ts:38

Returns

number

Set Signature

set intensity(v): void

Defined in: world/components/light.ts:34

Parameters

v

number

Returns

void

---

range

Get Signature

get range(): number

Defined in: world/components/light.ts:46

Returns

number

Set Signature

set range(v): void

Defined in: world/components/light.ts:42

Parameters

v

number

Returns

void

---

type

Get Signature

get type(): eLightType

Defined in: world/components/light.ts:79

Returns

eLightType

Set Signature

set type(v): void

Defined in: world/components/light.ts:75

Parameters

v

eLightType

Returns

void

Methods

configure()

configure(o): void

Defined in: world/components/light.ts:83

Parameters

o

color

number[] | vec3

intensity

number

range

number

type

string | number

Returns

void

Overrides

BaseComponent.configure

---

getCompName()

getCompName(): string

Defined in: world/components.ts:11

Returns

string

Inherited from

BaseComponent.getCompName

---

onAdded()

onAdded(): void

Defined in: world/components/light.ts:22

Returns

void

Overrides

BaseComponent.onAdded

---

onClick()?

optional onClick(): void

Defined in: world/components.ts:19

Returns

void

Inherited from

BaseComponent.onClick

---

onRemoved()?

optional onRemoved(): void

Defined in: world/components.ts:22

Returns

void

Inherited from

BaseComponent.onRemoved

---

onUpdate()?

optional onUpdate(dt): void

Defined in: world/components.ts:20

Parameters

dt

number

Returns

void

Inherited from

BaseComponent.onUpdate

---

serialize()

serialize(): void

Defined in: world/components.ts:17

Returns

void

Inherited from

BaseComponent.serialize