Brighterscript Game Engine

Checkbox

Extends: UiWidget

A focusable checkbox: a small toggle box plus a label. Set onChanged to a function(checkbox as Checkbox) to react to toggles.

Properties

  • checked (boolean)
  • drawableText (BGE.DrawableText)
  • lastChangedValue (dynamic)
  • onChanged (dynamic) — Called from onClick() after checked flips - function(checkbox as Checkbox) as void

Constructor

new Checkbox(game: BGE.Game): Checkbox

Parameters

Instance Methods

setLabel(text: string): void

Sets this checkbox's label text.

Parameters

  • text (string)

Returns

  • void

getValue(): boolean

Gets this checkbox's current value.

Returns

  • boolean

onClick(): void

Returns

  • void

draw(parent?: UiWidget): void

Parameters

  • parent (UiWidget, optional, default: "invalid")

Returns

  • void