Skip to content

tes3uiCycleButton⚓︎

A structure containing properties specific to cycle buttons.

This type inherits the following: tes3uiWidget

Properties⚓︎

element⚓︎

Access back to the element this widget interface is for.

Returns:

index⚓︎

The current index of the widget. If this is set, the text will be updated accordingly.

Returns:

  • result (number)

options⚓︎

The options available to the cycle button. Setting this value will reset the active index to 1.

Returns:

text⚓︎

The current text of the button. This will change every time the index changes.

Returns:

  • result (string)

value⚓︎

The value associated with the current index. Setting this property will search for an option that has the given value, and change the active index to that option's. If the value does not exist in the available options, it will throw an error.

Returns:

  • result (any)

Methods⚓︎

addOption⚓︎

Adds a new option to the cycle button.

myObject:addOption(option)

Parameters:

getIndexForValue⚓︎

Gets the index used by a particular value.

local index = myObject:getIndexForValue(value)

Parameters:

  • value (any): The value to search for.

Returns:

  • index (number): The found index matching the value.

getTextElement⚓︎

Gets the text element to use.

local element = myObject:getTextElement()

Returns:

  • element (tes3uiElement): The tes3uiElement containing the button's text.

next⚓︎

Cycles the button to the next option.

myObject:next()

previous⚓︎

Cycles the button to the previous option.

myObject:previous()