Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SelectionBox

This widget offers the player a choice between different options. You usually will use this widget together with other widgets on a Canvas, it does not work well as a standalone widget directly in a UIElement because it changes size when clicked, so it needs enough space to unfold.

Hierarchy

Index

Properties

onSelectionChanged

onSelectionChanged: MulticastDelegate<(selectionBox: this, player: Player, index: number, option: string) => void>

Called when the selection is changed.

param

The selection box that was changed

param

The player who changed the selection. undefined if selection is changed by setSelectedOption or setSelectedIndex.

param

The selected index

param

The selected option

Methods

addOption

getFontFileName

  • getFontFileName(): string

getFontPackageId

  • getFontPackageId(): string
  • Return the id of the package that contains the TrueType font file name used for the text. Empty if no custom font is used or no package is specified (and the package containing the script is used).

    Returns string

getFontSize

  • getFontSize(): number

getOptions

  • getOptions(): string[]

getOwningObject

getParent

  • getParent(): Widget | undefined
  • Return the widget that contains this widget, for example a border that wraps a check box. Returns undefined if this object has no parent.

    Returns Widget | undefined

getSelectedIndex

  • getSelectedIndex(): number
  • Get the index of the currently selected option. -1 if nothing is selected because this selection box has no options.

    Returns number

getSelectedOption

  • getSelectedOption(): string
  • Return the currently selected option

    Returns string

getTextColor

isBold

  • isBold(): boolean

isEnabled

  • isEnabled(): boolean

isItalic

  • isItalic(): boolean

isVisible

  • isVisible(): boolean

removeOption

  • Remove an existing option. Has no effect if the option does not exist.

    Parameters

    • option: string

    Returns SelectionBox

setBold

  • setBold(bold: boolean): this

setEnabled

  • setEnabled(enabled: boolean): this
  • Set whether the widget is enabled. When a widget is disabled, users can't interact with it and it is greyed out. When a widget that contains other widgets (like VerticalBox) is disabled, all its children behave as if disabled, too. By default, widgets are enabled.

    Parameters

    • enabled: boolean

      Whether to enable the widget.

    Returns this

setFont

  • setFont(fontFilename: string, packageId?: string): this
  • Set the TrueType font file used for the text. If a custom font is used, the bold and italic settings don't have an effect. Place your font files in the "Fonts" folder of your package.

    Parameters

    • fontFilename: string

      The filename of the TTF file to load. Set to empty string to use the standard font (and enable bold and italic settings).

    • Optional packageId: string

      The id of the package that contains the TTF file (in the Fonts folder). Can usually be empty when used from scripts to use the same package that contains the script file, but you need to explicitly pass refPackageId for the current package or a package id when you use it in a callback. You can find package ids in the manifest.json file in package folders. Usually you won't use this parameter, unless you have a specific reason to load a font from a different package than where the script is located.

    Returns this

setFontSize

  • setFontSize(size: number): this

setItalic

  • setItalic(italic: boolean): this

setOptions

setSelectedIndex

  • Set the index of the currently selected option. Will have no effect if there is no option at that index.

    Parameters

    • index: number

    Returns SelectionBox

setSelectedOption

  • Set the currently selected option. Will not have an effect if no such option exists.

    Parameters

    • text: string

    Returns SelectionBox

setTextColor

  • setTextColor(color: Color | [r: number, g: number, b: number, a: number]): this

setVisible

  • setVisible(visible: boolean): Widget
  • Set whether the widget is visible. When a widget that contains other widgets (like VerticalBox) is invisible, all its children are invisible, too. The layout of widgets is updated when visibility changes, and invisible widgets are treated as if they don't exist.

    Parameters

    • visible: boolean

      Whether the widget is visible.

    Returns Widget