Skip to content

Commit 915d07b

Browse files
author
Red Eclipse
committed
Build docs:152 from ac99c71807add8ef2d100284e905d6749b4129b8
1 parent dbac86d commit 915d07b

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/Fx-Other.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,17 @@ This section briefly describes other effect types' properties.
3838

3939
## Sound properties
4040

41-
| Property name | Type | Min | Default | Max | Modifiers | Description |
42-
|---------------|---------|-------|---------|---------|--------------|----------------------------------------------------|
43-
| sound | String | [n/a] | | [n/a] | | Unique ID of the sound to be played |
44-
| volume | Integer | 0 | 255 | 255 | Random, Lerp | Sound volume |
45-
| flags | Integer | 0 | 0 | INT_MAX | | Playback flags (see *Sound flags*) |
46-
| minrad | Integer | -1 | -1 | INT_MAX | Random, Lerp | Minimum radius, below which there's no attenuation |
47-
| maxrad | Integer | -1 | -1 | INT_MAX | Random, Lerp | Maximum radius, above which sound is not audible |
48-
49-
**NOTE: Sound radius properties can take `-1` as value, in which case they will assume the default values from the definition of the sound slot.**
41+
| Property name | Type | Min | Default | Max | Modifiers | Description |
42+
|---------------|---------|-------|---------|---------|--------------|-------------------------------------------------------------------------------|
43+
| sound | String | [n/a] | | [n/a] | | Unique ID of the sound to be played |
44+
| gain | Float | 0 | 1 | 100 | Random, Lerp | Sound gain |
45+
| pitch | Float | 0 | 1 | 100 | Random, Lerp | Sound pitch |
46+
| rolloff | Float | -1 | -1 | FLT_MAX | Random, Lerp | Attentuation rate |
47+
| refdist | Float | -1 | -1 | FLT_MAX | Random, Lerp | Distance at which volume should attenuate to half, before roll-off influence. |
48+
| maxdist | Float | -1 | -1 | FLT_MAX | Random, Lerp | Distance, above which there's no more attenuation. |
49+
| flags | Integer | 0 | 0 | INT_MAX | | Playback flags (see *Sound flags*) |
50+
51+
**NOTE: `rolloff`, `refdist`, `maxdist` properties can take `-1` as value, in which case they will assume the default values from the definition of the sound slot.**
5052

5153
## Sound flags
5254

0 commit comments

Comments
 (0)