Set multiple positions for a single game object. Setting multiple positions for a single game object is a way to simulate multiple emission sources while using the resources of only one voice. This can be used to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area. See AK::SoundEngine::SetMultiplePositions.
(Required *)
Graphical User Interface.
| Name | Type | Description |
|---|---|---|
| gameObject * | integer | Game Object identifier. |
| positions * | array | Array of positions to apply. |
| multiPositionType * | integer | Use values from AK::SoundEngine::MultiPositionType. |
description : Game Object identifier.
type : integer
minimum : 0
maximum : 18446744073709551615
type : array
argsSchema / positions / ...
maxItems : 65535
type : object
| Name | Type | Description |
|---|---|---|
| position * | object | A 3D position to set for the game object. |
argsSchema / positions / items / ...
type : object
description : A 3D position to set for the game object.
| Name | Type | Description |
|---|---|---|
| orientationFront * | object | Orientation of the listener. |
| orientationTop * | object | Top orientation of the listener. |
| position * | object | Position of the listener |
argsSchema / positions / items / position / ...
type : object
description : Orientation of the listener.
| Name | Type | Description |
|---|---|---|
| x * | number | X Position. |
| y * | number | Y Position. |
| z * | number | Z Position. |
argsSchema / positions / items / position / ...
type : object
description : Top orientation of the listener.
| Name | Type | Description |
|---|---|---|
| x * | number | X Position. |
| y * | number | Y Position. |
| z * | number | Z Position. |
argsSchema / positions / items / position / ...
type : object
description : Position of the listener
| Name | Type | Description |
|---|---|---|
| x * | number | X Position. |
| y * | number | Y Position. |
| z * | number | Z Position. |
description : Array of positions to apply.
type : integer
minimum : 0
maximum : 2
description : Use values from AK::SoundEngine::MultiPositionType.
Sets "gameObject" to multiple positions, as defined in "positions", to simulate multiple sources for one playing sound.
{
"gameObject": 1122334,
"positions": [
{
"position": {
"orientationFront": {
"x": 5,
"y": 20,
"z": 10
},
"orientationTop": {
"x": 70,
"y": 150,
"z": 6
},
"position": {
"x": 70,
"y": 150,
"z": 10
}
}
},
{
"position": {
"orientationFront": {
"x": -50,
"y": 80,
"z": 15
},
"orientationTop": {
"x": 2,
"y": 40,
"z": 6
},
"position": {
"x": 2,
"y": -20,
"z": 400
}
}
}
],
"multiPositionType": 1
}
{}
{
"type": "object",
"properties": {
"gameObject": {
"description": "Game Object identifier.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"positions": {
"type": "array",
"items": {
"maxItems": 65535,
"type": "object",
"properties": {
"position": {
"type": "object",
"description": "A 3D position to set for the game object.",
"properties": {
"orientationFront": {
"type": "object",
"description": "Orientation of the listener.",
"properties": {
"x": {
"type": "number",
"description": "X Position."
},
"y": {
"type": "number",
"description": "Y Position."
},
"z": {
"type": "number",
"description": "Z Position."
}
},
"required": [
"x",
"y",
"z"
],
"additionalProperties": false
},
"orientationTop": {
"type": "object",
"description": "Top orientation of the listener.",
"properties": {
"x": {
"type": "number",
"description": "X Position."
},
"y": {
"type": "number",
"description": "Y Position."
},
"z": {
"type": "number",
"description": "Z Position."
}
},
"required": [
"x",
"y",
"z"
],
"additionalProperties": false
},
"position": {
"type": "object",
"description": "Position of the listener",
"properties": {
"x": {
"type": "number",
"description": "X Position."
},
"y": {
"type": "number",
"description": "Y Position."
},
"z": {
"type": "number",
"description": "Z Position."
}
},
"required": [
"x",
"y",
"z"
],
"additionalProperties": false
}
},
"required": [
"orientationFront",
"orientationTop",
"position"
],
"additionalProperties": false
}
},
"required": [
"position"
],
"additionalProperties": false
},
"description": "Array of positions to apply."
},
"multiPositionType": {
"type": "integer",
"minimum": 0,
"maximum": 2,
"description": "Use values from <tt>AK::SoundEngine::MultiPositionType</tt>."
}
},
"required": [
"gameObject",
"positions",
"multiPositionType"
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Document version : 1