Version

menu_open
Wwise SDK 2024.1.1
ak.wwise.core.object.isPropertyEnabled

Returns true if a property is enabled based on the values of the properties it depends on.

Arguments

Name Type Description
object * any of: The ID (GUID), name, or path of the object to check.
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.
platform * any of: The ID (GUID) or unique name of the platform to link the reference. Set to null-guid for unlinked reference.
string The name of the object.
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
property * string The name of the property. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference .
A property name. Refer to Wwise Objects Reference for information about the Wwise objects and their properties.

(Required *)

Arguments Schema

Result

Name Type Description
return boolean Indicates if the property is enabled.

Result 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