Skip to main content

SpotLightOptions

@zylem/game-lib

@zylem/game-lib / entity / SpotLightOptions

Interface: SpotLightOptions

Defined in: packages/game-lib/src/lib/entities/light.ts:90

Extends​

  • BaseLightOptions

Properties​

angle?​

optional angle?: number

Defined in: packages/game-lib/src/lib/entities/light.ts:99

Cone angle in radians. Default Math.PI / 3.

castShadow?​

optional castShadow?: boolean

Defined in: packages/game-lib/src/lib/entities/light.ts:102

color?​

optional color?: ColorRepresentation

Defined in: packages/game-lib/src/lib/entities/light.ts:50

Light colour. Default #ffffff.

Inherited from​

BaseLightOptions.color

decay?​

optional decay?: number

Defined in: packages/game-lib/src/lib/entities/light.ts:97

Physical falloff exponent. Default 2.

distance?​

optional distance?: number

Defined in: packages/game-lib/src/lib/entities/light.ts:95

Maximum range of the light (0 = infinite).

intensity?​

optional intensity?: number

Defined in: packages/game-lib/src/lib/entities/light.ts:52

Scalar intensity multiplier. Default 1.

Inherited from​

BaseLightOptions.intensity

name?​

optional name?: string

Defined in: packages/game-lib/src/lib/entities/light.ts:48

Inherited from​

BaseLightOptions.name

penumbra?​

optional penumbra?: number

Defined in: packages/game-lib/src/lib/entities/light.ts:101

Penumbra softness in [0, 1]. Default 0.

position?​

optional position?: Vec3

Defined in: packages/game-lib/src/lib/entities/light.ts:54

World-space position. Default \{0,0,0\}. Not meaningful for ambient.

Inherited from​

BaseLightOptions.position

shadow?​

optional shadow?: Omit<LightShadowOptions, "top" | "left" | "right" | "bottom">

Defined in: packages/game-lib/src/lib/entities/light.ts:104

Shadow options (directional-only frustum fields are ignored).

target?​

optional target?: Vec3

Defined in: packages/game-lib/src/lib/entities/light.ts:93

World-space point the cone aims at. Default origin.

type​

type: "spot"

Defined in: packages/game-lib/src/lib/entities/light.ts:91