Version

menu_open
Wwise SDK 2024.1.1
ak.wwise.core.gameParameter.setRange

Sets the Min and Max properties on a Game Parameter. Modifies the RTPC curves and blend tracks that use this Game Parameter for their X axis.

Arguments

Name Type Description
object * any of: The ID (GUID), name, or path of the Game Parameter.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
min * number The minimum value of the Game Parameter.
max * number The maximum value of the Game Parameter.
onCurveUpdate * string Modifying the Min or Max value of a Game Parameter affects the RTPC curves and blend tracks that use that Game Parameter for their X axis. Two actions are possible: stretch: All items are kept but their X positions might change as the curve/blend track is stretched or compressed to match the new range in X. Values of Set Game Parameter actions are also scaled. preserve_x: Maintains the X position of all the items, but those that fall outside the new range are deleted. Values of Set Game Parameter actions are clamped. Possible values:
  • stretch
  • preserveX

(Required *)

Arguments Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


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