バージョン
menu_open

ak.wwise.core.object.setAttenuationCurve


Sets the specified attenuation curve for a given attenuation object.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
object *   The ID (GUID) or path of attenuation object.
platform string The ID (GUID) or path of the platform to set curves. Set to null-guid for unlinked curve.
curveType * string Type of attenuation curve.
Possible values : "VolumeDryUsage", "VolumeWetGameUsage", "VolumeWetUserUsage", "LowPassFilterUsage", "HighPassFilterUsage", "SpreadUsage", "FocusUsage"
use * string Defines if the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve.
Possible values : "None", "Custom", "UseVolumeDry"
points * array  


Arguments Details


object

description : The ID (GUID) or path of attenuation object.
Possibilities, one of the following :

1) 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}$

2) type : string
pattern : ^\

platform

description : The ID (GUID) or path of the platform to set curves. Set to null-guid for unlinked curve.
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}$

curveType

type : string
Possible values : "VolumeDryUsage", "VolumeWetGameUsage", "VolumeWetUserUsage", "LowPassFilterUsage", "HighPassFilterUsage", "SpreadUsage", "FocusUsage"
description : Type of attenuation curve.

use

type : string
Possible values : "None", "Custom", "UseVolumeDry"
description : Defines if the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve.

points

type : array

argsSchema / points / ...

items

type : object

Name Type Description
x * number X coordinate of curve point.
y * number Y coordinate of curve point.
shape * string Shape of curve segment between this point and the next.
Possible values : "Constant", "Linear", "Log3", "Log2", "Log1", "InvertedSCurve", "SCurve", "Exp1", "Exp2", "Exp3"


Examples :

Defining an attenuation curve of an object

Defines the "object"'s attenuation curve for "curveType" by setting a serie of "points".

Arguments:

{
    "object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "platform": "{66666666-7777-8888-9999-AAAAAAAAAAAA}", 
    "curveType": "VolumeDryUsage", 
    "use": "Custom", 
    "points": [
        {
            "x": 0, 
            "y": 0, 
            "shape": "Exp1"
        }, 
        {
            "x": 8, 
            "y": -1, 
            "shape": "SCurve"
        }, 
        {
            "x": 25, 
            "y": -2, 
            "shape": "Constant"
        }
    ]
}

Result:

{}

Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of attenuation object.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "platform": {
            "description": "The ID (GUID) or path of the platform to set curves.  Set to null-guid for unlinked curve.", 
            "type": "string", 
            "pattern": *Must be a valid GUID*
        }, 
        "curveType": {
            "type": "string", 
            "enum": [
                "VolumeDryUsage", 
                "VolumeWetGameUsage", 
                "VolumeWetUserUsage", 
                "LowPassFilterUsage", 
                "HighPassFilterUsage", 
                "SpreadUsage", 
                "FocusUsage"
            ], 
            "description": "Type of attenuation curve."
        }, 
        "use": {
            "type": "string", 
            "enum": [
                "None", 
                "Custom", 
                "UseVolumeDry"
            ], 
            "description": "Defines if the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve."
        }, 
        "points": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "x": {
                        "type": "number", 
                        "description": "X coordinate of curve point."
                    }, 
                    "y": {
                        "type": "number", 
                        "description": "Y coordinate of curve point."
                    }, 
                    "shape": {
                        "type": "string", 
                        "description": "Shape of curve segment between this point and the next.", 
                        "enum": [
                            "Constant", 
                            "Linear", 
                            "Log3", 
                            "Log2", 
                            "Log1", 
                            "InvertedSCurve", 
                            "SCurve", 
                            "Exp1", 
                            "Exp2", 
                            "Exp3"
                        ]
                    }
                }, 
                "required": [
                    "x", 
                    "y", 
                    "shape"
                ], 
                "additionalProperties": false
            }
        }
    }, 
    "required": [
        "object", 
        "curveType", 
        "use", 
        "points"
    ], 
    "additionalProperties": false
}


Options :

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


Response :

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

Document version : 1

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう