Documentation > GUI > CheckBox

Parent du composant : Panel
Version: 2.0.4

Constructor CheckBox.new(X, Y, Width, Height, Color, Thickness, Z)

This function creates a new CheckBox object.

X

Position on the X axis of the progress bar.

Y

Position on the Y axis of the progress bar.

Width

Width of the space occupied by the progress bar.

Height

Height of the space occupied by the progress bar.

Color

color of the checkbox.

Thickness

Thickness of the checkbox.

Z

Z-Order of the checkbox.

Return

Return an instance of CheckBox object.

CheckBox:draw()

This function draw the checkbox with its image if defined or with its colors.

CheckBox:setColor(Color)

This function defines the color of the checkbox if no image has been set.

Color

Color of the checkbox.

CheckBox:setImages(Unchecked, Checked)

This function sets the images for unchecked and checked status and adjusts the width and height of the component.

Unchecked

Image used when the checkbox is not checked.

Checked

Image used when the checkbox is checked.

CheckBox:SetState(State)

This function sets the current state of the checkbox.

State

State of the checkbox. True for check, false otherwise.

CheckBox:update(dt)

This funtion updates the status of the checkbox if the user click on it.

dt

Delta time.

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