Documentation > Core > Base

Version: 2.0.3

Constructor Base.new(X, Y)

This function creates a new Base element object.

X

Coordonate on the X-axis.

Y

Coordonate on the Y-axis.

Return

Return an instance of Base element object.

Base:getPosition()

This function returns the current position of the base element.

Return

Position on the X and Y axis of the base element.

Base:setPosition(X, Y)

This function set the position of the base element.

X

X value. If not a number, set to 0.

Y

Y value. If not a number, set to 0.

Base:adjustPosition(OffsetX, OffsetY)

This function adjusts the current position by the given offset values.

OffsetX

Offset value to add to the X position.

OffsetY

Offset value to add to the Y position.

Base:getVisible()

This function returns the visibility of the base element.

Return

.R

Base:setVisible(Visible)

This function set the visibility of the base element.

Visible

Boolean which indicate if the base element is visible (true) or not (false).

Base:draw()

This function indicates only if a Draw function has not been implemented for an element using this base element.

Base:update()

This function indicates only if an Update function has not been implemented for an element using this base element.

Base: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).