grandMA3 User Manual Publication
GetDisplayCollect()

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

Description

The GetDisplayCollect Lua function returns a handle to the DisplayCollect object.

Arguments

This function does not accept any arguments.

Return

  • Handle:
    The returned handle to the DisplayCollect.

Example

This example prints the data connected to the handle. It uses 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()
-- This example dumps all information about the DisplayCollect object.
Printf("=============== START OF DUMP ===============")
GetDisplayCollect():Dump()
Printf("================ END OF DUMP ================")
end