grandMA3 User Manual Publication
ShowSettings()
grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » ShowSettings()
Version 2.1

Description

ShowSettings is an object-free function that returns a handle to the object at Root/ShowData/ShowSettings.

Arguments

This function does not accept any arguments.

Return

  • Handle:
    The function returns a handle to the ShowSettings object.

Example

This simple example prints the information of the ShowSettings object using the Dump() function:

Dump()

The Dump() function returns a string with information about the object, for instance, the name, class, path of the object, its properties, and children.

Learn more in the Dump() topic.

Lua
return function ()
-- The following prints the dump for the object for the show settings
Printf("=============== START OF DUMP ===============")
ShowSettings():Dump()
Printf("================ END OF DUMP ================")
end