Tutorial / Tools > World
Sounds
Sound emitters: a sound at a spot, on a loop, now and then, or when logic plays it. Pick from every sound of the mounted games.
What it does
Sounds places sound emitters. An emitter plays a sound at a spot, and players hear it within its radius. Emitters are saved for this map.
An emitter plays in one of three ways: on a loop while players are near, now and then after a random wait, or only when logic plays it. Logic can also turn emitters on and off.
The tool panel also has the live sound viewer. It shows every sound the server plays and the map's own ambient_generic sounds.
Where to find it
Q menu > KGX's Admin Toolbox > World > Sounds.
Toolbox admins can use it. Superadmins can also give it to players in Settings > Player Access. Players edit and remove only their own emitters, cannot use links, and are capped at a 1500 unit radius.
The sound browser on its own opens with the console command kgxat_sounds.
Given to a player (v3.6.11.3): Their own sound emitters (limit).
Controls
| Key | What it does |
|---|---|
| Left-click | Place a sound emitter with the settings below |
| Right-click | Give the aimed emitter the settings below |
| E + Right-click | Copy the aimed emitter's settings into the panel |
| Reload | Remove the aimed emitter |
While you hold the tool, each emitter shows as a small box with its name, id and sound path. A sphere shows its radius. Emitters that are off are gray and marked (off).
Options
Emitter settings
| Option | What it does | Default |
|---|---|---|
| Sound | The sound path, or an http(s) link to an mp3 or ogg (admins only). | ambient/levels/citadel/citadel_ambient_scream_loop1.wav |
| Browse every sound... (categorized, searchable) | Opens the sound browser. Pick a sound and click Use this sound. | |
| Play / stop the preview | Plays the sound in the Sound field for you. | |
| Name (optional) | Name of the emitter (up to 40 characters). Empty uses its id, such as S1. |
Empty |
| Plays | Loop (always, while players are near), Now and then (a random wait between the two times), or Only when logic plays it (Sound emitter: Play once now). | Loop |
| Volume % | Range 5 to 100. | 80 |
| Heard within (units) | The radius. Range 64 to 8000; players are capped at 1500. | 600 |
| Pitch % | Range 30 to 255. | 100 |
| Now and then: at least (s) | Shortest wait between plays. Range 1 to 600. | 10 |
| Now and then: at most (s) | Longest wait between plays. Range 1 to 600. | 30 |
| Starts on | The emitter is on when placed. | On |
Live sounds (playing now)
| Option | What it does | Default |
|---|---|---|
| Show the live sound viewer (on screen and in the world) | Lists sounds as they play. kgxat_sounds_live. |
Off |
| Also sounds your own game plays (footsteps, your weapon) | Adds your own client sounds. kgxat_sounds_live_client. |
On |
| Shown for (seconds) | How long a sound stays in the viewer. kgxat_sounds_live_secs, range 1 to 60. |
6 |
| Open the live sounds window (with the map's sounds) | Opens the live sounds window. |
Right-click a sound in the live window to play it, copy it, use it in this panel, or stop it on the server (admins).
Sound emitters on this map
A list with Id, Name, Sound and On columns, and a Search emitters... box. Right-click an emitter for:
- Turn on / off
- Go to (admins)
- Rename...
- Give it the settings above
- Remove
Reset to defaults at the bottom puts the emitter settings back to their defaults.
How to use it
Add a looping ambient sound
- Click Browse every sound... (categorized, searchable).
- Search for a sound, such as
alarm, and click Play to hear it. - Click Use this sound.
- Leave Plays on Loop (always, while players are near) and set Heard within (units).
- Left-click where the sound should come from.
Play a sound now and then
- Pick the sound and set Plays to Now and then (a random wait between the two times).
- Set Now and then: at least (s) and Now and then: at most (s).
- Left-click to place it. Players near it hear it after a random wait in that range.
Trigger a sound from logic
- Set Plays to Only when logic plays it (Sound emitter: Play once now) and place the emitter.
- In World > Logic, add the action Sound emitter on / off (Sounds tool).
- Target your emitter and pick Play once now, Turn on, Turn off or Toggle.
Change an emitter
- Aim at it, hold E and right-click to load its settings into the panel.
- Change the settings.
- Right-click the emitter (without E) to apply them.
Settings and commands
| Setting or command | What it does | Default | Range |
|---|---|---|---|
kgxat_soundnodes_on |
Client. 0 = you do not hear Sounds emitters. | 1 | 0 to 1 |
kgxat_sounds_live |
Client. 1 = show the live sound viewer. | 0 | 0 to 1 |
kgxat_sounds_live_secs |
Client. How long a sound stays in the live viewer (seconds). | 6 | 1 to 60 |
kgxat_sounds_live_client |
Client. 1 = the live viewer also shows your own game's sounds. | 1 | 0 to 1 |
kgxat_sounds |
Opens the sound browser. | ||
kgxat_sounds_livewindow |
Opens the live sounds window. | ||
kgxat_limit_soundnodes |
Most sound emitters a non-admin player may own (Settings > Limits). 0 = not allowed. | 3 | 0 to 100 |
Tips and limits
- Saved per map in
soundnodes_<map>.json. - A map holds at most 300 sound emitters.
- Most files in
ambient/loop by themselves. Other looping sounds start again when they end. - Links (http mp3, ogg, radio streams) play only in Loop mode.
- Turning an emitter on or off (by logic or Turn on / off in the list) is not saved. A restart puts it back to its Starts on setting. To change that for good, untick or tick Starts on and give the emitter the settings again.
- Admins can give the aimed emitter new settings even if another player placed it.