Wwise SDK 2024.1.4
Schema

{
    "properties": {
        "project": {
            "type": "string",
            "description": "When no project is specified, no project is loaded. Refer to \\ref ak_wwise_console_project_open for information on how to open a project.\\n The path to the project file (.wproj).",
            "synopsis": [
                "--project PROJECT"
            ]
        },
        "require": {
            "oneOf": [
                {
                    "type": "string",
                    "description": "A single value provided for the option."
                },
                {
                    "type": "array",
                    "description": "Several values provided for the option.",
                    "items": {
                        "type": "string",
                        "description": "A value for the option."
                    }
                }
            ],
            "description": "Specify an array of Lua module to load at runtime using the require system. This option must be followed by a Lua module name. The module name must be found in the Lua path. Ex: '--require debug.lua'",
            "synopsis": [
                "--require MODULE1",
                "--require MODULE1 MODULE2 ...",
                "--require MODULE1 --require MODULE2 ..."
            ]
        },
        "do-file": {
            "oneOf": [
                {
                    "type": "string",
                    "description": "A single value provided for the option."
                },
                {
                    "type": "array",
                    "description": "Several values provided for the option.",
                    "items": {
                        "type": "string",
                        "description": "A value for the option."
                    }
                }
            ],
            "description": "Specify an array of Lua files to load before the main Lua script is loaded and executed. This option must be followed by a absolute file name.",
            "synopsis": [
                "--do-file LUAFILE1",
                "--do-file LUAFILE1 LUAFILE2 ...",
                "--do-file LUAFILE1 --do-file LUAFILE2 ..."
            ]
        },
        "lua-path": {
            "oneOf": [
                {
                    "type": "string",
                    "description": "A single value provided for the option."
                },
                {
                    "type": "array",
                    "description": "Several values provided for the option.",
                    "items": {
                        "type": "string",
                        "description": "A value for the option."
                    }
                }
            ],
            "description": "Specify a search path for Lua modules loaded. This option must be followed by a Lua path. Ex: '--lua-path C:\\\\module\\\\?.lua'",
            "synopsis": [
                "--lua-path PATH1",
                "--lua-path PATH1 PATH2 ...",
                "--lua-path PATH1 --lua-path PATH2 ..."
            ]
        },
        "allow-migration": {
            "type": "boolean",
            "description": "Allow migration and save of the Wwise project before executing the operation.",
            "synopsis": [
                "--allow-migration"
            ]
        },
        "watchdog-timeout": {
            "type": "integer",
            "minimum": 0,
            "description": "Time in seconds to set as a watchdog threshold. The watchdog is signaled every time a WAAPI function call is made. By default, the value is 0 and the watchdog is disabled.",
            "synopsis": [
                "--watchdog-timeout 30"
            ]
        }
    }
}
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.

Get started with Wwise
Wwise SDK

ak.wwise.cli.executeLuaScript Options Schema

Schema

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.
