ZylemFogOptions

@zylem/game-lib

---

@zylem/game-lib / entity / ZylemFogOptions

Interface: ZylemFogOptions

Defined in: packages/game-lib/src/lib/entities/fog.ts:44

Properties

color?

optional color?: ColorRepresentation

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

Fog colour. Default '#9aa3ad' (neutral grey).

---

density?

optional density?: number

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

Exp² density coefficient. Only used when type === 'exp2'. Default 0.015.

---

end?

optional end?: number

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

Linear-fog end distance. Only used when type === 'linear'. Default 250.

---

height?

optional height?: ZylemFogHeightOptions

Defined in: packages/game-lib/src/lib/entities/fog.ts:56

Optional vertical falloff. Disabled by default.

---

name?

optional name?: string

Defined in: packages/game-lib/src/lib/entities/fog.ts:60

Display name (mostly for debug overlays).

---

noise?

optional noise?: ZylemFogNoiseOptions

Defined in: packages/game-lib/src/lib/entities/fog.ts:58

Optional 3D animated noise. Disabled by default.

---

start?

optional start?: number

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

Linear-fog start distance. Only used when type === 'linear'. Default 10.

---

type?

optional type?: ZylemFogType

Defined in: packages/game-lib/src/lib/entities/fog.ts:46

Fog model. Default 'linear'.