Factorio » Classes » LuaGuiElementFactorio 1.1.39

LuaGuiElement

An element of a custom GUI. This type is used to represent any kind of a GUI element - labels, buttons and frames are all instances of this type. Just like LuaEntity, different kinds of elements support different attributes; attempting to access an attribute on an element that doesn't support it (for instance, trying to access the column_count of a textfield) will result in a runtime error.

The following types of GUI element are supported:

Each GUI element allows access to its children by having them as attributes. Thus, one can use the parent.child syntax to refer to children. Lua also supports the parent["child"] syntax to refer to the same element. This can be used in cases where the child has a name that isn't a valid Lua identifier.

Example
This will add a label called greeting to the top flow. Immediately after, it will change its text to illustrate accessing child elements.
game.player.gui.top.add{type="label", name="greeting", caption="Hi"}
game.player.gui.top.greeting.caption = "Hello there!"
game.player.gui.top["greeting"].caption = "Actually, never mind, I don't like your face"
Example
This will add a tabbed-pane and 2 tabs with contents.
local tabbed_pane = game.player.gui.top.add{type="tabbed-pane"}
local tab1 = tabbed_pane.add{type="tab", caption="Tab 1"}
local tab2 = tabbed_pane.add{type="tab", caption="Tab 2"}
local label1 = tabbed_pane.add{type="label", caption="Label 1"}
local label2 = tabbed_pane.add{type="label", caption="Label 2"}
tabbed_pane.add_tab(tab1, label1)
tabbed_pane.add_tab(tab2, label2)
class LuaGuiElement - sort
add{type = …, name = …, caption = …, tooltip = …, enabled = …, visible = …, ignored_by_interaction = …, style = …, tags = …, index = …, anchor = …} → LuaGuiElement Add a new child element to this GuiElement.
clear() Remove children of this element.
destroy() Remove this element, along with its children.
get_mod() → string The mod that owns this Gui element or nil if it's owned by the scenario script.
get_index_in_parent() → uint Gets the index that this element has in its parent element.
clear_items() Removes the items in this dropdown or listbox.
get_item(index) → LocalisedString Gets the item at the given index from this dropdown or listbox.
set_item(index, string) Sets the given string at the given index in this dropdown or listbox.
add_item(string, index) Inserts a string at the end or at the given index of this dropdown or listbox.
remove_item(index) Removes the item at the given index from this dropdown or listbox.
get_slider_minimum() → double Gets this sliders minimum value.
get_slider_maximum() → double Gets this sliders maximum value.
set_slider_minimum_maximum(minimum, maximum) Sets this sliders minimum and maximum values.
get_slider_value_step() → double Gets the minimum distance this slider can move.
get_slider_discrete_slider() → boolean Returns whether this slider only allows being moved to discrete positions.
get_slider_discrete_values() → boolean Returns whether this slider only allows discrete values.
set_slider_value_step(value) Sets the minimum distance this slider can move.
set_slider_discrete_slider(value) Sets whether this slider only allows being moved to discrete positions.
set_slider_discrete_values(value) Sets whether this slider only allows discrete values.
focus() Focuses this GUI element if possible.
scroll_to_top() Scrolls this scroll bar to the top.
scroll_to_bottom() Scrolls this scroll bar to the bottom.
scroll_to_left() Scrolls this scroll bar to the left.
scroll_to_right() Scrolls this scroll bar to the right.
scroll_to_element(element, scroll_mode) Scrolls this scroll bar such that the specified GUI element is visible to the player.
select_all() Selects all the text in this textbox.
select(start, end) Selects a range of text in this textbox.
add_tab(tab, content) Adds the given tab and content widgets to this tabbed pane as a new tab.
remove_tab(tab) Removes the given tab and its associated content from this tabbed pane.
force_auto_center() Forces this frame to re-auto-center.
scroll_to_item(index, scroll_mode) Scrolls the scroll bar such that the specified listbox item is visible to the player.
bring_to_front() Moves this GUI element to the "front" so it will draw over other elements.
index :: uint [R] The index of this GUI element (unique amongst the GUI elements of a LuaPlayer).
gui :: LuaGui [R] The GUI this element is a child of.
parent :: LuaGuiElement [R] The direct parent of this element; nil if this is a top-level element.
name :: string [RW] The name of this element.
caption :: LocalisedString [RW] The text displayed on this element.
value :: double [RW] How much this progress bar is filled.
direction :: string [R] Direction of this element's layout.
style :: LuaStyle or string [RW] The style of this element.
visible :: boolean [RW] Sets whether this GUI element is visible or completely hidden, taking no space in the layout.
text :: string [RW] The text contained in this textfield or text-box.
children_names :: array[string] [R] Names of all the children of this element.
state :: boolean [RW] Is this checkbox or radiobutton checked?
player_index :: uint [R] Index into LuaGameScript::players specifying the player who owns this element.
sprite :: SpritePath [RW] The image to display on this sprite-button or sprite in the default state.
resize_to_sprite :: boolean [RW] Whether the image widget should resize according to the sprite in it.
hovered_sprite :: SpritePath [RW] The image to display on this sprite-button when it is hovered.
clicked_sprite :: SpritePath [RW] The image to display on this sprite-button when it is clicked.
tooltip :: LocalisedString [RW]
horizontal_scroll_policy :: string [RW] Policy of the horizontal scroll bar.
vertical_scroll_policy :: string [RW] Policy of the vertical scroll bar.
type :: string [R] The type of this GUI element.
children :: array[LuaGuiElement] [R] The child-elements of this GUI element.
items :: array[LocalisedString] [RW] The items in this dropdown or listbox.
selected_index :: uint [RW] The selected index for this dropdown or listbox.
number :: double [RW] The number to be shown in the bottom right corner of this sprite-button.
show_percent_for_small_numbers :: boolean [RW] Related to the number to be shown in the bottom right corner of this sprite-button.
location :: GuiLocation [RW] The location of this widget when stored in LuaGui::screen or nil if not not set or not in LuaGui::screen.
auto_center :: boolean [RW] Whether this frame auto-centers on window resize when stored in LuaGui::screen.
badge_text :: LocalisedString [RW] The text to display after the normal tab text (designed to work with numbers)
position :: Position [RW] The position this camera or minimap is focused on, if any.
surface_index :: uint [RW] The surface index this camera or minimap is using.
zoom :: double [RW] The zoom this camera or minimap is using.
minimap_player_index :: uint [RW] The player index this minimap is using.
force :: string [RW] The force this minimap is using or nil if no force is set.
elem_type :: string [R] The elem type of this choose-elem-button.
elem_value :: string or SignalID [RW] The elem value of this choose-elem-button or nil if there is no value.
elem_filters :: array[PrototypeFilter] [RW] The elem filters of this choose-elem-button or nil if there are no filters.
selectable :: boolean [RW] Whether the contents of this text-box are selectable.
word_wrap :: boolean [RW] Whether this text-box will word-wrap automatically.
read_only :: boolean [RW] Whether this text-box is read-only.
enabled :: boolean [RW] Whether this GUI element is enabled.
ignored_by_interaction :: boolean [RW] Whether this GUI element is ignored by interaction.
locked :: boolean [RW] Whether this choose-elem-button can be changed by the player.
draw_vertical_lines :: boolean [RW] Whether this table should draw vertical grid lines.
draw_horizontal_lines :: boolean [RW] Whether this table should draw horizontal grid lines.
draw_horizontal_line_after_headers :: boolean [RW] Whether this table should draw a horizontal grid line below the first table row.
column_count :: uint [R] The number of columns in this table.
vertical_centering :: boolean [RW] Whether the content of this table should be vertically centered.
slider_value :: double [RW] The value of this slider element.
mouse_button_filter :: MouseButtonFlags [RW] The mouse button filters for this button or sprite-button.
numeric :: boolean [RW] Whether this textfield is limited to only numberic characters.
allow_decimal :: boolean [RW] Whether this textfield (when in numeric mode) allows decimal numbers.
allow_negative :: boolean [RW] Whether this textfield (when in numeric mode) allows negative numbers.
is_password :: boolean [RW] Whether this textfield displays as a password field, which renders all characters as *.
lose_focus_on_confirm :: boolean [RW] Whether this textfield loses focus after defines.events.on_gui_confirmed is fired.
clear_and_focus_on_right_click :: boolean [RW] Makes it so right-clicking on this textfield clears and focuses it.
drag_target :: LuaGuiElement [RW] The frame drag target for this flow, frame, label, table, or empty-widget.
selected_tab_index :: uint [RW] The selected tab index for this tabbed pane or nil if no tab is selected.
tabs :: array[TabAndContent] [R] The tabs and contents being shown in this tabbed-pane.
entity :: LuaEntity [RW] The entity associated with this entity-preview, camera, minimap or nil if no entity is associated.
anchor :: GuiAnchor [RW] Sets the anchor for this relative widget.
tags :: Tags [RW] The tags associated with this LuaGuiElement.
switch_state :: string [RW] The switch state (left, none, right) for this switch.
allow_none_state :: boolean [RW] Whether the "none" state is allowed for this switch.
left_label_caption :: LocalisedString [RW] The text shown for the left switch label.
left_label_tooltip :: LocalisedString [RW] The tooltip shown on the left switch label.
right_label_caption :: LocalisedString [RW] The text shown for the right switch label.
right_label_tooltip :: LocalisedString [RW] The tooltip shown on the right switch label.
operator [] :: LuaGuiElement [R] The indexing operator.
valid :: boolean [R] Is this object valid?
object_name :: string [R] The class name of this object.
help() → string All methods and properties that this object supports.
add{type = …, name = …, caption = …, tooltip = …, enabled = …, visible = …, ignored_by_interaction = …, style = …, tags = …, index = …, anchor = …} → LuaGuiElement

Add a new child element to this GuiElement.

Parameters
Table with the following fields:
  • type :: string: The kind of element to add. Has to be one of the GUI element types listed at the top of this page.
  • name :: string (optional): Name of the child element.
  • caption :: LocalisedString (optional): Text displayed on the child element. For frames, this is their title. For other elements, like buttons or labels, this is the content. Whilst this attribute may be used on all elements, it doesn't make sense for tables and flows as they won't display it.
  • tooltip :: LocalisedString (optional): Tooltip of the child element.
  • enabled :: boolean (optional): Whether the child element is enabled. Defaults to true.
  • visible :: boolean (optional): Whether the child element is visible. Defaults to true.
  • ignored_by_interaction :: boolean (optional): Whether the child element is ignored by interaction. Defaults to false.
  • style :: string (optional): Style of the child element.
  • tags :: Tags (optional): Tags associated with the child element.
  • index :: uint (optional): Location in its parent that the child element should slot into. By default, the child will be appended onto the end.
  • anchor :: GuiAnchor (optional): Where to position the child element when in the relative element.
  • Other attributes may be specified depending on type:
    • button
      • mouse_button_filter :: MouseButtonFlags (optional): Which mouse buttons the button responds to. Defaults to "left-and-right".
    • flow
    • frame
    • table
      • column_count :: uint: Number of columns. This can't be changed after the table is created.
      • draw_vertical_lines :: boolean (optional): Whether the table should draw vertical grid lines. Defaults to false.
      • draw_horizontal_lines :: boolean (optional): Whether the table should draw horizontal grid lines. Defaults to false.
      • draw_horizontal_line_after_headers :: boolean (optional): Whether the table should draw a single horizontal grid line after the headers. Defaults to false.
      • vertical_centering :: boolean (optional): Whether the content of the table should be vertically centered. Defaults to true.
    • textfield
      • text :: string (optional): The initial text contained in the textfield.
      • numeric :: boolean (optional): Defaults to false.
      • allow_decimal :: boolean (optional): Defaults to false.
      • allow_negative :: boolean (optional): Defaults to false.
      • is_password :: boolean (optional): Defaults to false.
      • lose_focus_on_confirm :: boolean (optional): Defaults to false.
      • clear_and_focus_on_right_click :: boolean (optional): Defaults to false.
    • progressbar
      • value :: double (optional): The initial value of the progressbar, in the range [0, 1]. Defaults to 0.
    • checkbox
      • state :: boolean: The initial checked-state of the checkbox.
    • radiobutton
      • state :: boolean: The initial checked-state of the radiobutton.
    • sprite-button
      • sprite :: SpritePath (optional): Path to the image to display on the button.
      • hovered_sprite :: SpritePath (optional): Path to the image to display on the button when it is hovered.
      • clicked_sprite :: SpritePath (optional): Path to the image to display on the button when it is clicked.
      • number :: double (optional): The number shown on the button.
      • show_percent_for_small_numbers :: boolean (optional): Formats small numbers as percentages. Defaults to false.
      • mouse_button_filter :: MouseButtonFlags (optional): The mouse buttons that the button responds to. Defaults to "left-and-right".
    • sprite
      • sprite :: SpritePath (optional): Path to the image to display.
      • resize_to_sprite :: boolean (optional): Whether the widget should resize according to the sprite in it. Defaults to true.
    • scroll-pane
      • horizontal_scroll_policy :: string (optional): Policy of the horizontal scroll bar. Possible values are "auto", "never", "always", "auto-and-reserve-space", "dont-show-but-allow-scrolling". Defaults to "auto".
      • vertical_scroll_policy :: string (optional): Policy of the vertical scroll bar. Possible values are "auto", "never", "always", "auto-and-reserve-space", "dont-show-but-allow-scrolling". Defaults to "auto".
    • drop-down
      • items :: array[LocalisedString] (optional): The initial items in the dropdown.
      • selected_index :: uint (optional): The index of the initially selected item. Defaults to 0.
    • line
      • direction :: string (optional): The initial direction of the line. Defaults to "horizontal".
    • list-box
      • items :: array[LocalisedString] (optional): The initial items in the listbox.
      • selected_index :: uint (optional): The index of the initially selected item. Defaults to 0.
    • camera
      • position :: Position: The position the camera centers on.
      • surface_index :: uint (optional): The surface that the camera will render. Defaults to the player's current surface.
      • zoom :: double (optional): The initial camera zoom. Defaults to 0.75.
    • choose-elem-button
      • elem_type :: string: The type of the button - one of the following values.
      • item :: string (optional): If type is "item" - the default value for the button.
      • tile :: string (optional): If type is "tile" - the default value for the button.
      • entity :: string (optional): If type is "entity" - the default value for the button.
      • signal :: SignalID (optional): If type is "signal" - the default value for the button.
      • fluid :: string (optional): If type is "fluid" - the default value for the button.
      • recipe :: string (optional): If type is "recipe" - the default value for the button.
      • decorative :: string (optional): If type is "decorative" - the default value for the button.
      • item-group :: string (optional): If type is "item-group" - the default value for the button.
      • achievement :: string (optional): If type is "achievement" - the default value for the button.
      • equipment :: string (optional): If type is "equipment" - the default value for the button.
      • technology :: string (optional): If type is "technology" - the default value for the button.
      • elem_filters :: array[PrototypeFilter] (optional): Filters describing what to show in the selection window. See LuaGuiElement::elem_filters.
    • text-box
      • text :: string (optional): The initial text contained in the text-box.
      • clear_and_focus_on_right_click :: boolean (optional): Defaults to false.
    • slider
      • minimum_value :: double (optional): The minimum value for the slider. Defaults to 0.
      • maximum_value :: double (optional): The maximum value for the slider. Defaults to 30.
      • value :: double (optional): The initial value for the slider. Defaults to minimum_value.
      • value_step :: double (optional): The minimum value the slider can move. Defaults to 1.
      • discrete_slider :: boolean (optional): Defaults to false.
      • discrete_values :: boolean (optional): Defaults to true.
    • minimap
      • position :: Position (optional): The position the minimap centers on. Defaults to the player's current position.
      • surface_index :: uint (optional): The surface the camera will render. Defaults to the player's current surface.
      • chart_player_index :: uint (optional): The player index the map should use. Defaults to the current player.
      • force :: string (optional): The force this minimap should use. Defaults to the player's current force.
      • zoom :: double (optional): The initial camera zoom. Defaults to 0.75.
    • tab
      • badge_text :: LocalisedString (optional): The text to display after the normal tab text (designed to work with numbers).
    • switch
      • switch_state :: string (optional): Possible values are "left", "right", or "none". If set to "none", allow_none_state must be true. Defaults to "left".
      • allow_none_state :: boolean (optional): Whether the switch can be set to a middle state. Defaults to false.
      • left_label_caption :: LocalisedString (optional)
      • left_label_tooltip :: LocalisedString (optional)
      • right_label_caption :: LocalisedString (optional)
      • right_label_tooltip :: LocalisedString (optional)
Return value
The added GUI element.
clear()

Remove children of this element. Any LuaGuiElement objects referring to the destroyed elements become invalid after this operation.

Example
game.player.gui.top.clear()
destroy()

Remove this element, along with its children. Any LuaGuiElement objects referring to the destroyed elements become invalid after this operation.

Note: The top-level GUI elements - LuaGui::top, LuaGui::left, LuaGui::center and LuaGui::screen - can't be destroyed.
Example
game.player.gui.top.greeting.destroy()
get_mod() → string

The mod that owns this Gui element or nil if it's owned by the scenario script.

Note: This has a not-super-expensive, but non-free cost to get.
get_index_in_parent() → uint

Gets the index that this element has in its parent element.

Note: This iterates through the children of the parent of this element, meaning this has a non-free cost to get, but is faster than doing the equivalent in Lua.
clear_items()

Removes the items in this dropdown or listbox.

get_item(index) → LocalisedString

Gets the item at the given index from this dropdown or listbox.

Parameters
index :: uint: The index to get
set_item(index, string)

Sets the given string at the given index in this dropdown or listbox.

Parameters
index :: uint: The index whose text to replace.
string :: LocalisedString: The text to set at the given index.
add_item(string, index)

Inserts a string at the end or at the given index of this dropdown or listbox.

Parameters
string :: LocalisedString: The text to insert.
index :: uint (optional): The index at which to insert the item.
remove_item(index)

Removes the item at the given index from this dropdown or listbox.

Parameters
index :: uint: The index
get_slider_minimum() → double

Gets this sliders minimum value.

get_slider_maximum() → double

Gets this sliders maximum value.

set_slider_minimum_maximum(minimum, maximum)

Sets this sliders minimum and maximum values.

Parameters
minimum :: double
maximum :: double
Note: The minimum can't be >= the maximum.
get_slider_value_step() → double

Gets the minimum distance this slider can move.

get_slider_discrete_slider() → boolean

Returns whether this slider only allows being moved to discrete positions.

get_slider_discrete_values() → boolean

Returns whether this slider only allows discrete values.

set_slider_value_step(value)

Sets the minimum distance this slider can move.

Parameters
value :: double
Note: The minimum distance can't be > (max - min).
set_slider_discrete_slider(value)

Sets whether this slider only allows being moved to discrete positions.

Parameters
value :: boolean
set_slider_discrete_values(value)

Sets whether this slider only allows discrete values.

Parameters
value :: boolean
focus()

Focuses this GUI element if possible.

scroll_to_top()

Scrolls this scroll bar to the top.

Can only be used if this is scroll-pane or text-box
scroll_to_bottom()

Scrolls this scroll bar to the bottom.

Can only be used if this is scroll-pane or text-box
scroll_to_left()

Scrolls this scroll bar to the left.

Can only be used if this is scroll-pane or text-box
scroll_to_right()

Scrolls this scroll bar to the right.

Can only be used if this is scroll-pane or text-box
scroll_to_element(element, scroll_mode)

Scrolls this scroll bar such that the specified GUI element is visible to the player.

Parameters
element :: LuaGuiElement: The element to scroll to.
scroll_mode :: string (optional): Where the element should be positioned in the scroll-pane. Must be either "in-view" or "top-third". Defaults to "in-view".
Can only be used if this is scroll-pane
select_all()

Selects all the text in this textbox.

Can only be used if this is textfield or text-box
select(start, end)

Selects a range of text in this textbox.

Parameters
start :: int: The index of the first character to select
end :: int: The index of the last character to select
Example
Select the characters amp from example:
textbox.select(3, 5)
Example
Move the cursor to the start of the text box:
textbox.select(1, 0)
Can only be used if this is textfield or text-box
add_tab(tab, content)

Adds the given tab and content widgets to this tabbed pane as a new tab.

Parameters
tab :: LuaGuiElement: The tab to add, must be a GUI element of type "tab".
content :: LuaGuiElement: The content to show when this tab is selected. Can be any type of GUI element.
Can only be used if this is tabbed-pane
remove_tab(tab)

Removes the given tab and its associated content from this tabbed pane.

Parameters
tab :: LuaGuiElement: The tab to remove. If not given, it removes all tabs.
Note: Removing a tab does not destroy the tab or the tab contents. It just removes them from the view.
Note: When removing tabs, LuaGuiElement::selected_tab_index needs to be manually updated.
Can only be used if this is tabbed-pane
force_auto_center()

Forces this frame to re-auto-center. Only works on frames stored directly in LuaGui::screen.

Can only be used if this is frame
scroll_to_item(index, scroll_mode)

Scrolls the scroll bar such that the specified listbox item is visible to the player.

Parameters
index :: int: The item index to scroll to.
scroll_mode :: string (optional): Where the item should be positioned in the scroll-pane. Must be either "in-view" or "top-third". Defaults to "in-view".
Can only be used if this is list-box
bring_to_front()

Moves this GUI element to the "front" so it will draw over other elements.

Note: Only works for elements in LuaGui::screen
index :: uint [Read-only]

The index of this GUI element (unique amongst the GUI elements of a LuaPlayer).

gui :: LuaGui [Read-only]

The GUI this element is a child of.

parent :: LuaGuiElement [Read-only]

The direct parent of this element; nil if this is a top-level element.

name :: string [Read-Write]

The name of this element.

Example
game.player.gui.top.greeting.name == "greeting"
caption :: LocalisedString [Read-Write]

The text displayed on this element. For frames, this is the "heading". For other elements, like buttons or labels, this is the content.

Note: Whilst this attribute may be used on all elements without producing an error, it doesn't make sense for tables and flows as they won't display it.
value :: double [Read-Write]

How much this progress bar is filled. It is a value in the range [0, 1].

Can only be used if this is progressbar
direction :: string [Read-only]

Direction of this element's layout. May be either "horizontal" or "vertical".

Can only be used if this is frame, flow, or line
style :: LuaStyle or string [Read-Write]

The style of this element. When read, this evaluates to a LuaStyle. For writing, it only accepts a string that specifies the textual identifier (prototype name) of the desired style.

visible :: boolean [Read-Write]

Sets whether this GUI element is visible or completely hidden, taking no space in the layout.

text :: string [Read-Write]

The text contained in this textfield or text-box.

Can only be used if this is textfield or text-box
children_names :: array[string] [Read-only]

Names of all the children of this element. These are the identifiers that can be used to access the child as an attribute of this element.

state :: boolean [Read-Write]

Is this checkbox or radiobutton checked?

Can only be used if this is CheckBox or RadioButton
player_index :: uint [Read-only]

Index into LuaGameScript::players specifying the player who owns this element.

sprite :: SpritePath [Read-Write]

The image to display on this sprite-button or sprite in the default state.

resize_to_sprite :: boolean [Read-Write]

Whether the image widget should resize according to the sprite in it. Defaults to true.

hovered_sprite :: SpritePath [Read-Write]

The image to display on this sprite-button when it is hovered.

Can only be used if this is sprite-button
clicked_sprite :: SpritePath [Read-Write]

The image to display on this sprite-button when it is clicked.

tooltip :: LocalisedString [Read-Write]

horizontal_scroll_policy :: string [Read-Write]

Policy of the horizontal scroll bar. Possible values are "auto", "never", "always", "auto-and-reserve-space", "dont-show-but-allow-scrolling".

Can only be used if this is scroll-pane
vertical_scroll_policy :: string [Read-Write]

Policy of the vertical scroll bar. Possible values are "auto", "never", "always", "auto-and-reserve-space", "dont-show-but-allow-scrolling".

Can only be used if this is scroll-pane
type :: string [Read-only]

The type of this GUI element.

children :: array[LuaGuiElement] [Read-only]

The child-elements of this GUI element.

items :: array[LocalisedString] [Read-Write]

The items in this dropdown or listbox.

selected_index :: uint [Read-Write]

The selected index for this dropdown or listbox. Returns 0 if none is selected.

number :: double [Read-Write]

The number to be shown in the bottom right corner of this sprite-button. Set this to nil to show nothing.

show_percent_for_small_numbers :: boolean [Read-Write]

Related to the number to be shown in the bottom right corner of this sprite-button. When set to true, numbers that are non-zero and smaller than one are shown as a percentage rather than the value. For example, 0.5 will be shown as 50% instead.

location :: GuiLocation [Read-Write]

The location of this widget when stored in LuaGui::screen or nil if not not set or not in LuaGui::screen.

auto_center :: boolean [Read-Write]

Whether this frame auto-centers on window resize when stored in LuaGui::screen.

Can only be used if this is frame
badge_text :: LocalisedString [Read-Write]

The text to display after the normal tab text (designed to work with numbers)

Can only be used if this is tab
position :: Position [Read-Write]

The position this camera or minimap is focused on, if any.

surface_index :: uint [Read-Write]

The surface index this camera or minimap is using.

zoom :: double [Read-Write]

The zoom this camera or minimap is using.

minimap_player_index :: uint [Read-Write]

The player index this minimap is using.

Can only be used if this is minimap
force :: string [Read-Write]

The force this minimap is using or nil if no force is set.

elem_type :: string [Read-only]

The elem type of this choose-elem-button.

Can only be used if this is choose-elem-button
elem_value :: string or SignalID [Read-Write]

The elem value of this choose-elem-button or nil if there is no value.

Note: The "signal" type operates with SignalID, while all other types use strings.
Can only be used if this is choose-elem-button
elem_filters :: array[PrototypeFilter] [Read-Write]

The elem filters of this choose-elem-button or nil if there are no filters.

The compatible type of filter is determined by elem_type:

Note: Writing to this field does not change or clear the currently selected element.
Example
This will configure a choose-elem-button of type "entity" to only show items of type "furnace".
button.elem_filters = {{filter = "type", type = "furnace"}}
Example
Then, there are some types of filters that work on a specific kind of attribute. The following will configure a choose-elem-button of type "entity" to only show entities that have their "hidden" flags set.
button.elem_filters = {{filter = "hidden"}}
Example
Lastly, these filters can be combined at will, taking care to specify how they should be combined (either "and" or "or". The following will filter for any "entities" that are "furnaces" and that are not "hidden".
button.elem_filters = {{filter = "type", type = "furnace"}, {filter = "hidden", invert = true, mode = "and"}}
Can only be used if this is choose-elem-button
selectable :: boolean [Read-Write]

Whether the contents of this text-box are selectable. Defaults to true.

Can only be used if this is text-box
word_wrap :: boolean [Read-Write]

Whether this text-box will word-wrap automatically. Defaults to false.

Can only be used if this is text-box
read_only :: boolean [Read-Write]

Whether this text-box is read-only. Defaults to false.

Can only be used if this is text-box
enabled :: boolean [Read-Write]

Whether this GUI element is enabled. Disabled GUI elements don't trigger events when clicked.

ignored_by_interaction :: boolean [Read-Write]

Whether this GUI element is ignored by interaction. This makes clicks on this element 'go through' to the GUI element or even the game surface below it.

locked :: boolean [Read-Write]

Whether this choose-elem-button can be changed by the player.

Can only be used if this is choose-elem-button
draw_vertical_lines :: boolean [Read-Write]

Whether this table should draw vertical grid lines.

Can only be used if this is table
draw_horizontal_lines :: boolean [Read-Write]

Whether this table should draw horizontal grid lines.

Can only be used if this is table
draw_horizontal_line_after_headers :: boolean [Read-Write]

Whether this table should draw a horizontal grid line below the first table row.

Can only be used if this is table
column_count :: uint [Read-only]

The number of columns in this table.

Can only be used if this is table
vertical_centering :: boolean [Read-Write]

Whether the content of this table should be vertically centered. Overrides LuaStyle::column_alignments. Defaults to true.

Can only be used if this is table
slider_value :: double [Read-Write]

The value of this slider element.

Can only be used if this is slider
mouse_button_filter :: MouseButtonFlags [Read-Write]

The mouse button filters for this button or sprite-button.

numeric :: boolean [Read-Write]

Whether this textfield is limited to only numberic characters.

Can only be used if this is textfield
allow_decimal :: boolean [Read-Write]

Whether this textfield (when in numeric mode) allows decimal numbers.

Can only be used if this is textfield
allow_negative :: boolean [Read-Write]

Whether this textfield (when in numeric mode) allows negative numbers.

Can only be used if this is textfield
is_password :: boolean [Read-Write]

Whether this textfield displays as a password field, which renders all characters as *.

Can only be used if this is textfield
lose_focus_on_confirm :: boolean [Read-Write]

Whether this textfield loses focus after defines.events.on_gui_confirmed is fired.

Can only be used if this is textfield
clear_and_focus_on_right_click :: boolean [Read-Write]

Makes it so right-clicking on this textfield clears and focuses it.

Can only be used if this is textfield or text-box
drag_target :: LuaGuiElement [Read-Write]

The frame drag target for this flow, frame, label, table, or empty-widget.

Note: drag_target can only be set to a frame stored directly in LuaGui::screen or nil.
Note: drag_target can only be set on child elements in LuaGui::screen.
Note: drag_target can only be set to a higher level parent element (this element must be owned at some nested level by the drag_target).
selected_tab_index :: uint [Read-Write]

The selected tab index for this tabbed pane or nil if no tab is selected.

Can only be used if this is tabbed-pane
tabs :: array[TabAndContent] [Read-only]

The tabs and contents being shown in this tabbed-pane.

entity :: LuaEntity [Read-Write]

The entity associated with this entity-preview, camera, minimap or nil if no entity is associated.

anchor :: GuiAnchor [Read-Write]

Sets the anchor for this relative widget. Setting nil clears the anchor.

tags :: Tags [Read-Write]

The tags associated with this LuaGuiElement.

switch_state :: string [Read-Write]

The switch state (left, none, right) for this switch.

Note: If LuaGuiElement::allow_none_state is false this can't be set to "none".
Can only be used if this is switch
allow_none_state :: boolean [Read-Write]

Whether the "none" state is allowed for this switch.

Note: This can't be set to false if the current switch_state is 'none'.
Can only be used if this is switch
left_label_caption :: LocalisedString [Read-Write]

The text shown for the left switch label.

Can only be used if this is switch
left_label_tooltip :: LocalisedString [Read-Write]

The tooltip shown on the left switch label.

Can only be used if this is switch
right_label_caption :: LocalisedString [Read-Write]

The text shown for the right switch label.

Can only be used if this is switch
right_label_tooltip :: LocalisedString [Read-Write]

The tooltip shown on the right switch label.

Can only be used if this is switch
operator [] :: LuaGuiElement [Read-only]

The indexing operator. Gets children by name.