Wwise Help

The definition file can also include special keywords that define the types of project elements that will be included or excluded from the SoundBanks. The following keywords can be used:

When using the Event, Media, and Structure keywords, you can add one or more of these keywords after the Event or effect name, with each one being separated by a tab. If no keywords are included in the definition file, the SoundBank will include all project elements and media. The following illustration demonstrates how these keywords should be used within a definition file. (→ indicates the TAB character)

            SB1→"Event_01"
            SB1→"Event_02"→Structure 
            SB1→"Event_03"→Media→Structure 
            SB1→"Event_04"→Event→Media→Structure

In the previous illustration, the first SoundBank called “My_SoundBank_Normal” will include all Event data, structure data, and media files associated with Event_01. The second SoundBank called “My_SoundBank_EventandStructure” will include only the Event and structure data associated with Event_02. The third and final SoundBank called “My_SoundBank_Media” will include only the media files associated with Event_03.

	Note
	All Events included in the definition file must already be created in Wwise. If any are missing, they will appear as “Event Missing” in the Import Definition Log.

When using the -GameSyncExclusion keyword, you must create a separate entry on a new line for each exclusion. By excluding a game sync, you exclude all corresponding object structures and media files as well. The following illustration demonstrates how the -GameSyncExclusion keywords should be written within a definition file. (→ indicates the TAB character)

            SB1→-GameSyncExclusion→State→StateGroupName→StateName 
            SB1→-GameSyncExclusion→Switch→SwitchGroupName→StateName 
            SB1→-GameSyncExclusion→Trigger→Trigger

	Note
	The names of the game syncs (State Groups, States, Switch Groups, Switches, and Triggers) do not require the use of quotes (“).

When using the -EffectShareset keyword, you must create a separate entry on a new line for each effect inclusion. For example: (→ indicates the TAB character)

            SB1→-EffectShareset→"effect1"→Media 
            SB1→-EffectShareset→"effect2"→Structure 
            SB1→-EffectShareset→"effect3"→Media→Structure

If your game is not using strings for Event names, you can use either of the following systems to define the Events in the definition file:

	Note
	The hexadecimal and decimal systems can be used to identify Events within a definition file, but not States, Switches, and Triggers in Game Sync exclusions.

The following illustration demonstrates how to define Events in a definition file using the three different systems. (→ indicates the TAB character)

            SB1→"Event_01" 
            SB1→26507443 
            SB1→0x19478B3

Tip

The SoundBank definition file can also be used to track which Events have already been integrated into your game, which ones are missing, and which ones still need to be created in Wwise. One of the programmers can generate the list of Events from the game and then you can import the definition file into Wwise. You can use the information in the log file to match up the Events in game with those created in Wwise.