Classes:AmbientSound

From ZDoom Wiki
Jump to: navigation, search
Note: Wait! Stop! Before you copy this actor's definition into your mod, remember the following things:
  1. You do not need to copy that actor, since it is already defined.
  2. In fact, it's not just useless, it's actually harmful as it can cause problems.
  3. If you want to modify it, or use a modified version, using inheritance is the way to go.
  4. The actor definitions here are put on the wiki for reference purpose only. Learn from them, don't copy them.
  5. There is only one exception: if what you want is changing Ammo capacity, you need to create a new type from Ammo.
Ambient sound
Actor type Map spot Game MiniZDoomLogoIcon.png
DoomEd Number 14065 Class Name AmbientSound


Classes: ActorAmbientSound
 → AmbientSoundNoGravity

The AmbientSound thing plays an ambient sound determined by its first parameter. The sounds themselves must be defined in SNDINFO. While some ambient sounds are defined in ZDoom.pk3, none of them are actually added to the index of ambient sounds with the $ambient command, so a map using this thing needs a SNDINFO lump. Up to 64 ambient sounds can be used in the Doom map format and 256 in Hexen format. UDMF maps have no limit.

The second parameter determines the volume of the sound, as a percentile value. 0 is interpreted as the default (100).

The third parameter determines the minimum distance for sound fading to be applied. If left to zero, the standard rolloff is used instead.

The fourth parameter determines the maximum distance at which the sound can be heard. If left to zero, or if lower than the third parameter, the standard rolloff is used instead.

The fifth and last parameter, if not null, is a scalar for the third and fourth parameters.

Use in a Doom-format map

In a map format where things cannot have parameters, DoomEd numbers 14001 to 14064 can be used instead: ZDoom will translate each such item in the map to an AmbientSound actor whose first parameter is equal to its number minus 14000. (So, 14001 will be interpreted as if it were 14065 with first parameter 1.)

DECORATE definition

ACTOR AmbientSound 14065 native
{
  +NOBLOCKMAP
  +NOSECTOR
  +DONTSPLASH
}

See also