GrandMA2 LUA Reference

• Index

Contents

• Functions

Modules

• gma.canbus
• gma.gui
• gma.gui.progress
• gma.
• gma.network
• gma.show.getobj
• gma.show
• gma.show.property
• gma.timestamp
• gma.user

Module gma.show.getobj

Functions to interface with (any?) stored items on the GMA.

Functions

gma.show.getobj.handle (name)	Get handle by object name.
gma.show.getobj.handle (handle)	Get handle exist by handle???
gma.show.getobj.class (handle)	Get the class of the object.
gma.show.getobj.index (handle)	Get index by handle???
gma.show.getobj.number (handle)	Get commandline number of object.
gma.show.getobj.name (handle)	Get name of object.
gma.show.getobj.label (handle)	Get label of object.
gma.show.getobj.amount (handle)	Get number of children by owned by a given handle.
gma.show.getobj.child (handle, index)	Get the handle of a child specified by Index.
gma.show.getobj.parent (handle)	Get handle of the parent object.
gma.show.getobj.verify (handle)	Verify handle???
gma.show.getobj.compare (handle1, handle2)	Compare two handles.

Functions

gma.show.getobj.handle (name)

Get handle by object name.

Parameters:

• name string Name of the object to return a handle of.

Returns:

number Unique handle ID referencing object.

Usage:

• gma.show.getobj.handle("Group 1");

• gma.show.getobj.handle("Sequence 1")

gma.show.getobj.handle (handle)

Get handle exist by handle???

Parameters:

• handle number gma.show.getobj.handle

Returns:

bool result???

gma.show.getobj.class (handle)

Get the class of the object.

Parameters:

• handle number Handle to get the class of.

Returns:

string Object's class name.

gma.show.getobj.index (handle)

Get index by handle???

Parameters:

• handle number gma.show.getobj.handle

Returns:

number index???

gma.show.getobj.number (handle)

Get commandline number of object.

Parameters:

• handle number Handle to get commandline number of.

Returns:

number Object's commandline number.

gma.show.getobj.name (handle)

Get name of object.

Parameters:

• handle number Handle to get name of.

Returns:

string Object name.

gma.show.getobj.label (handle)

Get label of object.

Returns nil if object has no label set

Parameters:

• handle number Handle to get label of.

Returns:

optional string Object label. Returns nil if no label is set.

gma.show.getobj.amount (handle)

Get number of children by owned by a given handle.

Parameters:

• handle number Handle to search for children.

Returns:

number Number of children owned by handle.

gma.show.getobj.child (handle, index)

Get the handle of a child specified by Index.

Returns the handle of the child with the given index, of the grandma object with the given handle (first child = 0).

Parameters:

• handle number Handle of the parent.
• index number Index of the child handle to return.

Returns:

number Handle of the child at Index

Usage:

local handle = gma.show.getobj.handle('Page 1');
local handle_of_2nd_exec = gma.show.getobj.child(handle,1);

gma.show.getobj.parent (handle)

Get handle of the parent object.

Returns the handle of the parent of the object with the given handle.

Parameters:

• handle number Handle of the child object.

Returns:

number Handle of the parent object.

Usage:

local handle = gma.show.getobj.handle('Cue 1')
local handle_of_seq = gma.show.getobj.parent(handle)

gma.show.getobj.verify (handle)

Verify handle???

Parameters:

• handle number gma.show.getobj.handle

Returns:

bool result???

gma.show.getobj.compare (handle1, handle2)

Compare two handles.

Returns true if the objects with handle1 and handle2 are equal.

Parameters:

• handle1 number Handle of object 1
• handle2 number Handle of object 2

Returns:

bool True if object1 = object2, False otherwise.

Usage:

local handle1 = gma.show.getobj.handle('Group 1')
local handle2 = gma.show.getobj.handle('Group 101')
if gma.show.getobj.compare(handle1, handle2) then ....