Version

menu_open
Wwise SDK 2018.1.11
ak.wwise.core.transport.getList


Returns the list of transport objects.

Supported by

Graphical User Interface.

Result

Name Type Description
list array  

Result Details


list

type : array

resultSchema / list / ...

items

type : object

Name Type Description
object string The ID (GUID) of the object controlled by the transport object.
gameObject integer The game object used by the transport object.
transport integer Transport object ID.

Examples :

Retrieving the list of transport objects.

Retrieves the list of transport objects.

Arguments:

{}

Result:

{
"list": [
{
"object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"gameObject": 1234,
"transport": 5
},
{
"object": "{AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}",
"gameObject": 6789,
"transport": 12
}
]
}


Detailed JSON Schema


Arguments :

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


Options :

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


Response :

{
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"object": {
"description": "The ID (GUID) of the object controlled by the transport object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"gameObject": {
"description": "The game object used by the transport object.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"transport": {
"description": "Transport object ID.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
}
}
}
}
}

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.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise