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.

(Required *)

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`.

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", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}

Response :

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

Document version : 1

이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요

Wwise SDK 2017.1.9