版本

menu_open

ak.soundengine.setListeners


Set a single game object's active listeners. By default, all new game objects have no listeners active, but this behavior can be overridden with SetDefaultListeners(). Inactive listeners are not computed. See AK::SoundEngine::SetListeners.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name Type Description
emitter * integer Emitter game object.
listeners * array Array of listener game object IDs. Game objects must have been previously registered.


Arguments Details


emitter

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

listeners

type : array

argsSchema / listeners / ...

items

maxItems : 4294967295
type : integer
minimum : 0
maximum : 18446744073709551615
description : Array of listener game object IDs. Game objects must have been previously registered.


Examples :

Setting a list of listeners for a game object

Sets "listeners" as the list of active listeners for "gameObject".

Arguments:

{
    "emitter": 1122334, 
    "listeners": [
        2233445, 
        5566778, 
        123456, 
        11222648
    ]
}


Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {
        "emitter": {
            "description": "Emitter game object.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }, 
        "listeners": {
            "type": "array", 
            "items": {
                "maxItems": 4294967295, 
                "type": "integer", 
                "minimum": 0, 
                "maximum": 18446744073709551615
            }, 
            "description": "Array of listener game object IDs. Game objects must have been previously registered."
        }
    }, 
    "required": [
        "emitter", 
        "listeners"
    ], 
    "additionalProperties": false
}


Options :

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


Response :

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

Document version : 1


此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅