Version
Wwise comes with a variety of actions that you can use to drive the sound, music, and motion in game. The actions are grouped by category and each category contains a series of actions that you can choose from.
Each action also has a set of properties, such as delays and fades, that you can use to better manage the incoming and outgoing objects. The following table describes each of the event actions.
Note | |
---|---|
The following descriptions are general descriptions and do not take into account the scope setting for each action. The scope, which is either Game Object or Global, specifies the extent to which the action is applied to objects within the game. |
Event Action |
Description |
---|---|
Play |
Plays back the associated object. |
Post Event |
Triggers an event from within another event. |
Break |
Stops playback of a looped sound or continuous container while allowing the current object or objects to finish playing. |
Stop |
Stops playback of the associated object. |
Stop All |
Stops playback of all objects. |
Stop All Except |
Stops playback of all objects except those specified. |
Pause |
Pauses playback of the associated object. |
Pause All |
Pauses playback of all objects. |
Pause All Except |
Pauses playback of all objects except those specified. |
Resume |
Resumes playback of the associated object that had previously been paused. |
Resume All |
Resumes playback of all paused objects. |
Resume All Except |
Resumes playback of all paused objects, except those specified. |
Mute |
Silences the associated object. |
Unmute |
Returns the associated object to its original “pre-silenced” volume level. |
Unmute All |
Returns all objects to their original “pre-silenced” volume levels. |
Unmute All Except |
Returns all objects, except those specified, to their original “pre-silenced” volume levels. |
Set Volume |
Changes the volume level of the associated object. |
Reset Volume |
Returns the volume of the associated object to its original level. |
Reset Volume All |
Returns the volume of all objects to their original levels. |
Reset Volume All Except |
Returns the volume of all objects, except those specified, to their original levels. |
Set Pitch |
Changes the pitch for the associated object. |
Reset Pitch |
Returns the pitch of the associated object to its original value. |
Reset Pitch All |
Returns the pitch of all objects to their original values. |
Reset Pitch All Except |
Returns the pitch of all objects, except those specified, to their original values. |
Set Low-pass Filter |
Changes the amount of low pass filter applied to the associated Wwise object. Low-pass Filter does not affect motion objects. |
Reset Low-pass Filter |
Returns the amount of low pass filter applied to the associated Wwise object to its original value. Low-pass Filter does not affect motion objects. |
Reset Low-pass Filter All |
Returns the amount of low pass filter applied to all Wwise objects to their original values. Low-pass Filter does not affect motion objects. |
Reset Low-pass Filter All Except |
Returns the amount of low pass filter applied to all Wwise objects, except the ones that you specified, to their original values. Low-pass Filter does not affect motion objects. |
Set High-pass Filter |
Changes the amount of high-pass filter applied to the associated Wwise object. High-pass Filter does not affect motion objects. |
Reset High-pass Filter |
Returns the amount of high-pass filter applied to the associated Wwise object to its original value. High-pass Filter does not affect motion objects. |
Reset High-pass Filter All |
Returns the amount of high-pass filter applied to all Wwise objects to their original values. High-pass Filter does not affect motion objects. |
Reset High-pass Filter All Except |
Returns the amount of high-pass filter applied to all Wwise objects, except the ones that you specified, to their original values. High-pass Filter does not affect motion objects. |
Set State |
Activates a specific State. |
State > Enable State |
Re-enables the State or States applicable to the associated Wwise object after having applied a Disable State Action. |
State > Disable State |
Disables the State or States for the associated Wwise object. |
Set Switch |
Activates a specific Switch. |
Enable Bypass |
Bypasses the effect(s) applied to the associated Wwise object. |
Disable Bypass |
Removes the effect bypass which re-applies the effect(s) to the associated Wwise object. |
Reset Bypass Effect |
Returns the bypass effect option of the associated object to its original setting. |
Reset Bypass Effect All |
Returns the bypass effect option of all Wwise objects to their original settings. |
Reset Bypass Effect All Except |
Returns the bypass effect option of all Wwise objects, except the ones that you specified, to their original settings. |
Trigger |
Calls a trigger that, in turn, launches a stinger. |
Seek |
Changes the playback position of the associated Wwise object. It has no effect on objects that are not currently playing. |
SeekAll |
Changes the playback position of all Wwise objects. It has no effect on objects that are not currently playing. |
Release Envelope |
Releases envelopes associated to the Wwise object. |
Reset Playlist |
Reset playlist of the specified random/sequence container to the initial state. This has no impact on the continuous mode playback nor on currently playing sounds. |
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise