grandMA3 User Manual » Plugins » Lua Functions - Object API

Version 2.1

Object API means Lua functions that are functions/methods of an object.

 

All of the object functions take a handle as an argument. This can often be omitted if the function is used with the colon notation. This is the most common use with object functions.

Syntax with the handle:

object.function(object-handle)

Syntax with colon operator:

object:function()

 

Most examples in the object subtopics use the colon operator notation.

Sub topics

• Addr(handle[, handle[, boolean]])
• AddrNative(handle[, handle[, boolean]])
• Children(handle)
• Count(handle)
• Dump (handle)
• Export(handle, string, string)
• Get(handle, string[, integer])
• GetChildClass(handle)
• GetClass(handle)
• HasActivePlayback(handle)
• Import(handle, string, string)
• Ptr(handle, integer)
• ToAddr(handle)