LuaAPI/types/widget - Revision history

Shadowm: unfolded is actually in 1.18

2026-03-11T02:19:45Z

unfolded is actually in 1.18

Shadowm: Lots of things specific to 1.19.6+ were documented here without the necessary warnings

2026-03-11T00:18:05Z

Lots of things specific to 1.19.6+ were documented here without the necessary warnings

Bssarkar: /* Widget Callbacks */ Sort subsections

2026-02-16T15:19:47Z

‎Widget Callbacks: Sort subsections

Bssarkar: /* Widget Attributes */ Sort attributes alphabetically. (via some find&replace and Linux `sort` utility)

2026-02-16T15:16:18Z

‎Widget Attributes: Sort attributes alphabetically. (via some find&replace and Linux `sort` utility)

Show changes

Bssarkar: /* Widget Attributes */ Docs for more attrs in c2b2664eb21585a67afbb7bff931fb7b169eea47

2026-02-16T04:40:36Z

‎Widget Attributes: Docs for more attrs in c2b2664eb21585a67afbb7bff931fb7b169eea47

Bssarkar: /* maximum_value_label */

2026-02-16T03:58:56Z

‎maximum_value_label

Bssarkar: /* minimum_value_label */ label -> text

2026-02-16T03:58:47Z

‎minimum_value_label: label -> text

Bssarkar: /* label */ add characters_per_line (c2b2664eb21585a67afbb7bff931fb7b169eea47)

2026-02-16T03:58:23Z

‎label: add characters_per_line (c2b2664eb21585a67afbb7bff931fb7b169eea47)

Bssarkar: /* value */ Info for more attributes as of c2b2664eb21585a67afbb7bff931fb7b169eea47

2026-02-16T03:54:00Z

‎value: Info for more attributes as of c2b2664eb21585a67afbb7bff931fb7b169eea47

Bssarkar: /* unfolded */

2026-02-16T03:49:14Z

‎unfolded

@@ Line 219: / Line 219: @@
 === unfolded ===
 * ''widget''.'''unfolded''' &larr; ''boolean''
 * Available on: '''[tree_view_node]''', '''[tree_view]'''

@@ Line 11: / Line 11: @@
 end
 </syntaxhighlight>
 == Widget Attributes ==
 === best_slider_length ===
 * ''widget''.'''best_slider_length''' &harr; ''length''
 * Available on: '''[slider]'''
@@ Line 20: / Line 23: @@
 === characters_per_line ===
 * ''widget''.'''label''' &harr; ''int''
 * Available on: '''[label]'''
@@ Line 25: / Line 29: @@
 === editable ===
 * ''widget''.'''enabled''' &harr; ''boolean''
 * Available on: '''[text_box]'''
@@ Line 30: / Line 35: @@
 === ellipsize_mode ===
 * ''widget''.'''ellipsize_mode''' &harr; ''ellipsization mode string''
 * Available on: Most widgets
@@ Line 51: / Line 57: @@
 === help ===
 * ''widget''.'''enabled''' &harr; ''text''
 * Available on: Most widgets
@@ Line 56: / Line 63: @@
 === hint_image ===
 * ''widget''.'''hint_image''' &harr; ''text''
 * Available on: '''[text_box]''', '''[combobox]'''
@@ Line 61: / Line 69: @@
 === hint_text ===
 * ''widget''.'''hint_text''' &harr; ''text''
 * Available on: '''[text_box]''', '''[combobox]'''
@@ Line 66: / Line 75: @@
 === history ===
 * ''widget''.'''history''' &larr; ''text''
 * Available on: '''[text_box]'''
@@ Line 71: / Line 81: @@
 === indentation_step_size ===
 * ''widget''.'''indentation_step_size''' &harr; ''int''
 * Available on: '''[tree_view]'''
@@ Line 76: / Line 87: @@
 === item_count ===
 * ''widget''.'''item_count''' &rarr; ''number of items''
 * Available on: '''[multi_page]''', '''[listbox]''',  '''[combobox]''',  '''[stacked_widget]''', '''[tree_view]''',  '''[tree_view_node]''', '''[styled_widget]'''
@@ Line 86: / Line 98: @@
 === link_aware ===
 * ''widget''.'''link_aware''' &rarr; ''boolean''
 * Available on: '''[label]''', '''[rich_label]''', '''[scroll_label]''', '''[scroll_text]'''
@@ Line 91: / Line 104: @@
 === link_color ===
 * ''widget''.'''link_color''' &rarr; ''color string''
 * Available on: '''[label]''', '''[rich_label]'''
@@ Line 101: / Line 115: @@
 === maximum_value_label ===
 * ''widget''.'''maximum_value_label''' &harr; ''text''
 * Available on: '''[slider]'''
@@ Line 106: / Line 121: @@
 === max_input_length ===
 * ''widget''.'''max_input_length''' &harr; ''text''
 * Available on: '''[text_box]''', '''[combobox]'''
@@ Line 111: / Line 127: @@
 === minimum_value_label ===
 * ''widget''.'''minimum_value_label''' &harr; ''text''
 * Available on: '''[slider]'''
@@ Line 116: / Line 133: @@
 === overflow_to_tooltip ===
 * ''widget''.'''overflow_to_tooltip''' &harr; ''boolean''
 * Available on: Most widgets
@@ Line 166: / Line 184: @@
 === step_size ===
 * ''widget''.'''step_size''' &harr; ''int''
 * Available on: '''[slider]'''
@@ Line 175: / Line 194: @@
 === text_alignment ===
 * ''widget''.'''text_alignment''' &harr; ''text alignment string''
 * Available on: Most widgets
@@ Line 199: / Line 219: @@
 === unfolded ===
 * ''widget''.'''unfolded''' &larr; ''boolean''
 * Available on: '''[tree_view_node]''', '''[tree_view]'''
@@ Line 233: / Line 254: @@
 === wrap ===
 * ''widget''.'''wrap''' &rarr; ''boolean''
 * Available on: '''[label]'''

@@ Line 239: / Line 239: @@
 == Widget Callbacks ==
-=== on_modified ===
+=== on_button_click ===
-* ''widget''.'''on_modified''' &larr; '''function'''()
+* ''widget''.'''on_button_click''' &larr; '''function'''()
-* Available on: Most widgets, in particular '''[slider]''', '''[toggle_button]''', '''[listbox]''', '''[menu_button]''', '''[text_box]'''
+* Available on: '''[button]''', '''[repeating_button]'''
-Triggers when the user changes the value of the widget.
+Triggers when the user clicks on the button. This can differ from '''on_left_click''', depending on the type of widget. For example, on a '''[repeating_button]''' it will fire multiple times if the user holds the mouse button down.
 === on_double_click ===
@@ Line 261: / Line 254: @@
 Triggers when the user double clicks on the widget. Non-toggle panel widgets can be wrapped in a toggle panel to make use of this event handler.
-=== on_button_click ===
+=== on_left_click ===
-* ''widget''.'''on_button_click''' &larr; '''function'''()
+* ''widget''.'''on_left_click''' &larr; '''function'''()
-* Available on: '''[button]''', '''[repeating_button]'''
+* Available on: All widgets
-Triggers when the user clicks on the button. This can differ from '''on_left_click''', depending on the type of widget. For example, on a '''[repeating_button]''' it will fire multiple times if the user holds the mouse button down.
+Triggers when the user clicks on the widget.
 === on_link_click ===
@@ Line 275: / Line 268: @@
 Triggers when the user clicks on a '''<ref>''' link inside a '''[rich_label]'''. The first argument '''dest''' is the target of the link.
 == Widget Length ==

@@ Line 32: / Line 32: @@
 For a '''[stacked_widget]''', only the layer specified by '''selected_index''' will be displayed and receive events (callbacks will only be triggered on the selected layer).
 A '''selected_index''' of 0 represents all layers being selected, with events only being received by the layer with the highest index.  Note that term ''selected'' for the ''layer'' of a stacked_widget is not the same as the '''selected''' ''widget'' attribute.
 === text ===
@@ Line 39: / Line 46: @@
 The text of the textbox.
 === value ===
@@ Line 49: / Line 100: @@
 === best_slider_length ===
-* ''widget''.'''value''' &harr; ''position''
+* ''widget''.'''best_slider_length''' &harr; ''length''
 * Available on: '''[slider]'''
@@ Line 56: / Line 107: @@
 === minimum_value_label ===
-* ''widget''.'''value''' &harr; ''text''
+* ''widget''.'''minimum_value_label''' &harr; ''text''
 * Available on: '''[slider]'''
@@ Line 63: / Line 114: @@
 === maximum_value_label ===
-* ''widget''.'''value''' &harr; ''text''
+* ''widget''.'''maximum_value_label''' &harr; ''text''
 * Available on: '''[slider]'''
 The text the slider's label shows when it is at maximum value position.
 === percentage ===
@@ Line 144: / Line 200: @@
 === characters_per_line ===
-* ''widget''.'''label''' &larr; ''int''
+* ''widget''.'''label''' &harr; ''int''
 * Available on: '''[label]'''
@@ Line 158: / Line 214: @@
 === enabled ===
-* ''widget''.'''enabled''' &larr; ''boolean''
+* ''widget''.'''enabled''' &harr; ''boolean''
 * Available on: Most widgets
 === tooltip ===
-* ''widget''.'''tooltip''' &larr; ''text''
+* ''widget''.'''tooltip''' &harr; ''text''
 * Available on: Most widgets
 === visible ===
-* ''widget''.'''visible''' &larr; ''visibility string''
+* ''widget''.'''visible''' &harr; ''visibility string''
 * Available on: Most widgets
@@ Line 180: / Line 254: @@
 |-
 | invisible || false || The widget is not visible, doesn't handle events, and does not take up space on the dialog grid.
 |}

@@ Line 63: / Line 63: @@
 === maximum_value_label ===
-* ''widget''.'''value''' &harr; ''label''
+* ''widget''.'''value''' &harr; ''text''
 * Available on: '''[slider]'''

← Older revision		Revision as of 03:58, 16 February 2026
Line 142:		Line 142:

	The widget's label. Technically this is a special string used in the widget's wml definition. It usually does what one would expect, but also sets the image for '''image''' widgets. For '''[text_box]''', use '''text''' for initial values.		The widget's label. Technically this is a special string used in the widget's wml definition. It usually does what one would expect, but also sets the image for '''image''' widgets. For '''[text_box]''', use '''text''' for initial values.
		+
		+	=== characters_per_line ===
		+	* ''widget''.'''label''' ← ''int''
		+	* Available on: '''[label]'''
		+
		+	Maximum characters this label should show per line.

	=== marked_up_text ===		=== marked_up_text ===

← Older revision		Revision as of 03:54, 16 February 2026
Line 46:		Line 46:

	The current position of the slider.		The current position of the slider.
		+
		+	=== best_slider_length ===
		+
		+	* ''widget''.'''value''' ↔ ''position''
		+	* Available on: '''[slider]'''
		+
		+	Best length of the slider.
		+
		+	=== minimum_value_label ===
		+
		+	* ''widget''.'''value''' ↔ ''label''
		+	* Available on: '''[slider]'''
		+
		+	The text the slider's label shows when it is at minimum value position.
		+
		+	=== maximum_value_label ===
		+
		+	* ''widget''.'''value''' ↔ ''label''
		+	* Available on: '''[slider]'''
		+
		+	The text the slider's label shows when it is at maximum value position.

	=== percentage ===		=== percentage ===