fog
Fog tags describe the colour and density properties of fog which can be applied to BSP fog planes using Sapien.
Non-planar atmospheric fog does not use a fog tag, and is instead controlled by the sky tag.
Known issues
Due to a renderer regression, the screen layers effect of these tags does not render on PC or MCC.
Structure and fields
Field | Type | Comments | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
flags | bitfield(32) |
|||||||||||||
|
||||||||||||||
pad(4) |
||||||||||||||
pad(76) |
||||||||||||||
pad(4) |
||||||||||||||
maximum density | Fraction: f32 |
Scales how dense the fog is at its opaque distance and depth, where
|
||||||||||||
pad(4) |
||||||||||||||
opaque distance | f32 (world units) |
The distance from the player where the fog reaches its maximum density. |
||||||||||||
pad(4) |
||||||||||||||
opaque depth | f32 (world units) |
The distance from the fog plane where the fog reaches its maximum density. |
||||||||||||
pad(8) |
||||||||||||||
distance to water plane | f32 (world units) |
|||||||||||||
color | |
|||||||||||||
flags 1 | bitfield(16) |
|||||||||||||
|
||||||||||||||
layer count | u16 |
|||||||||||||
distance gradient | f32 (world units) (min & max) |
|||||||||||||
density gradient | Fraction: f32 (min & max) |
|
||||||||||||
start distance from fog plane | f32 (world units) |
|||||||||||||
pad(4) |
||||||||||||||
screen layers color | |
Sets the colour of the screen layer volumetrics particles. Note that this effect only works on the original Xbox version of the game. |
||||||||||||
rotation multiplier | Fraction: f32 |
|
||||||||||||
strafing multiplier | Fraction: f32 |
|
||||||||||||
zoom multiplier | Fraction: f32 |
|
||||||||||||
pad(8) |
||||||||||||||
map scale | f32 |
|||||||||||||
map | ||||||||||||||
animation period | f32 (seconds) |
|||||||||||||
pad(4) |
||||||||||||||
wind velocity | f32 (world units per second) (min & max) |
|||||||||||||
wind period | f32 (seconds) (min & max) |
|||||||||||||
wind acceleration weight | Fraction: f32 |
|
||||||||||||
wind perpendicular weight | Fraction: f32 |
|
||||||||||||
pad(8) |
||||||||||||||
background sound | |
Overrides the background sound of the cluster while under the fog plane. This is used for underwater areas. |
||||||||||||
sound environment | |
Overrides the sound environment of the cluster while under the fog plane. This is used for underwater areas. |
||||||||||||
pad(120) |
This information was partially generated using Invader tag definitions.
Acknowledgements
Thanks to the following individuals for their research or contributions to this topic:
- Kavawuvi (Invader tag definitions)
- MosesOfEgypt (Tag structure research)