UserVars()

grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » UserVars()

Version 2.0

Description

The UserVars function returns a handle to the set of user variables. Read more about these in the Variables topic in the Macro section.

Arguments

This function does not accept any arguments.

Return

Handle:
The function returns a handle of the set of user variables.

Example

This example sets, gets, and deletes a user variable:

Copy Code

Lua

return function()
    -- Stores a local Lua variable with the handle for the user variables.
    local variableSection = UserVars()

    -- Sets a user variable with an integer value using the SetVar function.
    SetVar(variableSection, "myUserVar", 42)

    -- Prints the user variable using the GetVar function.
    Printf("The value  of myUserVar is: " .. GetVar(variableSection, "myUserVar"))

    -- Deletes the user variable using the DelVar function.
    DelVar(variableSection, "myUserVar")
end