Table of Contents

Event Editor

The Event Editor is where you manage the Action Events in your project. Action Events contain Actions, such as Play, Pause All, and Stop All, that have been applied to different objects or structures. These Events are integrated into the game engine and are triggered at different points in the game. Each Event can contain several Actions. You can further specify particular properties for each Action and apply certain conditions.

The following colors are used in the Event Editor to help you identify the status of objects within an Event:

  • White - For objects included in the current platform.

  • Gray - For objects not included in the current platform.

  • Red - For Event Actions that are missing an associated object. The Target field will be outlined in red if there is no target object, including if there is a specified target that cannot be found. In that case, the object name will also be displayed in red.

Interface Element

Description

Name

The name of the Event. Each Event must have a unique name.

Event ID

An identification number associated with the Event. Each Event is assigned a unique number by Wwise.

Event IDs can be used instead of Event names in projects where the game engine does not support text strings.

Notes

Any additional information that you want to attach to the Event to further describe it.

 

[Event Actions]

The primary Event Editor pane. The Event's Actions are listed, added, removed, and edited from here.

Click the Configure Columns... shortcut (right-click) option from the column header band.

The Object Property Settings dialog box opens. Select the individual properties for every possible Wwise object type that you wish to display as a column.

Icon

An icon representing individual or small logical groupings of Action types.

Here is a comprehensive list of the different icons:

  • : Play

  • : Stop

  • : Pause

  • : Resume

  • : Break

  • : Seek

  • : Post Event

  • : Volume

  • : Pitch

  • : LPF

  • : HPF

  • : Mute

  • : Game Parameter

  • : State

  • : Switch

  • : Trigger

  • : Bypass

  • : Reset Envelope

  • : Reset Playlist

Path

The location of the selected Event within the project hierarchy. The Action and its Target, or number of exceptions in the case of an "All" Actions, are listed in square brackets next to the Event location.

This field is read-only.

Inclusion

Determines whether the element is included or excluded. When selected, the element is included. When unselected, the element is not included. By default, this applies across all platforms. Use the Link indicator (to the left of the check box) to determine or to set platform-specific customizations.

When this option is unselected, the property and behavior options in the Property Editor become unavailable.

Default value: false

Notes

Any additional information or comments that you want to add to the specific Event Action.

Event Properties

For a complete list and description of the Event property columns, see the Action Properties columns in the Event Actions List reference table.

 

[Action Properties]

A contextual pane that displays all the properties of the selected Event Actions. Different properties will be listed depending on the type of Actions you select in the Event Actions list. These can be edited in much the same way as they would be in the Multi Editor.

To view descriptions of the various Event Action properties, simply click on the appropriate Action link in the next page (Event Actions List).

Click the Configure Columns... shortcut (right-click) option from the column header band.

The Configure Columns Dialog opens. Specify which columns to display and their order.

Name

The name of the property or behavior. The properties or behaviors listed here are based on the Event Actions selected.

Value

The property value applicable to the selected Event Actions' property. This can include a numerical value, but can also be a check box where you enable or disable certain behaviors or properties.

For numerical fields, such as volume, you can specify whether you want to create a relative or absolute property change. By adding a + or - sign after the value, you create an offset for the selected object property. By placing it before the value, you are changing the object's property to that absolute value.

Where applicable, the Value column includes a Link indicator on its left to determine if it's applicable across platforms. For more details, see Linking/Unlinking Property Values.

Displays a complete list of options to add Actions to the Event.

This can be done by prompting the Project Explorer - Browser and navigating to then selecting an object to automatically apply a contextually appropriate Action. Or, you can directly select an Action from among the groupings in the list.

Removes the selected Event Action.

Opens the Project Explorer - Browser where you can select the object that you want to assign as the Target of the selected Event Action.

Opens the Project Explorer - Browser where you can select the target object that you wish to not be included in the currently selected "All" type Action. The exception will show up directly under the Action, along with any other exceptions. The Target property specifies the exception object. The list of exceptions can be collapsed or expanded. But, the number of exceptions will always be displayed in the Path and in the Target field.