grandMA3 LUA Functions

Index updated for 2.0.0.4

Please note

The below information is not official and has been tested on a trial-and-error basis; thus may be missing or incorrect information. Please take care when using any of the below functions. The below index of functions has been updated but linked documents may not have been updated at this point.

Official Documentation

As of 1.5.2 MA Lighting has started providing information regarding Lua and API functions. You can find further information in the Help pages. Additionally, you can now export a list of functions in your current version of the software using the HelpLua command. the below list is derived from the HelpLua command on software version 1.5.2.1.

How can I help?

If you have found and tested some function that has not been added to this list you can create an Issue with the details.

---

New in v2.0 but not listed in HelpLua.

• GridsGetExpandedHeaderCellState()
• ReleaseProfiling()

OBJECT-FREE API

• AddFixtures
• AddIPAddress (v2.0)
• AddonVars
• BuildDetails
• ⚠ CheckDMXCollision
• CheckFIDCollision
• ClassExists (v2.0)
• ⚠ CloseAllOverlays
• CloseUndo
• Cmd
• CmdIndirect
• CmdIndirectWait
• CmdObj
• ColMeasureDeviceDarkCalibrate
• ColMeasureDeviceDoMeasurement
• ConfigTable (v2.0)
• Confirm
• CreateDirectoryRecursive (v2.0)
• CreateNeuralTraining (v2.0)
• CreateMultiPatch (v2.0)
• CreateUndo
• CurrentEnvironment (v2.0)
• CurrentExecPage
• CurrentProfile
• CurrentScreenConfig (v2.0)
• CurrentUser
• DataPool
• DefaultDisplayPositions
• DelVar
• DeleteIPAddress (v2.0)
• DeskLocked
• DeviceConfiguration (v2.0)
• DevMode3d (v2.0)
• DirList
• DrawPointer (v2.0)
• DumpAllHooks (v2.0)
• Echo
• Enums: table (v2.0)
• ErrEcho
• ErrPrintf
• Export
• ⚠ ExportCSV
• ⚠ ExportJson
• FileExists
• FindBestDMXPatchAddr
• FindBestFocus
• FindNextFocus
• FindTexture
• FirstDmxModeFixture (v2.0)
• FixtureType
• FromAddr
• GetApiDescriptor (v2.0)
• GetAttributeByUIChannel
• GetAttributeCount
• GetAttributeIndex
• GetButton
• GetChannelFunction
• GetChannelFunctionIndex
• GetClassDerivationLevel (v2.0)
• GetCurrentCue (v2.0)
• GetDebugFPS (v2.0)
• GetDisplayByIndex
• GetDisplayCollect
• GetDMXUniverse
• GetDMXValue
• GetExecutor
• GetFailedFrameCounter (v2.0)
• GetFocus
• GetFocusDisplay
• GetObjApiDescriptor (v2.0)
• ⚠ GetPath
• GetPathOverrideFor
• GetPathSeparator
• GetPathType
• GetPresetData
• GetProgPhaser
• GetProgPhaserValue
• GetPropertyColumnId
• GetRemoteVideoInfo (v2.0)
• GetRTChannel
• GetRTChannelCount
• GetRTChannels
• GetSample
• GetScreenContent (v2.0)
• GetSelectedAttribute
• GetShowFileStatus
• GetSubfixture
• GetSubfixtureCount
• GetTokenName
• GetTokenNameByIndex
• GetTopModal
• GetTopOverlay
• GetUIChannel
• GetUIChannelCount
• GetUIChannelIndex
• GetUIChannels
• GetUIObjectAtPosition
• GetVar
• GlobalVars
• HandleToInt
• HandleToStr
• HookObjectChange
• HostOS
• HostSubType
• HostType
• Import
• IncProgress
• IntToHandle
• IsClassDerivedFrom (v2.0)
• IsObjectValid
• Keyboard
• KeyboardObj
• LoadExecConfig
• MasterPool
• MessageBox
• Mouse
• MouseObj
• Obj: table
• NeedShowSave (v2.0)
• NextDmxModeFixture (v2.0)
• ObjectList
• OverallDeviceCertificate
• Patch
• PluginVars
• PopupInput
• PrepareWaitObjectChange (v2.0)
• Printf
• Programmer
• ProgrammerPart
• Pult
• RefreshLibrary
• ReleaseType
• RemoteCommand (v2.0)
• Root
• RTSectionDeltaTime
• SaveExecConfig
• SelectedFeature (v2.0)
• SelectedLayout (v2.0)
• SelectedSequence
• SelectedTimecode (v2.0)
• SelectedTimer (v2.0)
• Selection
• SelectionComponentX
• SelectionComponentY
• SelectionComponentZ
• SelectionCount
• SelectionFirst
• SelectionNext
• SelectionNotifyBegin
• SelectionNotifyEnd
• SelectionNotifyObject
• SerialNumber
• SetBlockInput
• SetColor
• SetLED
• SetProgPhaser
• SetProgPhaserValue
• SetProgress
• SetProgressRange
• SetProgressText
• SetRTTimeAllowance
• SetVar
• ShowData
• ShowSettings
• StartProgress
• StopProgress
• StrToHandle
• SyncFS
• TestPlaybackOutput (v2.0)
• TestPlaybackOutputSteps (v2.0)
• TextInput
• Time
• ⚠ Timer
• ToAddr
• Touch
• TouchObj
• Unhook
• UnhookMultiple
• UserVars
• Version
• WaitModal
• WaitObjectDelete

OBJECT_API

• AddListChildren
• AddListChildrenNames
• AddListLuaItem
• AddListLuaItems
• AddListNumericItem
• AddListNumericItems
• AddListObjectItem
• AddListPropertyItem
• AddListPropertyItems
• AddListRecursiveNames
• AddListStringItem
• AddListStringItems
• Addr
• AddrNative
• Append
• Aquire
• Changed
• Children
• ClearList
• ClearUIChildren
• CmdlineChildren (v2.0)
• CmdlinePtr
• CommandAt
• CommandCall
• CommandCreateDefaults
• CommandDelete
• CommandStore
• Compare
• Copy
• Count
• Create
• CurrentChild
• Delete
• Dump (v2.0)
• Export
• Find
• FindListItemByName
• FindListItemByValueStr
• FindParent
• FindRecursive
• FindWild
• Get
• GetAssignedObj
• GetChildClass
• GetClass
• GetDependencies (v2.0)
• GetDisplay
• GetDisplayIndex
• GetExportFileName
• GetFader
• GetFaderText
• GetLineAt (v2.0)
• GetLineCount (v2.0)
• GetListItemAppearance
• GetListItemButton
• GetListItemName
• GetListItemsCount
• GetListItemValueI64
• GetListItemValueStr
• GetListSelectedItemIndex
• GetOverlay
• GetReferences (v2.0)
• GetScreen
• GetUIChild
• GetUIChildrenCount
• GetUIEditor
• GetUISettings
• GridCellExists
• GridGetBase
• GridGetCellData
• GridGetCellDimensions
• GridGetData
• GridGetDimensions
• GridGetParentRowId
• GridGetScrollCell
• GridGetScrollOffset
• GridGetSelectedCells
• GridGetSelection
• GridGetSettings
• GridIsCellReadOnly
• GridIsCellVisible
• GridMoveSelection (v2.0)
• GridScrollCellIntoView
• GridSetColumnSize
• GridsGetColumnById (v2.0)
• GridsGetExpandHeaderCell
• GridsGetExpandHeaderCellState (v2.0)
• GridsGetLevelButtonWidth
• GridsGetRowById (v2.0)
• HasActivePlayback
• HasDependencies (v2.0)
• HasEditSettingUI
• HasEditUI
• HasParent
• HasReferences (v2.0)
• HookDelete
• Import
• Index
• InputCallFunction
• InputHasFunction
• InputRun
• InputSetAdditionalParameter
• InputSetEditTitle
• InputSetMaxLength (v2.0)
• InputSetTitle
• InputSetValue (v2.0)
• Insert
• IsClass
• IsEmpty
• IsEnabled (v2.0)
• IsListItemEmpty
• IsLocked (v2.0)
• IsListItemEnabled
• IsValid
• IsVisible (v2.0)
• Load
• MaxCount
• OverlaySetCloseCallback
• Parent
• PrepareAccess (v2.0)
• PropertyCount
• PropertyInfo (v2.0)
• PropertyName
• PropertyType
• Ptr
• Remove
• RemoveListItem
• Resize
• Save
• ScrollDo
• ScrollGetInfo
• ScrollGetItemByOffset
• ScrollGetItemOffset
• ScrollGetItemSize
• ScrollIsNeeded
• SelectListItemByIndex
• SelectListItemByName
• SelectListItemByValue
• Set
• SetChildren
• SetEmptyListItem
• SetChildrenRecursive (v2.0)
• SetContextSensHelpLink (v2.0)
• SetEmptyListItem (v2.0)
• SetEnabledListItem (v2.0)
• SetEnabledListItem
• SetFader
• SetListItemAppearance
• SetListItemName
• SetListItemValueStr
• SetPositionHint
• ShowModal
• ToAddr
• UIChildren
• UILGGetColumnAbsXLeft
• UILGGetColumnAbsXRight
• UILGGetColumnWidth
• UILGGetRowAbsYBottom
• UILGGetRowAbsYTop
• UILGGetRowHeight
• WaitChildren
• WaitInit

References

• ActivationGroup
• Attribute
• AttributeDefinations
• Feature
• FeatureGroup
• Patch Data Object
• Root Data Object
• ShowData Data Object
• SubFixture Data Object
• Textures
• Text Input Plugins
• UserProfile
• UserDataObject
• UI Types

LUA specific

• _G
• _VERSION
• __CallbacksRegistry
• assert
• collectgarbage
• coroutine
• debug
• dofile
• error
• getmetatable
• idx removed in v1.4.0.2
• io
• ipairs
• last removed in v1.4.0.2
• load
• loadfile
• math
• next
• os
• package
• pairs
• pcall
• print
• rawequal
• rawget
• rawlen
• rawset
• require
• select
• setmetatable
• string
• table
• tonumber
• tostring
• type
• utf8
• xpcall