Documentation > GUI > Group

Parent du composant : Base
Version: 2.0.4

Group.new(X, Y)

This function creates a Group object.

X

Position on the X axis of the text.

Y

Position on the Y axis of the text.

Return

Return an instance of a Group object.

Group:add(Component)

This function add a given component to the group.

Component

Composant à ajouter au groupe.

OffsetX

OffsetY

Group:nbComponents()

This function returns the number of components already presents into the group.

Return

Returns the number of components presents into the group.

Group:remove(Component)

This function removes a given component to the group. It's definitive, no rollback possible.

Component

Component to remove from the group.

Group:callbackZOrder()

This functions is used to ensure that all components will be drawn in the right order.

Group:draw()

This function launches the Draw function of all its components.

Group:updateDimensions()

This function updates the width and height of the group from the position and dimensions of each of its components.

Group:getDimensions()

This function returns the width and height of the group.

Return

Width and height of the group.

Group:getDimensions()

This function returns the width and height of the group.

Return

Width and height of the group.

Group:setPosition(X, Y)

This function changes the position of the group and of each of its components.

X

Position on the X-axis of the group.

Y

Position on the Y-axis of the group.

Group:centerOnScreen()

Cette fonction permet de centrer le groupe à l'écran.

Group:setVisible(Visible)

This function sets the visibility of the group and of each of its compnents.

Visible

Visible (true) or not (false).

Group:update(dt)

This funtion launches all updates needed for each of the components of the group.

dt

Delta time.

Group:toString(NoTitle)

This function display all variables containing in the current Base instance (tables and functions are excluded).

NoTitle

Indicates if the title must be displayed (false) or not (true).