ak.soundengine.setScalingFactor

Set the scaling factor of a game object. Modify the attenuation computations on this game object to simulate sounds with a larger or smaller area of effect. See AK::SoundEngine::SetScalingFactor.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name	Type	Description
gameObject *	integer	The game object identifier.
attenuationScalingFactor *	number	The scaling factor, where 1 means 100%, 0.5 means 50%, 2 means 200%, and so on.

Arguments Details

gameObject

description : The game object identifier.
type : integer
minimum : 0
maximum : 18446744073709551615

attenuationScalingFactor

type : number
description : The scaling factor, where 1 means 100%, 0.5 means 50%, 2 means 200%, and so on.

Examples :

Setting the scaling factor of a game object

Sets the scaling factor of "gameObject" to "attenuationScalingFactor" (200%).

Arguments:

{
    "gameObject": 1122334, 
    "attenuationScalingFactor": 2
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "gameObject": {
            "description": "The game object identifier.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }, 
        "attenuationScalingFactor": {
            "type": "number", 
            "description": "The scaling factor, where 1 means 100%, 0.5 means 50%, 2 means 200%, and so on."
        }
    }, 
    "required": [
        "gameObject", 
        "attenuationScalingFactor"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "required": [], 
    "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.

Get started with Wwise

Wwise SDK 2017.1.9