LAYERINSTANCE

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

LAYERINSTANCE:get_layer

LAYERINSTANCE:get_layer()

Get the LAYER for this layer instance's layer.

Returns: a LAYER object representing this layer instance's layer

LAYERINSTANCE:get_x

LAYERINSTANCE:get_x()

Get the value of grd_x for this layer instance.

Returns: The grd_x value of this layer instance

LAYERINSTANCE:get_y

LAYERINSTANCE:get_y()

Get the value of grd_y for this layer instance.

Returns: The grd_y value of this layer instance

LAYERINSTANCE:get_width

LAYERINSTANCE:get_width()

Get the value of grd_width for the layer instance's layer.

Returns: The grd_width value of this layer instance's layer

LAYERINSTANCE:get_height

LAYERINSTANCE:get_height()

Get the value of grd_height for this layer instance's layer.

Returns: The grd_height value of this layer instance's layer

LAYERINSTANCE:get_position

LAYERINSTANCE:get_position()

Get the value of grd_x and grd_y for this layer instance.

Returns: The grd_x value of this layer instance The grd_y value of this layer instance

LAYERINSTANCE:get_size

LAYERINSTANCE:get_size()

Get the value of grd_width and grd_height for this layer instance's layer.

Returns: The grd_width value of this layer instance's layer The grd_height value of this layer instance's layer

LAYERINSTANCE:get_bounds

LAYERINSTANCE:get_bounds()

Get the value of grd_x, grd_y, grd_width and grd_height for this layer instance

Returns: The grd_x value of this layer instance The grd_y value of this layer instance The grd_width value of this layer instance's layer The grd_height value of this layer instance's layer

LAYERINSTANCE:get_alpha

LAYERINSTANCE:get_alpha()

Get the value of grd_alpha for this layer instance.

Returns: The grd_alpha value of this layer instance

LAYERINSTANCE:get_hidden

LAYERINSTANCE:get_hidden()

Get the value of grd_hidden for this layer instance.

Returns: The grd_hidden value of this layer instance

LAYERINSTANCE:set_x

LAYERINSTANCE:set_x(
    x
)

Set the value of grd_x for this layer instance to the provided value.

Parameters: x An integer value to set to grd_x of this layer instance

LAYERINSTANCE:set_y

LAYERINSTANCE:set_y(
    y
)

Set the value of grd_y for this layer instance to the provided value.

Parameters: y An integer value to set to grd_t of this layer instance

LAYERINSTANCE:set_width

LAYERINSTANCE:set_width(
    width
)

Set the value of grd_width for this layer instance to the provided value.

Parameters: width An integer value to set to grd_width of this layer instance

LAYERINSTANCE:set_height

LAYERINSTANCE:set_height(
    height
)

Set the value of grd_height for this layer instance to the provided value.

Parameters: height An integer value to set to grd_height of this layer instance

LAYERINSTANCE:set_position

LAYERINSTANCE:set_position(
    x,
    y
)

Set the value of grd_x and grd_y for this layer instance to the provided values.

Parameters: x An integer value to set to grd_x of this layer instance y An integer value to set to grd_y of this layer instance

LAYERINSTANCE:set_size

LAYERINSTANCE:set_size(
    width,
    height
)

Set the value of grd_width and grd_height for this layer instance's layer to the provided values.

Parameters: width An integer value to set to grd_x of this layer instance's layer height An integer value to set to grd_height of this layer instance's layer

LAYERINSTANCE:set_bounds

LAYERINSTANCE:set_bounds(
    x,
    y,
    width,
    height
)

Set the value of grd_x, grd_y, grd_width and grd_height for this layer instance to the provided value.

Parameters: x An integer value to set to grd_x of this layer instance y An integer value to set to grd_y of this layer instance width An integer value to set to grd_width of this layer instance's layer height An integer value to set to grd_height of this layer instance's layer

LAYERINSTANCE:set_alpha

LAYERINSTANCE:set_alpha(
    alpha
)

Set the value of grd_alpha for this layer instance to the provided value.

Parameters: alpha An integer value to set to grd_alpha of this layer instance

LAYERINSTANCE:set_hidden

LAYERINSTANCE:set_hidden(
    hidden
)

Set the value of grd_hidden for this layer instance to the provided value.

Parameters: hidden An integer value to set to grd_hidden of this layer instance

LAYERINSTANCE:hide

LAYERINSTANCE:hide()
Set the value of grd_hidden for this layer instance to 1.

LAYERINSTANCE:show

LAYERINSTANCE:show()
Set the value of grd_hidden for this layer instance to 0.
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.