Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.executeLuaScript Arguments Schema

Schema

{
"type": "object",
"properties": {
"luaScript": {
"type": "string",
"description": "Defines the main Lua file to load and execute."
},
"luaPaths": {
"type": "array",
"description": "Defines an array of paths to be used to search additional Lua modules. Here is an example of a Lua path 'C:/path_to_folder/?.lua'.\\n Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
},
"requires": {
"type": "array",
"description": "Defines additional modules to be loaded at runtime using the require system. Note that the following folders are automatically added in the Lua path: PROJECT/Add-ons/Lua, APPDATA/Audiokinetic/Wwise/Add-ons/Lua, INSTALLDIR/Authoring/Data/Add-ons/Lua.\\n Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
},
"doFiles": {
"type": "array",
"description": "Defines additional Lua files to load before the main Lua script is loaded and executed. It is also possible to specify a directory in which all Lua files will be loaded.\\n Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
},
"required": [
"luaScript"
],
"additionalProperties": true
}

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