Version

menu_open
Wwise SDK 2018.1.11
ak.soundengine.executeActionOnEvent


Execute an action on all nodes that are referenced in the specified event in an action of type play. See AK::SoundEngine::ExecuteActionOnEvent.

Supported by

Graphical User Interface.

Arguments

Name Type Description
event *   Either the ID (GUID), name or short ID of the event.
actionType * integer Action to execute on all the elements that were played using the specified event. Use values from AkActionOnEventType.
gameObject * integer Associated game object ID.
transitionDuration * integer Fade duration (ms).
fadeCurve * integer Use values from AkCurveInterpolation.

(Required *)

Arguments Details


event

description : Either the ID (GUID), name or short ID of the event.
Possibilities, one of the following :

1) type : string
pattern : ^[a-zA-Z_]+[a-zA-Z_0-9]*$

2) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

3) type : integer
minimum : 0
maximum : 4294967295

actionType

type : integer
minimum : 0
maximum : 4
description : Action to execute on all the elements that were played using the specified event. Use values from AkActionOnEventType.

gameObject

description : Associated game object ID.
type : integer
minimum : 0
maximum : 18446744073709551615

transitionDuration

description : Fade duration (ms).
type : integer
minimum : -2147483648
maximum : 2147483647

fadeCurve

type : integer
minimum : 0
maximum : 9
description : Use values from AkCurveInterpolation.


Examples :

Launching a stop Action on Event

Executes a Stop Action for the given Event, fading out with a 5 s log1 Curve.

Arguments:

{
"event": "{FF59687C-48CF-4385-B1C5-CE84B0A63880}",
"actionType": 0,
"gameObject": 1122334,
"transitionDuration": 5000,
"fadeCurve": 2
}

Result:

{}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"event": {
"description": "Either the ID (GUID), name or short ID of the event.",
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
]
},
"actionType": {
"type": "integer",
"minimum": 0,
"maximum": 4,
"description": "Action to execute on all the elements that were played using the specified event. Use values from <tt>AkActionOnEventType</tt>."
},
"gameObject": {
"description": "Associated game object ID.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"transitionDuration": {
"description": "Fade duration (ms).",
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"fadeCurve": {
"type": "integer",
"minimum": 0,
"maximum": 9,
"description": "Use values from <tt>AkCurveInterpolation</tt>."
}
},
"required": [
"event",
"actionType",
"gameObject",
"transitionDuration",
"fadeCurve"
],
"additionalProperties": false
}


Options :

{
"type": "object",
"properties": {},
"additionalProperties": false
}


Response :

{
"type": "object",
"properties": {},
"additionalProperties": false
}

Document version : 1


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