checkbox

Checkbox

A simple checkbox giving input for boolean values.
The checkmark will be drawn by using a primitive unless a sprite is set.

Property variables

• checkcolor[c_black]: The color the checkmark will have.
• checkoncolor[c_dkgray]: The color the checkmark will have when the mouse is over the checkbox.
• checkincolor[c_black]: The color the checkmark will have when the mouse clicks the checkbox.
• margin[2]: The distance in pixels between the edge of the object and the checkmark.
• value[false]: Whether the checkbox should or shouldn't display a checkmark. This variable can also be read.
• sprite[-1]: The sprite index of the checkmark that should be drawn. If this is equal to -1 then a checkmark will be drawn from a primitive. If this is -2 only the background will be drawn.
• spriteimg[0]: The image index of the sprite.
• spritecolor[c_white]: The color blend of the sprite by default.
• spriteoncolor[c_white]: The color blend of the sprite when the mouse hovers over it.
• spriteincolor[c_white]: The color blend of the sprite when the mouse is pressing it.

This object has a background, and all its associated variables about which you can learn more here

Readable variables

• update: Whether the checkbox has just been clicked.
• updated: Whether the checkbox has just been clicked.
• value: Whether the checkmark is visible inside the box.

Functions

• uiz_checkbox_setcheckmarkcolor(id, checkmark color, checkmark on color, checkmark in color): Set the color of the checkmark
  • id: the instance id of the instance you want to modify
  • checkmark color, checkmark on color, checkmark in color: see property variables color, checkoncolor and checkincolor
• uiz_checkbox_setcheckmarkmargin(id, margin):
  • id: the instance id of the instance you want to modify
  • margin: see margin property variable
• uiz_checkbox_setspritecolor(id, sprite color, sprite on color, sprite in color):
  • id: the instance id of the instance you want to modify
  • sprite color, sprite on color, sprite in color: see property variables spritecolor, spriteoncolor and spriteincolor
• uiz_checkbox_setvalue(id, value):
  • id: the instance id of the instance you want to modify
  • value: see value property variable
• uiz_checkbox_togglevalue(id): Flips the value property of the object. If value was false it will be set to true and if it was false it will be set to true. If your checkmark was checked it will be unchecked and if it was unchecked it will now be checked.
  • id: the instance id of the instance you want to modify
• value = uiz_checkbox_getvalue(id): Returns if the checkbox is checked
  • id: the instance id of the instance you want to modify
  • value: see value readable variable
• updated = uiz_checkbox_hasupdated(id):
  • id: the instance id of the instance you want to modify
  • updated: see updated readable variable

Visuals