목차

Wwise SDK 2018.1.11
ak.soundengine.setObjectObstructionAndOcclusion


Set a game object's obstruction and occlusion levels. This function is used to affect how an object should be heard by a specific listener. See AK::SoundEngine::SetObjectObstructionAndOcclusion.

Supported by

Graphical User Interface.

Arguments

Name Type Description
emitter * integer Emitter game object ID.
listener * integer Listener game object ID
obstructionLevel * number ObstructionLevel: [0.0f..1.0f].
occlusionLevel * number OcclusionLevel: [0.0f..1.0f].

(Required *)

Arguments Details


emitter

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

listener

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

obstructionLevel

type : number
description : ObstructionLevel: [0.0f..1.0f].

occlusionLevel

type : number
description : OcclusionLevel: [0.0f..1.0f].


Examples :

Setting the obstruction and occlusion level of a game object.

Sets the "emitter"'s "obstructionLevel" and "occlusionLevel" for the "listener".

Arguments:

{
"emitter": 1122334,
"listener": 4455667,
"obstructionLevel": 0.3,
"occlusionLevel": 0.3
}

Result:

{}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"emitter": {
"description": "Emitter game object ID.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"listener": {
"description": "Listener game object ID",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"obstructionLevel": {
"type": "number",
"description": "ObstructionLevel: [0.0f..1.0f]."
},
"occlusionLevel": {
"type": "number",
"description": "OcclusionLevel: [0.0f..1.0f]."
}
},
"required": [
"emitter",
"listener",
"obstructionLevel",
"occlusionLevel"
],
"additionalProperties": false
}


Options :

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


Response :

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

Document version : 1