Version

menu_open

ak.soundengine.resetRTPCValue


Reset the value of a real-time parameter control to its default value, as specified in the Wwise project. See AK::SoundEngine::ResetRTPCValue.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name Type Description
rtpc *   Either the ID (GUID), name, or short ID of the real-time parameter control.
gameObject * integer Associated game object ID


Arguments Details


rtpc

description : Either the ID (GUID), name, or short ID of the real-time parameter control.
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

gameObject

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


Examples :

Resetting an RTPC value using its name.

Resets the value of "rtpc", using its name, to default for "gameObject".

Arguments:

{
    "rtpc": "Rain_Intensity", 
    "gameObject": 1122334
}

Resetting an RTPC value using its GUID.

Resets the value of "rtpc", using its GUID, to default for "gameObject".

Arguments:

{
    "rtpc": "{12345678-9012-3456-7896-156685135438}", 
    "gameObject": 1122334
}


Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {
        "rtpc": {
            "description": "Either the ID (GUID), name, or short ID of the real-time parameter control.", 
            "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
                }
            ]
        }, 
        "gameObject": {
            "description": "Associated game object ID", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }
    }, 
    "required": [
        "rtpc", 
        "gameObject"
    ], 
    "additionalProperties": false
}


Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

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

Document version : 1


Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise