Version
menu_open

Custom Properties Tab

[Note] The Custom Properties tab is part of a legacy method

The descriptions for this tab represent the legacy method for defining custom properties. The more recent and powerful method for defining custom properties uses XML files, and is described in the SDK doc's Defining Custom Properties page. While both approaches are still valid, it is not possible to combine them in defining custom properties.

In the Custom Properties tab of the Project Settings dialog box, you can define your own properties for the Sound and Audio Source objects of the Actor-Mixer Hierarchy. These custom properties can then be accessed from the following locations:

It is also possible for the game to query the value of these properties. Changing the Custom Property list will force a save and reload of the Wwise Project.

Interface Element

Description

Custom Properties

  

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.

ID

Identifier for the property. This identifier is used by the game to query the value of this property using the Sound Engine API. Cannot be edited.

Name

Name of the property.

Location

Location of the property. Can be one of:

  • Audio Source

  • Sound

Type

Type of the property. Can be one of:

  • Boolean

  • Integer

  • Real

Default

Default value of the property.

Min

Minimum value of the property.

Max

Maximum value of the property.

Add a new custom property.

Remove the selected custom property.
 

Closes the Project Settings dialog box and saves your settings.

Closes the Project Settings dialog box without saving your settings.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise