Nuclide
Software Development Kit for id Technology
Public Member Functions | List of all members
env_sound Class Reference
Server Game | Entities » Point Entities | Sound System

About this class

Server-Entity: GoldSrc Audio DSP/Reverb Controller.

QUAKED env_sound (1 .5 0) (-8 -8 -8) (8 8 8)

OVERVIEW

Environmental audio reverb modifier.

KEYS

  • "radius" : Radius in units.
  • "roomtype" : See room type list.

NOTES

This works only with the OpenAL sound backend.

Room types

  • 0 - Default.
  • 1 - Generic location.
  • 2 - small room, out of metal.
  • 3 - Medium room, out of metal.
  • 4 - Large room, out of metal.
  • 5 - Small tunnel.
  • 6 - Medium tunnel.
  • 7 - Large tunnel.
  • 8 - Small chamber.
  • 9 - Medium chamber.
  • 10 - Large chamber.
  • 11 - Small, 'bright' room.
  • 12 - Medium, 'bright' room.
  • 13 - Large, 'bright' room.
  • 14 - Underwater, style #1.
  • 15 - Underwater, style #2.
  • 16 - Underwater, style #3.
  • 17 - Small concrete room.
  • 18 - Medium concrete room.
  • 19 - Large concrete room.
  • 20 - Big room style #1.
  • 21 - Big room style #2.
  • 22 - Big room style #3.
  • 23 - Small cavern.
  • 24 - Medium cavern.
  • 25 - Large cavern.
  • 26 - Weirdo preset #1.
  • 27 - Weirdo preset #2.
  • 28 - Weirdo preset #3.

TRIVIA

This entity was introduced in Half-Life (1998).

Inheritance diagram for env_sound:
NSSoundScape

Public Member Functions

void env_sound (void)
 
virtual void SpawnKey (string, string)
 This method handles entity key/value pairs on map load. More...
 
nonvirtual void SetRoomType (int)
 Sets the reverb parameters to that of a legacy room type. More...
 

Constructor & Destructor Documentation

◆ env_sound()

void env_sound::env_sound ( void  )

Member Function Documentation

◆ SetRoomType()

void env_sound::SetRoomType ( int  roomType)

Sets the reverb parameters to that of a legacy room type.

◆ SpawnKey()

void env_sound::SpawnKey ( string  strKey,
string  strValue 
)
virtual

This method handles entity key/value pairs on map load.

You can easily convert the strValue parameter using the ReadFloat etc. methods that are part of NSIO.

Reimplemented from NSSoundScape.

The documentation for this class was generated from the following file: