grandMA3 User Manual Publication

CmdIndirectWait(string[, handle[, handle]])

grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » CmdIndirectWait(string[, handle[, handle]])
Version 2.1

Description

The CmdIndirectWait Lua function executes a command within the grandMA3 command line. It does not block the Lua execution and is executed synchronously in the main task. Synchronous commands wait for the command to be executed before executing any following command.

Arguments

  • String:
    A string with the command to be executed in the command line. Do not add a please or enter to execute the command.
  • Handle (optional):
    A handle to an undo (oops) list. Learn more in the CreateUndo topic.
  • Handle (optional):
    This is a handle for the target for the command. The target can be a specific screen. See the example below.

Return

This function does not return anything.

Example

This example prints "1" and "2" in the Command Line History and lets the main task open the Configure Display pop-up on screen 2.

Lua
return function()
--Print something
Printf("1")
--Use the 'CmdIndirectWait' to open a pop-up
CmdIndirectWait("Menu DisplayConfig", nil, GetDisplayByIndex(2))
--Print something else
Printf("2")
end

The Command Line History shows:

OK : Call Plugin 50
1

OK : Menu "DisplayConfig"
2