Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

RTPC tab


[Note]Note

The RTPC tab for busses is exactly the same as the RTPC tab for Actor-Mixer and Interactive Music objects except that the Inclusion box does not apply. The Effect Plug-in Editor has an identical RTPC tab to the one for Actor-Mixer and Interactive Music objects.

The RTPC (Real-time Parameter Controls) tab allows you to map Wwise property values to in-game parameters. The relationship between the two is represented by an RTPC curve in a graph view, where the X axis represents the in-game parameter and the Y axis represents the Wwise property. You can add control points along each curve to define a detailed relationship between the two values. You can choose to display one curve at a time or all together for purposes of comparison. You can also copy curves from one property to another or from one object to another.

The graph view has a Game Parameter cursor that you can scroll back and forth to test the property value mappings during playback. You can also modify the points in real time during playback. The graph view will also display a game object's parameter values during playback. That is, for each displayed curve, the corresponding parameter's values will be displayed per game object.

Below the graph, the RTPC tab is divided into two panels. The left panel is where you create the RTPCs, reassign their Wwise property values, or change their associated in-game parameter. The right panel (the RTPC side panel), like a miniature variety of the Multi Editor, allows you to edit properties across multiple selected parameters, including modulator ShareSets.

[Note]Note

You must create at least one Game Parameter in the Game Syncs tab of the Project Explorer before the options on the RTPC tab will be enabled.

[Note]Note

To bypass Game Parameter interpolation during playback, hold Ctrl while using the Game Parameter cursor.

General

Interface Element

Description

[name]

The name of the object.

(Object Color)

Displays the object's color. Clicking the icon opens the color selector.

Select a color to apply it to the object. When you choose a color for an object, a palette icon appears on the selected square, as well as a yellow triangle in the lower-right corner, as shown.

To inherit the parent object's color, select the square at the far left of the color selector.

(Mute and Solo)

Controls the Mute and Solo states for the object and shows the implicit mute and solo states for the object.

Muting an object silences this object for the current monitoring session. Soloing an object silences all the other objects in the project except this one.

A bold M or S indicates that the Mute or Solo state has been explicitly set for the object. A non-bold M or S with faded color indicates that the object's Mute or Solo state was implicitly set from another object's state.

Muting an object implicitly mutes the descendant objects.

Soloing an object implicitly mutes the sibling objects and implicitly solos the descendant and ancestor objects.

[Tip]Tip

Hold the Ctrl key while clicking a solo button to exclusively solo the object for which the solo button is associated.

[Note]Note

Mute and Solo are designed to be used for monitoring purposes only and are not persisted in the project or stored in the SoundBanks.

(Show references)

Indicates the number of elements in your project that contain direct references to the object. The icon is displayed in orange when references to the object exist, and in gray when no references exist.

Selecting the button opens the Reference View with the object's name in the References to: field.

RTPC

Interface Element

Description

(Graph View)

A graphical representation of the relationship between an in-game parameter (X axis) and a property value in Wwise (Y axis).

The graph view can display several curves simultaneously.

Zooms in towards the center of the graph view.

Resets the graph view to the default zoom factor ratio of 1:1.

Zooms out from the center of the graph view.

Coordinates

X

The coordinate along the X axis of the selected control point.

If more than one control point is selected, the field displays a value of 0, so that you can increase or decrease the value of all selected control points relative to their current values. For example, if you select two control points and type -5 in the X text box, both control points will move to the left by 5 units.

Y

The coordinate along the Y axis of the selected control point.

If more than one control point is selected, the field displays a value of 0, so that you can increase or decrease the value of all selected control points relative to their current values. For example, if you select two control points and type -5 in the Y text box, both control points will move down by 5 units.

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note]Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

Right-click the table header to open the Configure Columns dialog where you can specify which columns to display and their order. See Using tables.

(Selector)

Opens the Selector menu where you can select the Wwise property that you want to map to an in-game parameter.

Low-pass and high-pass filter parameters for user defined auxiliary sends and game-defined auxiliary sends that do not appear in the general settings can be selected for RTPC control.

(Pinned/Unpinned)

Determines whether the RTPC curve is displayed in the graph view.

When the Pin icon is selected, the RTPC curve will be displayed in the graph view whether the curve is selected or not.

(Color block)

Displays the color of the RTPC curve in the graph view. Each new curve is assigned a different color.

The relative properties (volume, pitch, Low-Pass Filter, etc) are always assigned the same color.

Y axis

The Wwise property assigned to the Y axis.

To change the Wwise property assigned to the Y axis, click the Wwise Property Display button and select a new property.

X axis

The Game Parameter, MIDI controller, or modulator assigned to the X axis.

Expand the list to select a different X axis assignment.

Notes

Any additional information about the RTPC.

RTPC Side Panel

[name field]

An editable text field which displays the name of the selected RTPC object (X Axis).

The References button displays the number of references in the project to the currently selected RTPC object.

Click the button to prompt the Reference View loaded with all the project objects/elements that directly reference the selected RTPC object.

[Note]Note

The button will be grayed out and display "0" when selecting multiple RTPC objects.

The display maximum is 999.In the uncommon circumstance of 1,000 or more references, the number will not increase but all the objects/elements will show up in the Reference view.

The Name and Value columns of the RTPC side panel display all the properties and corresponding values (which are directly editable) of the currently selected RTPC objects (X Axis). Where multiple selected RTPCs have the same property but with different values, a dash will appear.

[Caution]Caution

Even if a dash appears in a property value, you can still edit it. Your changes will, however, apply to all the applicable selected RTPCs.

Double-click any RTPC object to open its editor view. With the exception of the Simulation Value property, described below, refer to the objects' respective editor help pages (Property Editor: Game Parameter or Modulator Editor) for property information.

Simulation Value

Sets the current value of the selected Game Parameter, thereby positioning the graph’s Game Parameter cursor, solely for simulation within the authoring tool. Its field and slider range is set in the Game Parameter’s Property Editor; however, this property only appears in RTPC sections, such as the RTPC side panel , and the Multi Editor .

Default value: 50


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