GROUP

GROUP is the class for Lua objects that represent Storyboard group model objects. GROUP extends DOMOBJECT so objects of this type can also invoke all the functions of DOMOBJECT. In Lua, this class is called gredom#group.

GROUP:get_x

GROUP:get_x()

Get the value of grd_x for this group.

Returns: The grd_x value of this group

GROUP:get_y

GROUP:get_y()

Get the value of grd_y for this group.

Returns: The grd_y value of this group

GROUP:get_hidden

GROUP:get_hidden()

Get the value of grd_hidden for this group.

Returns: The grd_hidden value of this group

GROUP:set_x

GROUP:set_x(
    x
)

Set the value of grd_x for this group.

Parameters: x The grd_x value of this group

GROUP:set_y

GROUP:set_y(
    y
)

Set the value of grd_y for this group.

Parameters: y The grd_y value of this group

GROUP:set_hidden

GROUP:set_hidden(
    hidden
)

Set the value of grd_hidden for this group.

Parameters: hidden The grd_hidden value of this group

GROUP:hide

GROUP:hide()

Set the value of grd_hidden for this group to 1.

GROUP:show

GROUP:show()

Set the value of grd_hidden for this group to 0.

GROUP:clone

GROUP:clone(
    name,
    parent,
    data
)

Create a new group (new_object_name), within an existing parent layer (parent_name) by copying all of the properties and children of this group. This new object will have all of the same actions, variables and it's current state will match the state of this control. All of the reference group's controls will be cloned into the new group.

The data argument is a table of properties that match the properties for that type of object as described in the gre.set_group_attrs function.

Parameters: new_object_name The name for the new object, this must be a unique name in the parents namespace parent_name The name of the layer to place this object within, this object must exist data Optional: A table containing group attribute tags as the keys with new values to be applied. Returns: A GROUP object representing the newly created group.

GROUP:delete

GROUP:delete()

Delete this group. This function only works on group that were created as clones of other controls.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.