Home › Engine executable › Audio vocabulary

Engine executable. Settings and tools of the game program (CivilizationVI.exe), usable without a mod. Mostly undocumented debug and configuration functionality; descriptions come from analysis of the executable and have not all been tried in the running game.

Audio vocabulary

The names the engine executable passes to its audio system (Wwise): sound events, state and switch values, volume parameters, music playlists and the files that list sound banks. They are string literals referenced by the audio functions (209 names in 39 functions). Where a name is an event, a bank loaded by a mod needs an event with the same name for the game to play it; this page lists what the exe asks for, not what the game's own banks contain. Verified: the name and the function. Inferred: the explanations, from the function names.

See also the volume options and UI.PlaySound, which takes an event name directly from Lua.

Functions

Function	Names	Meaning (inferred)
StrategicAudio::StartupStrategyGame	63	Names the strategic audio system registers at game start: unit, city and district sounds (`_2D` suffix: sounds without a world position).
AudioMiner::ArtDefinitions::ConfigureFromArtDefs	22
StrategicAudio::OnUnitCommandStarted	22
AmbientAudio::Startup	19	Music playlists, music state names and the era and view state groups of the ambient audio system.
AudioMiner::RecalculateTerrainVisibility	14	Ambience categories the audio miner derives from what is visible on the map (terrain, features, improvements).
Civ6Audio::PublishSettingsTelemetry	9	Names of the audio settings reported in the telemetry options event.
Civ6Audio::RegisterOptions	6	The audio options (`SoundOpts.txt`): one volume per Wwise bus, registered here.
AppLuaOptionsLibrary::lSetAudioOption	5	`Options.SetAudioOption` accepts these bus names.
Audio::ReadSoundBankXML	4	Element names of a sound bank description file (`SoundBanks`, `SoundBank`, `IncludedEvents`, `Event`).
StrategicAudio::OnCombat	4
AmbientAudio::StartupStrategyGame	3	Per-civilization music override and playlist randomisation used when a game starts.
Audio::ReadSoundBankINI	3	Section names of `Banks.ini`: `Global` banks are loaded always, `InGame` banks while a game runs.
AppLuaLocaleLibrary::lGetAudioLanguages	2
AudioMiner::OnImprovementAddedToMap	2
AudioMiner::OnUnitAddedToMap	2
AudioMiner::StartupStrategyGame	2
StrategicAudio::OnImprovementAddedToMap	2
StrategicAudio::OnUnitEmbarkedStateChanged	2
StrategicAudio::OnUnitOperationStarted	2
StrategicAudio::ShutdownStrategyGame	2
AmbientAudio::OnLocalPlayerTurnBegin	1
AmbientAudio::OnPlayerDestroyed	1
AmbientAudio::StartStopMenuMusic	1
AudioMiner::OnFeatureAddedToMap	1
AudioMiner::OnUnitSimPositionChanged	1
Civ6Audio::AppActivated	1
FGXModelFramework::TimelineSet::Trigger::TriggerData::SoundData::GetTypeInfo	1
StrategicAudio::OnBarbarianClanBribed	1
StrategicAudio::OnBarbarianClanDispersed	1
StrategicAudio::OnBarbarianClanHired	1
StrategicAudio::OnBarbarianClanIncited	1
StrategicAudio::OnBarbarianClanRaided	1
StrategicAudio::OnBarbarianClanRansomed	1
StrategicAudio::OnPostTourismBomb	1
StrategicAudio::OnUnitAirlifted	1
StrategicAudio::OnUnitJumped	1
StrategicAudio::OnUnitKilledInCombat	1
StrategicAudio::OnUnitSelected	1
UIAudio::Startup	1

StrategicAudio::StartupStrategyGame

Names the strategic audio system registers at game start: unit, city and district sounds (_2D suffix: sounds without a world position).

63 names

Name	Kind
`ANCIENT_ERA`	UPPER_CASE (state, switch, parameter or enum value)
`BARBARIAN_UNIT_REVEALED`	UPPER_CASE (state, switch, parameter or enum value)
`BUILDER_BUILDIMPROVEMENT_WATER_2D`	UPPER_CASE (state, switch, parameter or enum value)
`Break_Formation`	Event-style name (words joined by underscores)
`Build_City`	Event-style name (words joined by underscores)
`Build_Improvement_2D`	Event-style name (words joined by underscores)
`Builder_BuildImprovement_Water`	Event-style name (words joined by underscores)
`Builder_BuildImprovement_Water_2D`	Event-style name (words joined by underscores)
`CITY_ATTACK_2D`	UPPER_CASE (state, switch, parameter or enum value)
`CIVILIZATION`	UPPER_CASE (state, switch, parameter or enum value)
`ClaimGreatPerson`	other name
`Create_Army`	Event-style name (words joined by underscores)
`Create_Corps`	Event-style name (words joined by underscores)
`Create_Formation`	Event-style name (words joined by underscores)
`Flagellant_2D_Purge`	Event-style name (words joined by underscores)
`GAME_LOCATION`	UPPER_CASE (state, switch, parameter or enum value)
`GAME_VIEWS`	UPPER_CASE (state, switch, parameter or enum value)
`GDR_2D_Jump`	other name
`Great_Person_Activate`	Event-style name (words joined by underscores)
`NORMAL_VIEW`	UPPER_CASE (state, switch, parameter or enum value)
`Notification_Discover_Barbarians`	Event-style name (words joined by underscores)
`Notification_Discover_Natural_Wonder`	Event-style name (words joined by underscores)
`Notification_Discover_Ruins`	Event-style name (words joined by underscores)
`Notification_Discover_Ruins_Royale`	Event-style name (words joined by underscores)
`Notification_New_Policy`	Event-style name (words joined by underscores)
`Notification_New_Production`	Event-style name (words joined by underscores)
`Notification_New_Tech`	Event-style name (words joined by underscores)
`Notification_Other_Civ_Build_Wonder`	Event-style name (words joined by underscores)
`Notification_Player_Build_Wonder`	Event-style name (words joined by underscores)
`Notification_Unit_Death`	Event-style name (words joined by underscores)
`Notification_War_Declared`	Event-style name (words joined by underscores)
`Nuke_Attack_2D`	Event-style name (words joined by underscores)
`Nuke_Attack_Smaller_2D`	Event-style name (words joined by underscores)
`Opponent_Civ_Unit_Revealed`	Event-style name (words joined by underscores)
`PlagueDoctor_2D_Minister`	other name
`PlagueDoctor_2D_Pacify`	other name
`Play_Combat_Snippets`	Event-style name (words joined by underscores)
`Play_Leader_Music`	Event-style name (words joined by underscores)
`Play_RockBand`	Event-style name (words joined by underscores)
`Player_Unit_Captured`	Event-style name (words joined by underscores)
`Repair_Improvement_2D`	Event-style name (words joined by underscores)
`RockBand_Cleveland`	other name
`RockBand_Success`	other name
`Scholar_2D_Study`	Event-style name (words joined by underscores)
`TRIGGER_BARBARIAN_RAID_AT_BORDERS`	UPPER_CASE (state, switch, parameter or enum value)
`TRIGGER_BARBARIAN_SPOTTED_PLAYER`	UPPER_CASE (state, switch, parameter or enum value)
`UI_Lens_Off`	other name
`UI_Lens_On`	other name
`UNIT_DEATH_2D`	UPPER_CASE (state, switch, parameter or enum value)
`UNIT_PILLAGE_2D`	UPPER_CASE (state, switch, parameter or enum value)
`UNIT_PILLAGE_3D`	UPPER_CASE (state, switch, parameter or enum value)
`UNIT_PROMOTION_AVAILABLE`	UPPER_CASE (state, switch, parameter or enum value)
`Unit_Attack_2D`	Event-style name (words joined by underscores)
`Unit_Combat_Lose_2D`	Event-style name (words joined by underscores)
`Unit_Combat_Lose_3D`	Event-style name (words joined by underscores)
`Unit_Combat_Win_2D`	Event-style name (words joined by underscores)
`Unit_Combat_Win_3D`	Event-style name (words joined by underscores)
`Unit_Disembark_2D`	Event-style name (words joined by underscores)
`Unit_Embark_2D`	Event-style name (words joined by underscores)
`Unit_Fortify`	Event-style name (words joined by underscores)
`Unit_Move_2D`	Event-style name (words joined by underscores)
`Unit_Promoted`	Event-style name (words joined by underscores)
`Unit_Selected`	Event-style name (words joined by underscores)

AudioMiner::ArtDefinitions::ConfigureFromArtDefs

22 names

Name	Kind
`AmbPlay`	other name
`AmbStop`	other name
`Audio`	other name
`Civilization`	other name
`Civilizations`	other name
`DawnName`	other name
`District`	other name
`Districts`	other name
`Feature`	other name
`Features`	other name
`GoodyHut`	other name
`GoodyHuts`	other name
`Improvement`	other name
`Improvements`	other name
`Leaders`	other name
`Resource`	other name
`Resources`	other name
`SubType`	other name
`Terrain`	other name
`Terrains`	other name
`Units`	other name
`XrefName`	other name

StrategicAudio::OnUnitCommandStarted

22 names

Name	Kind
`Anansi_Tricks_2D`	Event-style name (words joined by underscores)
`Arthur_Accolades_2D`	Event-style name (words joined by underscores)
`Beowulf_Challenge_2D`	Event-style name (words joined by underscores)
`Hercules_Labor_2D`	Event-style name (words joined by underscores)
`Hercules_Rage_2D`	Event-style name (words joined by underscores)
`Himiko_Rule_2D`	Event-style name (words joined by underscores)
`Hippolyta_Command_2D`	Event-style name (words joined by underscores)
`Maui_Invention_2D`	Event-style name (words joined by underscores)
`Pirates_Bring_Her_Home_2D`	Event-style name (words joined by underscores)
`Pirates_Bury_Treasure_2D`	Event-style name (words joined by underscores)
`Pirates_Capture_Boat_2D`	Event-style name (words joined by underscores)
`Pirates_Careening_2D`	Event-style name (words joined by underscores)
`Pirates_Chain_Shot_2D`	Event-style name (words joined by underscores)
`Pirates_Shore_Party_Disembark_2D`	Event-style name (words joined by underscores)
`Pirates_Shore_Party_Embark_2D`	Event-style name (words joined by underscores)
`Pirates_Tack_Into_Wind_2D`	Event-style name (words joined by underscores)
`Pirates_Visit_Tavern_2D`	Event-style name (words joined by underscores)
`Pirates_Walk_The_Plank_2D`	Event-style name (words joined by underscores)
`ScoutDogPet_2D`	other name
`Sinbad_Fortunes_2D`	Event-style name (words joined by underscores)
`Zombie_ReleaseControl`	Event-style name (words joined by underscores)
`Zombie_ReleaseControl_2D`	Event-style name (words joined by underscores)

AmbientAudio::Startup

Music playlists, music state names and the era and view state groups of the ambient audio system.

19 names

Name	Kind
`ANCIENT_ERA`	UPPER_CASE (state, switch, parameter or enum value)
`CIVILIZATION`	UPPER_CASE (state, switch, parameter or enum value)
`End_Music_Snippet`	Event-style name (words joined by underscores)
`EnviroBedObject`	other name
`GAME_LOCATION`	UPPER_CASE (state, switch, parameter or enum value)
`GAME_VIEWS`	UPPER_CASE (state, switch, parameter or enum value)
`Game_Music_Playlist`	Event-style name (words joined by underscores)
`Game_Start_Music`	Event-style name (words joined by underscores)
`INDUSTRIAL_ERA`	UPPER_CASE (state, switch, parameter or enum value)
`MEDIEVAL_ERA`	UPPER_CASE (state, switch, parameter or enum value)
`MODERN_ERA`	UPPER_CASE (state, switch, parameter or enum value)
`NORMAL_VIEW`	UPPER_CASE (state, switch, parameter or enum value)
`Play_Map_Ambience`	Event-style name (words joined by underscores)
`Play_Map_Ambience_Royale`	Event-style name (words joined by underscores)
`Play_Menu_Music`	Event-style name (words joined by underscores)
`Play_Silence`	Event-style name (words joined by underscores)
`Stop_Ingame_Music`	Event-style name (words joined by underscores)
`Stop_Map_Ambience`	Event-style name (words joined by underscores)
`Stop_Silence`	Event-style name (words joined by underscores)

AudioMiner::RecalculateTerrainVisibility

Ambience categories the audio miner derives from what is visible on the map (terrain, features, improvements).

14 names

Name	Kind
`AUTO_`	UPPER_CASE (state, switch, parameter or enum value)
`AudioMiner_RecalcTerrainVisibility`	other name
`BarbarianCamp`	other name
`Coast`	other name
`Desert`	other name
`FishingBoat`	other name
`GAME_LOCATION`	UPPER_CASE (state, switch, parameter or enum value)
`GolfCourse`	other name
`GoodyHut`	other name
`HockeyRink`	other name
`NileRiver`	other name
`NubianPyramid`	other name
`Ocean`	other name
`Tundra`	other name

Civ6Audio::PublishSettingsTelemetry

Names of the audio settings reported in the telemetry options event.

9 names

Name	Kind
`AmbienceVolume`	other name
`AudioOptions`	other name
`MasterVolume`	other name
`MusicVolume`	other name
`MuteOnFocusLoss`	other name
`Options`	other name
`SFXVolume`	other name
`Session`	other name
`SpeechVolume`	other name

Civ6Audio::RegisterOptions

The audio options (SoundOpts.txt): one volume per Wwise bus, registered here.

6 names

Name	Kind
`AMBIENCE_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`GAMEMASTER_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`MASTER_MUSIC_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`MASTER_SFX_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`MASTER_SPEECH_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`Sound`	other name

AppLuaOptionsLibrary::lSetAudioOption

Options.SetAudioOption accepts these bus names.

5 names

Name	Kind
`AMBIENCE_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`GAMEMASTER_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`MASTER_MUSIC_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`MASTER_SFX_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)
`MASTER_SPEECH_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)

Audio::ReadSoundBankXML

Element names of a sound bank description file (SoundBanks, SoundBank, IncludedEvents, Event).

4 names

Name	Kind
`Event`	other name
`IncludedEvents`	other name
`SoundBank`	other name
`SoundBanks`	other name

StrategicAudio::OnCombat

4 names

Name	Kind
`Nuke_Attack_2D_`	other name
`Nuke_Attack_Smaller_2D_`	other name
`Unit_Attack_2D_`	other name
`WMD_THERMONUCLEAR_DEVICE`	UPPER_CASE (state, switch, parameter or enum value)

AmbientAudio::StartupStrategyGame

Per-civilization music override and playlist randomisation used when a game starts.

3 names

Name	Kind
`CivilizationType`	other name
`MusicOverride`	other name
`PLAYLIST_RANDOMIZE_ALL_ERAS`	UPPER_CASE (state, switch, parameter or enum value)

Audio::ReadSoundBankINI

Section names of Banks.ini: Global banks are loaded always, InGame banks while a game runs.

3 names

Name	Kind
`Global`	other name
`InGame`	other name
`InvalidSection`	other name

AppLuaLocaleLibrary::lGetAudioLanguages

2 names

Name	Kind
`AudioLanguage`	other name
`Locale`	other name

AudioMiner::OnImprovementAddedToMap

2 names

Name	Kind
`Coast`	other name
`Ocean`	other name

AudioMiner::OnUnitAddedToMap

2 names

Name	Kind
`Unit_Combat_Lose_2D_`	other name
`Unit_Death_2D_`	other name

AudioMiner::StartupStrategyGame

2 names

Name	Kind
`RULESET_SCENARIO_CIV_ROYALE`	UPPER_CASE (state, switch, parameter or enum value)
`RULESET_SCENARIO_PIRATES`	UPPER_CASE (state, switch, parameter or enum value)

StrategicAudio::OnImprovementAddedToMap

2 names

Name	Kind
`IMPROVEMENT_FEITORIA`	UPPER_CASE (state, switch, parameter or enum value)
`IMPROVEMENT_INDUSTRY`	UPPER_CASE (state, switch, parameter or enum value)

StrategicAudio::OnUnitEmbarkedStateChanged

2 names

Name	Kind
`Unit_Disembark_2D_`	other name
`Unit_Embark_2D_`	other name

StrategicAudio::OnUnitOperationStarted

2 names

Name	Kind
`Coast`	other name
`Ocean`	other name

StrategicAudio::ShutdownStrategyGame

2 names

Name	Kind
`STOP_ADVISOR_SPEECH_ALL`	UPPER_CASE (state, switch, parameter or enum value)
`Stop_All_Units`	Event-style name (words joined by underscores)

AmbientAudio::OnLocalPlayerTurnBegin

1 names

Name	Kind
`SafeZonePhase`	other name

AmbientAudio::OnPlayerDestroyed

1 names

Name	Kind
`Notification_Player_Eliminated`	Event-style name (words joined by underscores)

AmbientAudio::StartStopMenuMusic

1 names

Name	Kind
`Stop_Main_Menu_Music`	Event-style name (words joined by underscores)

AudioMiner::OnFeatureAddedToMap

1 names

Name	Kind
`AUTO_`	UPPER_CASE (state, switch, parameter or enum value)

AudioMiner::OnUnitSimPositionChanged

1 names

Name	Kind
`Stop_Unit_Move_2D_`	other name

Civ6Audio::AppActivated

1 names

Name	Kind
`GAMEMASTER_BUS_VOLUME`	UPPER_CASE (state, switch, parameter or enum value)

FGXModelFramework::TimelineSet::Trigger::TriggerData::SoundData::GetTypeInfo

1 names

Name	Kind
`FXNameHash`	other name

StrategicAudio::OnBarbarianClanBribed

1 names

Name	Kind
`BarbarianClan_Bribe_2D`	other name

StrategicAudio::OnBarbarianClanDispersed

1 names

Name	Kind
`BarbarianClan_Disperse_2D`	other name

StrategicAudio::OnBarbarianClanHired

1 names

Name	Kind
`BarbarianClan_Hire_2D`	other name

StrategicAudio::OnBarbarianClanIncited

1 names

Name	Kind
`BarbarianClan_Incite_2D`	other name

StrategicAudio::OnBarbarianClanRaided

1 names

Name	Kind
`BarbarianClan_Raid_2D`	other name

StrategicAudio::OnBarbarianClanRansomed

1 names

Name	Kind
`BarbarianClan_Ransom_2D`	other name

StrategicAudio::OnPostTourismBomb

1 names

Name	Kind
`LOC_CITY_NAME_CLEVELAND`	UPPER_CASE (state, switch, parameter or enum value)

StrategicAudio::OnUnitAirlifted

1 names

Name	Kind
`Unit_Airlift`	Event-style name (words joined by underscores)

StrategicAudio::OnUnitJumped

1 names

Name	Kind
`UNIT_GIANT_DEATH_ROBOT`	UPPER_CASE (state, switch, parameter or enum value)

StrategicAudio::OnUnitKilledInCombat

1 names

Name	Kind
`Pirates_Sink_Enemy_2D`	Event-style name (words joined by underscores)

StrategicAudio::OnUnitSelected

1 names

Name	Kind
`Unit_Selected_`	other name

UIAudio::Startup

1 names

Name	Kind
`Play_UI_Click`	Event-style name (words joined by underscores)