Prototype/GuiStyle: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎Styles: Added an example of adding a custom style)
(Removed old prototype docs)
Tag: Replaced
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Prototype parent}}
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/GuiStyle.html https://lua-api.factorio.com/latest/prototypes/GuiStyle.html]
The available gui styles. Only 1 instance of this prototype can exist.


{{Prototype TOC|gui-style}}
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
== Mandatory properties ==
 
{{Prototype property|type|[[Types/string|string]]}}
Must be "gui-style".
 
{{Prototype property|name|[[Types/string|string]]}}
Name of the gui-style. Must be "default" since only one instance of this prototype can be defined.
 
== Styles ==
Styles are defined as uniquely named properties of the prototype with a value of an extension of [[Types/StyleSpecification|StyleSpecification]].
 
=== Example ===
Example of adding a custom style, in this case a [[Types/FrameStyleSpecification]]:
<syntaxhighlight lang="lua">data.raw["gui-style"]["default"]["custom_style_for_a_frame"] =
{
  type = "frame_style",
  parent = "frame",
  use_header_filler = false,
  drag_by_title = false
}</syntaxhighlight>
 
=== Mandatory styles ===
Styles with certain names are mandatory, these styles are used by the base game GUI.
<div class="toccolours mw-collapsible mw-collapsed" style="width: 40em;">
List of mandatory styles
<pre class="mw-collapsible-content">
"confirm_button"
"confirm_double_arrow_button"
"red_confirm_button"
"red_back_button"
"red_button"
"green_button"
"tool_button_red"
"tool_button"
"tool_button_green"
"tool_button_blue"
"mini_button"
"mini_button_aligned_to_text_vertically"
"mini_button_aligned_to_text_vertically_when_centered"
"highlighted_tool_button"
"confirm_in_load_game_button"
"back_button"
"forward_button"
"menu_button"
"menu_button_continue"
"side_menu_button"
"map_view_options_button"
"map_view_options_table"
"map_view_options_table_holder"
"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"
"quick_bar_slot_button"
"statistics_slot_button"
"slot_sized_button"
"compact_slot_sized_button"
"slot_button_that_fits_textline"
"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"
"recipe_slot_button"
"filter_group_button_tab"
"filter_group_button_tab_slightly_larger"
"tracking_on_button"
"tracking_off_button"
"blueprint_record_slot_button"
"blueprint_record_selection_button"
"compact_red_slot"
"inventory_limit_slot_button"
"working_weapon_button"
"not_working_weapon_button"
"transparent_slot"
"frame_action_button"
"train_schedule_action_button"
"train_schedule_delete_button"
"shortcut_bar_expand_button"
"open_armor_button"
"item_and_count_select_confirm"
"tool_bar_open_button"
"map_view_add_button"
"tool_equip_virtual_slot"
"working_tool_equip_virtual_slot"
"not_working_tool_equip_virtual_slot"
"tool_equip_ammo_slot"
"choose_chat_icon_button"
"choose_chat_icon_in_textbox_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"
"logistic_slot_button"
"yellow_logistic_slot_button"
"red_logistic_slot_button"
"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"
"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_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"
"saves_list_box"
"saves_list_box_under_subheader"
"list_box_under_subheader"
"mods_list_box"
"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"
"logistic_networks_dropdown"
"locale_dropdown"
"circuit_condition_comparator_dropdown"
"changelog_dropdown"
"changelog_textbox"
"console_input_textfield"
"invalid_value_textfield"
"highlighted_value_textfield"
"map_generator_preset_description"
"mod_startup_settings_mismatch_notice_box"
"notice_scroll_pane"
"notice_textbox"
"long_number_textfield"
"reader_textbox"
"search_textfield_with_fixed_width"
"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"
"titlebar_search_textfield"
"production_gui_search_textfield"
"electric_gui_search_textfield"
"edit_blueprint_description_textbox"
"non_draggable_frame"
"invisible_frame"
"frame_with_even_paddings"
"no_header_filler_frame"
"map_details_frame"
"bordered_frame"
"bordered_frame_with_extra_side_margins"
"inner_frame"
"inner_frame_in_outer_frame"
"inside_deep_frame"
"inside_deep_frame_for_tabs"
"deep_frame_in_shallow_frame_for_tabs"
"logistics_scroll_pane_background_frame"
"item_and_count_select_background"
"inside_shallow_frame"
"inside_shallow_frame_with_padding"
"container_inside_shallow_frame"
"deep_frame_in_shallow_frame"
"trains_gui_deep_frame"
"slot_button_deep_frame"
"slot_button_deep_scroll_pane"
"deep_frame_in_shallow_frame_with_margin"
"slot_container_frame"
"filter_scroll_pane_background_frame"
"filter_scroll_pane_background_frame_no_background"
"blueprint_record_selection_background_frame"
"inventory_frame"
"other_player_inventory_frame"
"character_inventory_frame"
"armor_frame"
"filter_frame"
"train_inventory_frame"
"train_inventory_fake_window"
"character_logistics_frame"
"auto_trash_frame"
"invisible_frame_with_title"
"invisible_frame_with_title_for_inventory"
"invisible_frame_in_tab_with_title_for_inventory"
"container_invisible_frame_with_title"
"constant_combinator_invisible_frame_with_title"
"car_top_part_frame"
"machine_frame"
"outer_frame"
"outer_frame_without_shadow"
"outer_frame_without_top_shadow"
"tooltip_frame"
"tooltip_generated_from_description_frame"
"tooltip_generated_from_description_blueprint_frame"
"multi_tooltip_invisible_frame"
"naked_frame"
"naked_frame_with_simple_header"
"naked_frame_with_no_spacing"
"goal_frame"
"goal_inner_frame"
"entity_info_frame"
"entity_info_frame_on_cursor"
"quick_bar_window_frame"
"shortcut_bar_window_frame"
"statistics_time_buttons_frame"
"quick_bar_inner_panel"
"tool_equip_inner_panel"
"shortcut_bar_inner_panel"
"quick_bar_naked_frame"
"subfooter_frame"
"subfooter_frame_with_left_edge"
"tips_and_tricks_info_frame"
"tips_and_tricks_subfooter"
"right_container_frame"
"right_bottom_container_frame"
"minimap_frame"
"side_menu_frame"
"locked_achievement_frame"
"unlocked_achievement_frame"
"failed_achievement_frame"
"locked_achievement_in_sidebar_frame"
"unlocked_achievement_in_sidebar_frame"
"failed_achievement_in_sidebar_frame"
"achievement_notification_frame"
"blueprint_library_frame"
"research_queue_inner_frame"
"a_inner_frame"
"b_inner_frame"
"browse_games_info_frame"
"browse_games_filter_frame"
"a_inner_paddingless_frame"
"a_inner_frame_for_subheader_with_paddings"
"b_inner_frame_for_subheader_with_paddings"
"connect_gui_frame"
"subheader_frame"
"subheader_frame_with_text_on_the_right"
"subheader_frame_with_top_border"
"negative_subheader_frame"
"slot_group_frame"
"window_content_frame"
"window_content_frame_deep"
"window_content_frame_in_tabbed_panne"
"window_content_frame_packed"
"graphicless_frame"
"technology_card_frame"
"research_progress_inner_frame_inactive"
"research_progress_inner_frame_active"
"subpanel_frame"
"subpanel_frame_packed"
"subpanel_inset_frame"
"subpanel_inset_frame_packed"
"control_settings_section_frame"
"statistics_frame"
"statistics_table_item_frame"
"technology_gui_outer_frame"
"technology_gui_inner_frame"
"technology_gui_left_frame"
"technology_gui_right_top_frame"
"train_schedule_station_frame"
"train_schedule_temporary_station_frame"
"train_schedule_condition_frame"
"train_schedule_fullfilled_condition_frame"
"train_schedule_comparison_type_frame"
"train_schedule_comparison_type_frame_indented"
"train_schedule_comparison_type_frame_extra_indented"
"tooltip_title_frame_light"
"tooltip_panel_background"
"number_input_frame"
"void_inventory_frame"
"mod_info_frame"
"neutral_message_frame"
"negative_message_frame"
"positive_message_frame"
"finished_game_subheader_frame"
"shortcut_selection_row"
"changelog_frame"
"changelog_subheader_frame"
"train_stop_frame"
"train_stop_trains_frame"
"rename_train_stop_frame"
"frame_tabbed_pane_corner"
"frame_tabbed_pane_frame_header"
"frame_without_left_side"
"frame_without_left_and_right_side"
"frame_without_right_side"
"character_gui_left_side"
"crafting_frame"
"search_popup_frame"
"blueprint_settings_frame"
"bonus_card_frame"
"empty_bonus_card_frame"
"bonus_card_with_scroll_frame"
"bonus_card_related_items_frame"
"inset_frame_container_frame"
"borderless_frame"
"current_research_info_button"
"current_research_info_image"
"current_research_info_percent_label_white"
"current_research_info_percent_label_black"
"add_to_map_buttons_frame"
"subheader_frame_that_cuts_to_sides"
"blueprint_header_frame"
"blueprint_header_holder_frame"
"blueprint_book_edit_frame"
"main_progressbar_frame"
"side_progressbar_frame"
"editor_mode_selection_frame"
"editor_inner_frame"
"new_game_subfooter"
"entity_frame"
"entity_frame_without_right_padding"
"entity_frame_without_side_paddings"
"entity_frame_without_padding"
"combinator_settings_invisible_frame"
"programmable_speaker_invisible_frame"
"entity_button_frame"
"entity_button_frame_with_extra_right_margin"
"train_with_minimap_frame"
"trains_gui_frame"
"lab_technology_frame"
"right_side_frame"
"slot_table_spacing_horizontal_flow"
"research_queue_first_slot_flow"
"packed_horizontal_flow"
"centering_horizontal_flow"
"dialog_buttons_horizontal_flow"
"player_input_horizontal_flow"
"inset_frame_container_horizontal_flow"
"inset_frame_container_horizontal_flow_in_tabbed_pane"
"save_as_horizontal_flow"
"train_schedule_mode_switch_horizontal_flow"
"search_bar_horizontal_flow"
"horizontal_flow_with_extra_right_margin"
"status_flow"
"relative_gui_top_flow"
"relative_gui_bottom_flow"
"relative_gui_left_flow"
"relative_gui_right_flow"
"mods_gui_left_pane_vertical_flow"
"mods_gui_right_pane_vertical_flow"
"slot_table_spacing_vertical_flow"
"achievements_vertical_flow"
"tracked_achievements_vertical_flow"
"goal_holder_vertical_flow"
"technology_card"
"packed_vertical_flow"
"padded_vertical_flow"
"shortcut_bar_column"
"quickbar_holder_flow"
"container_equipment_grid_flow"
"padded_container_equipment_grid_flow"
"bonus_card_labels_flow_with_scroll_pane"
"vertical_flow_with_extra_margins"
"vertical_flow_under_subheader"
"inset_frame_container_vertical_flow"
"game_info_name_and_description_flow"
"new_game_difficulty_vertical_flow"
"vertical_flow_in_entity_frame_without_side_paddings"
"featured_technology_effects_flow"
"technology_tooltip_effects_flow"
"flow_with_no_spacing"
"centering_flow"
"changelog_subheader_space"
"bonus_card_flow"
"crafting_queue_flow"
"compact_flow"
"bordered_table"
"armor_info_table"
"statistics_element_table"
"compact_slot_table"
"slot_table"
"logistics_slot_table"
"browse_games_table"
"browse_games_on_lan_table"
"mods_table"
"trains_list_table"
"technology_slot_table"
"featured_technology_inner_table"
"research_queue_table"
"inset_frame_container_table"
"map_generator_frequency_table"
"manage_players_table"
"quick_bar_slot_table"
"player_input_table"
"graphics_settings_table"
"control_settings_bordered_table"
"mod_info_table"
"removed_content_table"
"finished_game_table"
"electric_satisfaction_table"
"filter_group_table"
"filter_slot_table"
"table_with_extra_margins"
"editor_mode_selection_table"
"splitter_settings_table"
"logistic_gui_table"
"trains_table"
"relative_gui_table"
"wide_activity_bar"
"production_progressbar"
"burning_progressbar"
"health_progressbar"
"vehicle_health_progressbar"
"mining_progressbar"
"shield_progressbar"
"bonus_progressbar"
"battery_progressbar"
"statistics_progressbar"
"electric_satisfaction_progressbar"
"electric_satisfaction_statistics_progressbar"
"electric_statistics_progressbar"
"electric_satisfaction_in_description_progressbar"
"achievement_progressbar"
"achievement_card_progressbar"
"achievement_pinned_card_progressbar"
"research_progressbar"
"heat_progressbar"
"caption_checkbox"
"frame_title"
"map_gen_row_label"
"caption_label"
"label_dividing_inside_frames"
"invalid_label"
"bold_label"
"bold_green_label"
"bold_red_label"
"yellow_label"
"goal_label"
"tip_notice_inner_panel"
"tip_notice_button"
"tip_notice_close_button"
"electric_usage_label"
"mod_dependency_invalid_label"
"mod_optional_dependency_invalid_label"
"mod_manager_label"
"description_title_label"
"description_title_indented_label"
"count_label"
"description_label"
"description_property_name_label"
"description_value_label"
"recipe_count_label"
"tooltip_label"
"tooltip_title_label"
"recipe_tooltip_cannot_craft_count_label"
"recipe_tooltip_transitive_craft_count_label"
"recipe_tooltip_cannot_craft_label"
"recipe_tooltip_transitive_craft_label"
"subheader_caption_label"
"subheader_right_aligned_label"
"heading_1_label"
"heading_2_label"
"heading_3_label"
"heading_3_label_yellow"
"menu_message"
"achievement_title_label"
"achievement_percent_label"
"achievement_unlocked_title_label"
"achievement_locked_title_label"
"achievement_failed_title_label"
"achievement_description_label"
"achievement_unlocked_description_label"
"achievement_locked_description_label"
"achievement_failed_description_label"
"achievement_locked_progress_label"
"achievement_failed_reason_label"
"invalid_mod_label"
"invalid_hovered_mod_label"
"invalid_selected_mod_label"
"valid_mod_label"
"valid_hovered_mod_label"
"valid_selected_mod_label"
"steam_friend_label"
"load_game_mod_invalid_label"
"mod_disabled_label"
"featured_technology_description_label"
"frame_subheading_label"
"orange_label"
"player_online_label"
"player_offline_label"
"player_not_in_game_state_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_login_notice_label"
"main_menu_version_label"
"saved_research_label"
"label_under_widget"
"special_label_under_widget"
"inventory_label"
"inside_shallow_frame_with_padding_line"
"control_behavior_window_line"
"blurry_panel_horizontal_line"
"dark_line"
"frame_division_fake_horizontal_line"
"tooltip_category_line"
"tooltip_horizontal_line"
"lab_progress_and_slot_divider"
"scroll_pane_in_shallow_frame"
"scroll_pane_in_shallow_frame_with_extra_padding_when_activated"
"trains_scroll_pane"
"stations_scroll_pane"
"tab_scroll_pane"
"tab_scroll_pane_with_extra_padding"
"browse_games_scroll_pane"
"machine_ingredients_scroll_pane"
"machine_outputs_scroll_pane"
"module_inventory_scroll_pane"
"machine_slots_scroll_pane"
"trash_slots_scroll_pane"
"trash_slots_scroll_pane_in_tab"
"logistic_gui_scroll_pane"
"technology_list_scroll_pane"
"statistics_scroll_pane"
"blurry_scroll_pane"
"map_preview_scroll_pane"
"featured_technology_description_scroll_pane"
"control_settings_scroll_pane"
"scroll_pane_under_subheader"
"train_schedule_scroll_pane"
"mods_scroll_pane"
"stations_trains_scroll_pane"
"inventory_scroll_pane"
"character_inventory_scroll_pane"
"trunk_inventory_scroll_pane"
"inventory_in_tab_scroll_pane"
"inventory_scroll_pane_without_background_tiling"
"entity_inventory_scroll_pane"
"logistics_scroll_pane"
"constant_combinator_logistics_scroll_pane"
"container_logistics_scroll_pane"
"character_info_scroll_pane"
"controller_logistics_scroll_pane"
"filter_scroll_pane"
"filter_scroll_pane_in_tab"
"removed_content_scroll_pane"
"changelog_scroll_pane"
"shortcut_bar_selection_scroll_pane"
"only_inner_shadow_scroll_pane"
"naked_scroll_pane"
"equipment_grid_scroll_pane"
"horizontally_limited_equipment_grid_scroll_pane"
"bonus_list_scroll_pane"
"text_holding_scroll_pane"
"market_scroll_pane"
"inner_frame_scroll_pane"
"achievement_image"
"browse_games_gui_favorites_header_image"
"map_info_image"
"new_game_info_image"
"mod_thumbnail_image"
"mod_updates_status_image"
"install_mod_status_image"
"tips_and_tricks_image"
"status_image"
"tips_and_tricks_simulation"
"entity_button_base"
"wide_entity_button"
"train_stop_entity_button"
"character_gui_entity_button"
"draggable_space_in_train_schedule"
"draggable_space_in_temporary_train_station"
"fulfilled_draggable_space_in_train_schedule"
"color_indicator"
"locomotive_minimap_widget"
"blueprint_preview"
"horizontal_slots_filler"
"vertical_lines_slots_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_with_no_left_margin"
"draggable_space_with_no_right_margin"
"draggable_space_in_shortcut_list"
"fake_slot"
"changelog_tabbed_pane"
"production_gui_tabbed_pane"
"filter_tabbed_pane"
"vehicle_tabbed_pane"
"vehicle_tabbed_pane_with_logistics"
"frame_tabbed_pane"
"deconstruction_planner_tabbed_pane"
"logistic_gui_tabbed_pane"
"tabbed_pane_with_no_side_padding"
"tabbed_pane_with_no_side_padding_and_tabs_hidden"
"tabbed_pane_with_extra_padding"
"frame_tab"
"filter_group_tab"
"slightly_smaller_tab"
"production_graph"
</pre></div>
 
== Optional properties ==
 
{{Prototype property|default_tileset|[[Types/FileName|FileName]]|""}}
 
{{Prototype property|default_sprite_scale|[[Types/double|double]]|1}}
 
{{Prototype property|default_sprite_priority|[[Types/SpritePriority|SpritePriority]]|"medium"}}

Latest revision as of 14:32, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/GuiStyle.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/GuiStyle&oldid=202911"