grandMA3 User Manual Publication
Get(handle, string[, integer])
grandMA3 User Manual » Plugins » Lua Functions - Object API » Get(handle, string[, integer])
|
Version 2.0
|
Description
The Get function returns a string with information about a specified property of the object, for instance, the object's name, class, or path.
Arguments
- Handle:
The function takes a handle of the type "light_userdata" as an argument.
It can be omitted when using the colon notation on an object.The Colon Notation is a way to omit the handle as the first argument when using the Object functions.
This is the general syntax with the colon notation: object:function()
This is the general syntax with standard handle notation: object.function(object)
Learn more in the Lua Functions - Object API topic.
- String:
The string must be the name of a valid property for the object. - Integer (optional):
A valid role integer can be supplied. This will make the returned value a text string.
Return
- String:
The function returns the value of the property. If the property is a boolean, then the return is "0" or "1" unless a role is defined (see optional integer argument above). When the role is supplied, a boolean is returned as "No" or "Yes".
Examples
This example prints information about the "Tracking" property of the selected sequence.
Lua |
return function () |