grandMA3 User Manual Publication
MouseObj()
grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » MouseObj()
Version 2.0

Description

The MouseObj function returns the handle to the first found mouse object.

Arguments

This function does not accept any arguments.

Return

  • Handle:
    The function returns the handle to the mouse object.

Example

This example prints the information of the mouse object. Is 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()
-- Print all informatin about the MouseObj object
Printf("=============== START OF DUMP ===============")
MouseObj():Dump()
Printf("================ END OF DUMP ================")
end