grandMA3 User Manual Publication
Count(handle)

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

Description

The Count function returns an integer number indicating the number of child objects.

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

  • Integer:
    The function returns an integer indicating the number of children of the object.

Examples

This example prints the selected sequence's number of children (cues).

Lua
return function()
local numberChildren = SelectedSequence():Count()
Printf("The selected Sequence has " .. numberChildren .. " cues.")
end