Prototype/GuiStyle: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Listed mandatory styles)
(Removed old prototype docs)
Tag: Replaced
 
(13 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 instances 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]]. 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"
"red_icon_button"
"tool_button"
"mini_button"
"highlighted_tool_button"
"icon_back_button"
"confirm_in_load_game_button"
"back_button"
"forward_button"
"menu_button"
"side_menu_button"
"map_view_options_button"
"dialog_button"
"control_settings_button"
"control_settings_section_button"
"quick_bar_page_button"
"quick_bar_slot_button"
"shortcut_bar_button"
"shortcut_bar_button_blue"
"shortcut_bar_button_red"
"shortcut_bar_button_green"
"shortcut_bar_button_small"
"red_slot_button"
"small_slot_button"
"recipe_slot_button"
"tracking_on_button"
"tracking_off_button"
"blueprint_record_slot_button"
"search_button"
"edit_label_button"
"selected_slot_button"
"slot_with_filter_button"
"not_available_slot_button"
"overloaded_crafting_machine_slot_button"
"circuit_condition_sign_button"
"working_weapon_button"
"not_working_weapon_button"
"technology_description_slot"
"close_button"
"train_schedule_action_button"
"train_schedule_delete_button"
"shortcut_bar_expand_button"
"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"
"search_mods_button"
"omitted_technology_slot"
"crafting_queue_slot"
"promised_crafting_queue_slot"
"partially_promised_crafting_queue_slot"
"image_tab_slot"
"image_tab_selected_slot"
"logistic_button_slot"
"logistic_button_selected_slot"
"red_circuit_network_content_slot"
"green_circuit_network_content_slot"
"drop_target_button"
"play_tutorial_button"
"play_completed_tutorial_button"
"play_locked_tutorial_button"
"locomotive_minimap_button"
"browse_games_gui_toggle_favorite_on_button"
"browse_games_gui_toggle_favorite_off_button"
"research_queue_cancel_button"
"mod_updates_available_list_box_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"
"inline_icon_slot"
"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"
"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"
"train_station_schedule_list_box"
"schedule_in_train_view_list_box"
"permissions_groups_list_box"
"permissions_players_list_box"
"logistic_networks_dropdown"
"big_dropdown"
"map_settings_dropdown"
"locale_dropdown"
"circuit_condition_comparator_dropdown"
"changelog_dropdown"
"changelog_textbox"
"console_input_textfield"
"info_box_textbox"
"invalid_value_textfield"
"map_generator_preset_description"
"mod_startup_settings_mismatch_notice_box"
"notice_textbox"
"long_number_textfield"
"reader_textbox"
"search_textfield_with_fixed_width"
"number_input_textbox"
"other_settings_gui_textbox"
"short_number_textfield"
"slider_value_textfield"
"wide_slider_value_textfield"
"stretchable_textfield"
"frame_without_footer"
"frame_with_even_paddings"
"dialog_frame"
"dialog_frame_no_header_filler"
"map_details_frame"
"bordered_frame"
"inner_frame"
"inner_frame_in_outer_frame"
"inside_deep_frame"
"inside_deep_frame_for_tabs"
"machine_frame"
"outer_frame"
"outer_frame_without_shadow"
"tooltip_frame"
"tooltip_generated_from_description_frame"
"naked_frame"
"goal_frame"
"image_frame"
"tips_frame"
"tutorial_list_frame"
"unlocked_tutorial_card_frame"
"completed_tutorial_card_frame"
"locked_tutorial_card_frame"
"menu_frame"
"frame_in_right_container"
"entity_info_frame"
"entity_info_frame_on_cursor"
"quick_bar_window_frame"
"shortcut_bar_window_frame"
"quick_bar_inner_panel"
"shortcut_bar_inner_panel"
"quick_bar_naked_frame"
"tool_bar_frame"
"subfooter_frame"
"subfooter_frame_with_left_edge"
"right_container_frame"
"right_bottom_container_frame"
"minimap_frame"
"side_menu_frame"
"map_view_options_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"
"featured_technology_slot_frame"
"research_queue_inner_frame"
"research_queue_border"
"a_inner_frame"
"a_inner_paddingless_frame"
"a_inner_frame_for_subheader_with_paddings"
"b_inner_frame_for_subheader_with_paddings"
"connect_gui_frame"
"subheader_frame"
"slot_group_frame"
"window_content_frame"
"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_inset_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"
"modern_tooltip_frame"
"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"
"rename_train_stop_frame"
"circuit_buttons_in_frame_title_flow"
"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"
"save_as_horizontal_flow"
"train_schedule_mode_switch_horizontal_flow"
"mods_gui_left_pane_vertical_flow"
"mods_gui_right_pane_vertical_flow"
"machine_right_part_vertical_flow"
"description_vertical_flow"
"slot_table_spacing_vertical_flow"
"table_spacing_vertical_flow"
"mod_dependency_vertical_flow"
"mod_info_vertical_flow"
"achievements_vertical_flow"
"tracked_achievements_vertical_flow"
"blueprint_shelf_flow"
"goal_holder_vertical_flow"
"browse_games_right_part_vertical_flow"
"technology_card"
"technology_list_container"
"packed_vertical_flow"
"packed_padded_vertical_flow"
"shortcut_bar_column"
"quickbar_holder_flow"
"featured_technology_effects_flow"
"technology_tooltip_effects_flow"
"centering_flow"
"changelog_subheader_space"
"bordered_table"
"electric_network_sections_table"
"label_table"
"slot_table"
"browse_games_table"
"browse_games_on_lan_table"
"mods_table"
"technology_slot_table"
"featured_technology_table"
"featured_technology_inner_table"
"research_progress_technology_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"
"multiplayer_activity_bar"
"info_box_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_in_description_progressbar"
"achievement_progressbar"
"achievement_card_progressbar"
"achievement_pinned_card_progressbar"
"info_box_progressbar"
"research_progressbar"
"caption_checkbox"
"map_gen_row_label"
"caption_label"
"large_caption_label"
"invalid_label"
"bold_label"
"hoverable_bold_label"
"bold_green_label"
"bold_red_label"
"bold_clickable_red_label"
"goal_label"
"tutorial_list_description_label"
"tutorial_title_label"
"tutorial_locked_title_label"
"tutorial_completed_title_label"
"tutorial_description_label"
"tutorial_notice_title_label"
"tutorial_notice_name_label"
"tutorial_notice_label"
"electric_usage_label"
"mod_dependency_invalid_label"
"mod_optional_dependency_invalid_label"
"mod_manager_label"
"description_title_label"
"count_label"
"description_label"
"description_value_label"
"description_remark_label"
"tool_equip_gui_label"
"tooltip_label"
"tooltip_title_label"
"recipe_tooltip_cannot_craft_label"
"recipe_tooltip_transitive_craft_label"
"subheader_caption_label"
"heading_1_label"
"heading_2_label"
"heading_3_label"
"heading_3_label_yellow"
"mod_list_label"
"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"
"installed_mod_label"
"downloading_mod_label"
"to_be_downloaded_mod_label"
"out_of_date_mod_label"
"incompatible_mod_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"
"mod_invalid_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"
"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"
"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"
"shortcut_bar_name_label"
"blurry_panel_horizontal_line"
"dark_line"
"frame_division_fake_horizontal_line"
"scroll_pane_light"
"tab_scroll_pane"
"browse_games_scroll_pane"
"browse_mods_scroll_pane"
"machine_ingredients_scroll_pane"
"machine_outputs_scroll_pane"
"module_inventory_scroll_pane"
"trash_slots_scroll_pane"
"logistic_gui_scroll_pane"
"technology_list_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"
"removed_content_scroll_pane"
"changelog_scroll_pane"
"shortcut_bar_selection_scroll_pane"
"only_inner_shadow_scroll_pane"
"tutorial_icon_image"
"achievement_image"
"browse_games_gui_favorites_header_image"
"map_info_image"
"mod_thumbnail_image"
"mod_updates_status_image"
"install_mod_status_image"
"entity_button_base"
"battery_widget"
"draggable_space_in_train_schedule"
"draggable_space_in_temporary_train_station"
"fulfilled_draggable_space_in_train_schedule"
"color_indicator"
"locomotive_minimap_widget"
"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"
"blueprint_drop_slot_button"
"draggable_space"
"draggable_space_with_no_left_margin"
"draggable_space_in_shortcut_list"
"changelog_tabbed_pane"
</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/string|string]]|"medium"}}
Possible values:
* "extra-high-no-scale"
* "extra-high"
* "high"
* "medium"
* "low"
* "very-low"

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.