grandMA3 User Manual Publication
GetClass(handle)

grandMA3 User Manual » Plugins » Lua Functions - Object API » GetClass(handle)
Version 2.1

Description

The GetClass function returns a string with information about the class for the object.

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.

Return

  • String:
    The function returns the text string with the name of the object's class.

Examples

This example prints the class name of the selected sequence.

Lua
return function()
-- Gets the class name of the selected sequence.
Printf("The class name is " .. SelectedSequence():GetClass())
end