Factorio Prototype DocsVersion 2.0.19

GuiStyle 'gui-style'

The available GUI styles.

Prototype limited to 1 total instances.

Inherits from PrototypeBase

Properties

Custom properties :: stringStyleSpecification

Styles are defined as uniquely named StyleSpecification properties of the prototype. [...]

Styles are defined as uniquely named StyleSpecification properties of the prototype. [...]

Inherited from PrototypeBase
type :: string

Specifies the kind of prototype this is. [...]

Specifies the kind of prototype this is. [...]

name :: string

Unique textual identification of the prototype. [...]

Unique textual identification of the prototype. [...]

order optional :: Order

Used to order prototypes in inventory, recipes and GUIs. [...]

Used to order prototypes in inventory, recipes and GUIs. [...]

localised_name optional :: LocalisedString

Overwrites the name set in the locale file. [...]

Overwrites the name set in the locale file. [...]

localised_description optional :: LocalisedString

Overwrites the description set in the locale file. [...]

Overwrites the description set in the locale file. [...]

factoriopedia_descriptionnew optional :: LocalisedString

Provides additional description used in factoriopedia.

Provides additional description used in factoriopedia.

subgroupnew optional :: ItemSubGroupID

The name of an ItemSubGroup.

The name of an ItemSubGroup.

hiddennew optional :: bool
hidden_in_factoriopedianew optional :: bool
parameternew optional :: bool

Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.

Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.

factoriopedia_simulationnew optional :: SimulationDefinition

The simulation shown when looking at this prototype in the Factoriopedia GUI.

The simulation shown when looking at this prototype in the Factoriopedia GUI.

Properties

default_tileset :: FileName optional

Default: ""

default_sprite_scale :: double optional

Default: 1

default_sprite_priority :: SpritePriority optional

Default: "medium"

Custom properties  :: stringStyleSpecification

Styles are defined as uniquely named StyleSpecification properties of the prototype.

Styles with certain names are mandatory, as they are used by the base game GUI. A list is found below.

Mandatory styles:
  • "confirm_button"
  • "confirm_button_without_tooltip"
  • "confirm_double_arrow_button"
  • "tips_and_tricks_notification_button"
  • "red_confirm_button"
  • "red_back_button"
  • "red_button"
  • "green_button"
  • "tool_button_red"
  • "tool_button"
  • "tool_button_without_padding"
  • "tool_button_green"
  • "tool_button_blue"
  • "tool_button_flush_fluid"
  • "mini_button"
  • "mini_button_aligned_to_text_vertically"
  • "mini_button_aligned_to_text_vertically_when_centered"
  • "mini_tool_button_red"
  • "highlighted_tool_button"
  • "confirm_in_load_game_button"
  • "back_button"
  • "forward_button"
  • "menu_button"
  • "menu_button_continue"
  • "side_menu_button"
  • "dialog_button"
  • "control_settings_button"
  • "control_settings_section_button"
  • "quick_bar_page_button"
  • "slot_button"
  • "slot_button_in_shallow_frame"
  • "yellow_slot_button"
  • "red_slot_button"
  • "slot_sized_button"
  • "compact_slot_sized_button"
  • "slot_sized_button_blue"
  • "slot_sized_button_red"
  • "slot_sized_button_green"
  • "shortcut_bar_button"
  • "shortcut_bar_button_blue"
  • "shortcut_bar_button_red"
  • "shortcut_bar_button_green"
  • "shortcut_bar_button_small"
  • "shortcut_bar_button_small_green"
  • "shortcut_bar_button_small_red"
  • "shortcut_bar_button_small_blue"
  • "compact_slot"
  • "slot"
  • "red_slot"
  • "yellow_slot"
  • "green_slot"
  • "blue_slot"
  • "inventory_slot"
  • "filter_inventory_slot"
  • "closed_inventory_slot"
  • "red_inventory_slot"
  • "yellow_inventory_slot"
  • "filter_group_button_tab_slightly_larger"
  • "blueprint_record_slot_button"
  • "blueprint_record_selection_button"
  • "compact_red_slot"
  • "inventory_limit_slot_button"
  • "working_weapon_button"
  • "not_working_weapon_button"
  • "transparent_slot"
  • "universe_frame"
  • "universe_widget"
  • "universe_connection_button"
  • "universe_platform_button"
  • "frame_action_button"
  • "train_schedule_action_button"
  • "train_schedule_delete_button"
  • "train_schedule_collapse_button"
  • "shortcut_bar_expand_button"
  • "open_armor_button"
  • "item_and_count_select_confirm"
  • "tool_bar_open_button"
  • "map_view_add_button"
  • "tool_equip_ammo_slot"
  • "choose_chat_icon_button"
  • "choose_chat_icon_in_textbox_button"
  • "decider_combinator_signal_select_button"
  • "decider_combinator_fulfilled_signal_select_button"
  • "tool_equip_equipment_image"
  • "clickable_empty_technology_slot"
  • "disabled_technology_slot"
  • "disabled_index_technology_slot"
  • "researched_technology_slot"
  • "available_technology_slot"
  • "conditionally_available_technology_slot"
  • "unavailable_technology_slot"
  • "disabled_preview_technology_slot"
  • "disabled_preview_index_technology_slot"
  • "researched_preview_technology_slot"
  • "available_preview_technology_slot"
  • "conditionally_available_preview_technology_slot"
  • "unavailable_preview_technology_slot"
  • "omitted_technology_slot"
  • "crafting_queue_slot"
  • "promised_crafting_queue_slot"
  • "image_tab_slot"
  • "image_tab_selected_slot"
  • "red_circuit_network_content_slot"
  • "green_circuit_network_content_slot"
  • "drop_target_button"
  • "locomotive_minimap_button"
  • "browse_games_gui_toggle_favorite_on_button"
  • "browse_games_gui_toggle_favorite_off_button"
  • "research_queue_cancel_button"
  • "research_queue_move_button"
  • "new_game_header_list_box_item"
  • "list_box_item"
  • "train_status_button"
  • "station_train_status_button"
  • "title_tip_item"
  • "default_permission_group_list_box_item"
  • "target_station_in_schedule_in_train_view_list_box_item"
  • "no_path_station_in_schedule_in_train_view_list_box_item"
  • "not_accessible_station_in_station_selection"
  • "partially_accessible_station_in_station_selection"
  • "other_settings_gui_button"
  • "map_generator_preview_button"
  • "map_generator_close_preview_button"
  • "map_generator_confirm_button"
  • "train_schedule_comparison_type_button"
  • "train_schedule_add_wait_condition_button"
  • "train_schedule_add_station_button"
  • "train_schedule_add_interrupt_station_button"
  • "train_schedule_item_select_button"
  • "train_schedule_fulfilled_item_select_button"
  • "train_schedule_fulfilled_delete_button"
  • "train_schedule_temporary_station_delete_button"
  • "train_schedule_condition_time_selection_button"
  • "entity_variation_button"
  • "tile_variation_button"
  • "cancel_close_button"
  • "close_button"
  • "mods_filter_exclude_button"
  • "wide_list_box"
  • "wide_list_box_in_shallow_frame"
  • "wide_list_box_under_subheader"
  • "wide_list_box_in_shallow_frame_under_subheader"
  • "list_box_under_subheader"
  • "campaigns_list_box"
  • "campaign_levels_list_box"
  • "custom_games_list_box"
  • "train_station_list_box"
  • "floating_train_station_list_box"
  • "schedule_in_train_view_list_box"
  • "permissions_groups_list_box"
  • "permissions_players_list_box"
  • "naked_list_box"
  • "locale_dropdown"
  • "game_controller_icons_dropdown"
  • "circuit_condition_comparator_dropdown"
  • "train_schedule_circuit_condition_comparator_dropdown"
  • "changelog_textbox"
  • "console_input_textfield"
  • "invalid_value_textfield"
  • "highlighted_value_textfield"
  • "mod_startup_settings_mismatch_notice_box"
  • "notice_scroll_pane"
  • "pins_scroll_pane"
  • "notice_textbox"
  • "long_number_textfield"
  • "big_notice_textbox"
  • "small_notice_textbox"
  • "search_popup_textfield"
  • "other_settings_gui_textbox"
  • "short_number_textfield"
  • "invalid_value_short_number_textfield"
  • "very_short_number_textfield"
  • "slider_value_textfield"
  • "wide_slider_value_textfield"
  • "stretchable_textfield"
  • "editor_lua_textbox"
  • "edit_blueprint_description_textbox"
  • "non_draggable_frame"
  • "invisible_frame"
  • "frame_with_even_paddings"
  • "no_header_filler_frame"
  • "map_details_frame"
  • "bordered_frame"
  • "inside_deep_frame"
  • "tab_deep_frame_in_entity_frame"
  • "deep_frame_in_shallow_frame_for_description"
  • "inside_shallow_frame"
  • "shallow_frame_in_shallow_frame"
  • "inside_shallow_frame_with_padding"
  • "inside_shallow_frame_with_padding_and_vertical_spacing"
  • "deep_frame_in_shallow_frame"
  • "deep_frame_in_tabbed_pane"
  • "slot_button_deep_frame"
  • "inventory_frame"
  • "quick_panel_slot_button_deep_frame"
  • "filter_frame"
  • "train_inventory_frame"
  • "tooltip_frame"
  • "tooltip_description_frame"
  • "blueprint_tooltip_description_frame"
  • "goal_frame"
  • "goal_inner_frame"
  • "shortcut_bar_window_frame"
  • "quick_bar_inner_panel"
  • "tool_equip_inner_panel"
  • "shortcut_bar_inner_panel"
  • "subfooter_frame"
  • "subfooter_frame_with_left_edge"
  • "tips_and_tricks_info_frame"
  • "tips_and_tricks_info_frame_small_screen"
  • "tips_and_tricks_subfooter"
  • "right_container_frame"
  • "minimap_frame"
  • "side_menu_frame"
  • "achievement_frame"
  • "completed_achievement_frame"
  • "tips_and_tricks_frame"
  • "failed_achievement_frame"
  • "achievement_notification_frame"
  • "tips_and_tricks_notification_frame"
  • "subheader_frame"
  • "repeated_subheader_frame"
  • "subheader_frame_with_text_on_the_right"
  • "negative_subheader_frame"
  • "slot_group_frame"
  • "inside_shallow_frame_packed"
  • "slot_window_frame"
  • "quick_bar_slot_window_frame"
  • "technology_card_frame"
  • "research_progress_inner_frame_inactive"
  • "research_progress_inner_frame_active"
  • "shallow_frame"
  • "control_settings_section_frame"
  • "technology_gui_outer_frame"
  • "technology_gui_left_frame"
  • "technology_graph_title_frame"
  • "train_schedule_station_frame"
  • "train_schedule_station_in_interrupt_frame"
  • "train_schedule_temporary_station_frame"
  • "train_schedule_condition_frame"
  • "blueprint_parameter_frame"
  • "train_schedule_fullfilled_condition_frame"
  • "train_schedule_comparison_type_frame"
  • "train_schedule_comparison_type_frame_indented"
  • "train_schedule_comparison_type_frame_extra_indented"
  • "sync_mods_default_status_frame"
  • "sync_mods_downloading_status_frame"
  • "tooltip_title_frame_light"
  • "tooltip_panel_background"
  • "number_input_frame"
  • "neutral_message_frame"
  • "negative_message_frame"
  • "positive_message_frame"
  • "shortcut_selection_row"
  • "frame_tabbed_pane_corner"
  • "frame_tabbed_pane_frame_header"
  • "tabbed_pane_frame"
  • "frame_without_left_side"
  • "frame_without_left_and_right_side"
  • "character_gui_left_side"
  • "search_popup_frame"
  • "bonus_card_frame"
  • "empty_bonus_card_frame"
  • "inset_frame_container_frame"
  • "chart_search_result_frame"
  • "pins_frame"
  • "current_research_info_button"
  • "current_research_info_image"
  • "current_research_info_percent_label"
  • "blueprint_book_edit_frame"
  • "main_progressbar_frame"
  • "editor_mode_selection_frame"
  • "editor_inner_frame"
  • "new_game_subfooter"
  • "entity_frame"
  • "entity_button_frame"
  • "train_with_minimap_frame"
  • "lab_technology_frame"
  • "lab_technology_frame_empty"
  • "right_side_frame"
  • "decider_combinator_frame"
  • "decider_combinator_condition_frame"
  • "decider_combinator_fulfilled_condition_frame"
  • "frame_around_top"
  • "frame_around_bottom"
  • "frame_around_left"
  • "frame_around_right"
  • "frame_around_center"
  • "packed_horizontal_flow"
  • "compact_horizontal_flow"
  • "dialog_buttons_horizontal_flow"
  • "player_input_horizontal_flow"
  • "inset_frame_container_horizontal_flow"
  • "inset_frame_container_horizontal_flow_in_tabbed_pane"
  • "train_schedule_mode_switch_horizontal_flow"
  • "horizontal_flow_with_extra_right_margin"
  • "relative_gui_top_flow"
  • "relative_gui_bottom_flow"
  • "two_module_spacing_horizontal_flow"
  • "relative_gui_left_flow"
  • "relative_gui_right_flow"
  • "packed_vertical_flow"
  • "padded_vertical_flow"
  • "quickbar_holder_flow"
  • "inset_frame_container_vertical_flow"
  • "two_module_spacing_vertical_flow"
  • "new_game_difficulty_vertical_flow"
  • "crafting_queue_flow"
  • "table_with_selection"
  • "players_table"
  • "mods_explore_results_table"
  • "bordered_table"
  • "compact_slot_table"
  • "slot_table"
  • "browse_games_table"
  • "browse_games_on_lan_table"
  • "inset_frame_container_table"
  • "map_generator_frequency_table"
  • "player_input_table"
  • "graphics_settings_table"
  • "control_settings_bordered_table"
  • "sync_mods_table"
  • "removed_content_table"
  • "finished_game_table"
  • "filter_slot_table"
  • "editor_mode_selection_table"
  • "splitter_settings_table"
  • "trains_widget_table"
  • "undelete_space_platforms_table"
  • "wide_activity_bar"
  • "production_progressbar"
  • "burning_progressbar"
  • "health_progressbar"
  • "vehicle_health_progressbar"
  • "mining_progressbar"
  • "shield_progressbar"
  • "bonus_progressbar"
  • "battery_progressbar"
  • "electric_satisfaction_progressbar"
  • "electric_satisfaction_statistics_progressbar"
  • "electric_statistics_progressbar"
  • "electric_satisfaction_in_description_progressbar"
  • "item_spoilage_in_description_progress_bar"
  • "thick_progressbar"
  • "disk_usage_progressbar"
  • "achievement_progressbar"
  • "achievement_card_progressbar"
  • "heat_progressbar"
  • "rocket_weight_used_progress_bar"
  • "caption_checkbox"
  • "subheader_caption_checkbox"
  • "black_checkbox"
  • "caption_radiobutton"
  • "frame_title"
  • "caption_label"
  • "semibold_caption_label"
  • "semibold_label"
  • "bold_label"
  • "green_label"
  • "bold_black_label"
  • "bold_green_label"
  • "red_label"
  • "bold_red_label"
  • "electric_usage_label"
  • "count_label"
  • "recipe_count_line_label"
  • "tooltip_label"
  • "tooltip_title_label"
  • "subheader_label"
  • "subheader_caption_label"
  • "subheader_semibold_label"
  • "subheader_right_aligned_label"
  • "heading_2_label"
  • "achievement_unlocked_title_label"
  • "achievement_locked_title_label"
  • "achievement_failed_title_label"
  • "achievement_failed_description_label"
  • "achievement_failed_reason_label"
  • "tips_and_tricks_title_label"
  • "steam_friend_label"
  • "frame_subheading_label"
  • "orange_label"
  • "bold_orange_label"
  • "grey_label"
  • "bold_grey_label"
  • "tooltip_heading_label"
  • "tooltip_heading_label_category"
  • "squashable_label"
  • "black_label"
  • "black_squashable_label"
  • "black_label_with_left_padding"
  • "black_squashable_label_with_left_padding"
  • "black_clickable_label"
  • "black_clickable_squashable_label"
  • "color_picker_label"
  • "tooltip_item_label"
  • "clickable_label"
  • "clickable_squashable_label"
  • "label_with_left_padding"
  • "squashable_label_with_left_padding"
  • "train_schedule_unavailable_stop_label"
  • "train_schedule_non_existent_stop_label"
  • "hyperlink_label"
  • "info_label"
  • "control_input_shortcut_label"
  • "main_menu_version_label"
  • "label_under_widget"
  • "finished_game_label"
  • "train_stop_subheader"
  • "inventory_frame_title_style"
  • "mods_filter_hit_count_label"
  • "inside_shallow_frame_with_padding_line"
  • "blurry_panel_horizontal_line"
  • "dark_line"
  • "tooltip_category_line"
  • "tooltip_horizontal_line"
  • "lab_progress_and_slot_divider"
  • "lab_progress_and_slot_divider_empty"
  • "scroll_pane_in_shallow_frame"
  • "trains_scroll_pane"
  • "trains_scroll_pane_with_side_margin"
  • "stations_scroll_pane"
  • "stations_scroll_pane_small_screen"
  • "tab_scroll_pane"
  • "technology_list_scroll_pane"
  • "statistics_scroll_pane"
  • "blurry_scroll_pane"
  • "map_preview_scroll_pane"
  • "tab_shallow_scroll_pane"
  • "featured_technology_description_scroll_pane"
  • "scroll_pane_under_subheader"
  • "train_schedule_scroll_pane"
  • "train_interrupts_scroll_pane"
  • "mods_scroll_pane"
  • "stations_trains_scroll_pane"
  • "entity_frame_scroll_pane"
  • "shallow_scroll_pane"
  • "shallow_slots_scroll_pane"
  • "deep_scroll_pane"
  • "deep_slots_scroll_pane"
  • "achievement_slots_scroll_pane"
  • "logistic_sections_scroll_pane"
  • "character_crafting_queue_scroll_pane"
  • "logistic_gui_items_scroll_pane"
  • "shortcut_bar_selection_scroll_pane"
  • "naked_scroll_pane"
  • "horizontally_limited_equipment_grid_scroll_pane"
  • "text_holding_scroll_pane"
  • "factoriopedia_contents_scroll_pane"
  • "factoriopedia_icon_grid_scroll_pane"
  • "decider_combinator_conditions_scroll_pane"
  • "decider_combinator_outputs_scroll_pane"
  • "achievement_image"
  • "map_info_image"
  • "new_game_info_image"
  • "mod_thumbnail_image"
  • "mod_explore_thumbnail_image"
  • "mod_updates_status_image"
  • "install_mod_status_image"
  • "mod_attribute_image"
  • "tips_and_tricks_image"
  • "logistics_diode"
  • "status_image"
  • "achievement_warning_image"
  • "mods_sorting_image"
  • "recipe_tooltip_horizontal_image"
  • "tips_and_tricks_simulation"
  • "entity_button_base"
  • "undo_camera"
  • "tooltip_camera"
  • "wide_entity_button"
  • "draggable_space_in_train_schedule"
  • "draggable_space_in_temporary_train_station"
  • "fulfilled_draggable_space_in_train_schedule"
  • "color_indicator"
  • "minimap_widget_under_subheader"
  • "blueprint_preview"
  • "entity_frame_filler"
  • "tool_bar_empty_slot"
  • "research_queue_active_glow_dark"
  • "research_queue_active_glow_light"
  • "research_queue_active_glow_outer"
  • "notched_slider"
  • "map_generator_notched_slider"
  • "map_generator_13_notch_slider"
  • "map_generator_notched_slider_wide"
  • "red_slider"
  • "green_slider"
  • "blue_slider"
  • "other_settings_slider"
  • "notched_double_slider"
  • "blueprint_drop_slot_button"
  • "blueprint_icon_preview"
  • "draggable_space"
  • "draggable_space_in_shortcut_list"
  • "filter_tabbed_pane"
  • "frame_tabbed_pane"
  • "quick_panel_tabbed_pane"
  • "tabbed_pane_with_no_side_padding"
  • "tabbed_pane_with_extra_padding"
  • "frame_tab"
  • "filter_group_tab"
  • "slightly_smaller_tab"
  • "filter_group_slot_tab"
  • "production_graph"
  • "research_info_tooltip_graph"

Example

-- Adding a custom frame_style-type style
data.raw["gui-style"]["default"]["custom_style_for_a_frame"] =
{
  type = "frame_style",
  parent = "frame",
  use_header_filler = false,
  drag_by_title = false
}

Prototypes

Types

Defines