Version
menu_open
Wwise SDK 2024.1.0
ak.wwise.core.executeLuaScript

Execute a Lua script. Optionally, specify additional Lua search paths, additional modules, and additional Lua scripts to load prior to the main script. The script can return a value. All arguments will be passed to the Lua script in the "wa_args" global variable.

Arguments

Name Type Description
luaScript * string Defines the main Lua file to load and execute.
luaPaths array 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'.
Several values provided for the option.
luaPaths [...] string A value for the option.
requires array 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.
Several values provided for the option.
requires [...] string A value for the option.
doFiles array 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.
Several values provided for the option.
doFiles [...] string A value for the option.

(Required *)

Arguments Schema

Result

Name Type Description
return * boolean, object, array, number, string Result returned by the Lua script. Use a return statement at the end of the script.

(Required *)

Result Schema

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.

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