Prototype/UtilityConstants: Difference between revisions
Jump to navigation
Jump to search
(1.1) |
(Updated styling of prototype doc migration note) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<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/UtilityConstants.html https://lua-api.factorio.com/latest/prototypes/UtilityConstants.html] | |||
</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> | |||
{{Prototype parent|PrototypeBase}} | {{Prototype parent|PrototypeBase}} | ||
Constants used by the game that are not specific to certain prototypes. See [https://github.com/wube/factorio-data/blob/master/core/prototypes/utility-constants.lua utility-constants.lua] for the values used by the base game. | Constants used by the game that are not specific to certain prototypes. See [https://github.com/wube/factorio-data/blob/master/core/prototypes/utility-constants.lua utility-constants.lua] for the values used by the base game. | ||
Line 35: | Line 41: | ||
** turret_range_color - [[Types/Color|Color]] | ** turret_range_color - [[Types/Color|Color]] | ||
** artillery_range_color - [[Types/Color|Color]] | ** artillery_range_color - [[Types/Color|Color]] | ||
** pollution_color - [[Types/Color|Color]] | |||
** default_friendly_color - [[Types/Color|Color]] | ** default_friendly_color - [[Types/Color|Color]] | ||
** default_enemy_color - [[Types/Color|Color]] | ** default_enemy_color - [[Types/Color|Color]] | ||
Line 58: | Line 65: | ||
** train_preview_path_outline_color - [[Types/Color|Color]] | ** train_preview_path_outline_color - [[Types/Color|Color]] | ||
** train_current_path_outline_color - [[Types/Color|Color]] | ** train_current_path_outline_color - [[Types/Color|Color]] | ||
** chart_logistic_robot_color - [[Types/Color|Color]] | |||
** chart_construction_robot_color - [[Types/Color|Color]] | |||
** chart_mobile_construction_robot_color - [[Types/Color|Color]] | |||
** chart_personal_construction_robot_color - [[Types/Color|Color]] | |||
** zoom_threshold_to_draw_spider_path - [[Types/double|double]] - Optional. Default 0.5 | |||
** custom_tag_scale - [[Types/float|float]] - Optional. Default 0.6 | ** custom_tag_scale - [[Types/float|float]] - Optional. Default 0.6 | ||
** custom_tag_selected_overlay_tint - [[Types/Color|Color]] | ** custom_tag_selected_overlay_tint - [[Types/Color|Color]] | ||
{{Prototype property/short|gui_remark_color|[[Types/Color|Color]]}} | |||
{{Prototype property/short|default_player_force_color|[[Types/Color|Color]]}} | {{Prototype property/short|default_player_force_color|[[Types/Color|Color]]}} | ||
{{Prototype property/short|default_enemy_force_color|[[Types/Color|Color]]}} | {{Prototype property/short|default_enemy_force_color|[[Types/Color|Color]]}} | ||
Line 109: | Line 122: | ||
{{Prototype property/short|unit_group_pathfind_resolution|[[Types/int8|int8]]}} | {{Prototype property/short|unit_group_pathfind_resolution|[[Types/int8|int8]]}} | ||
{{Prototype property/short|unit_group_max_pursue_distance|[[Types/double|double]]}} | {{Prototype property/short|unit_group_max_pursue_distance|[[Types/double|double]]}} | ||
{{Prototype property/short|dynamic_recipe_overload_factor|[[Types/double|double]]}} | |||
{{Prototype property/short|minimum_recipe_overload_multiplier|[[Types/uint32|uint32]]}} | |||
{{Prototype property/short|maximum_recipe_overload_multiplier|[[Types/uint32|uint32]]}} | |||
{{Prototype property/short|tree_leaf_distortion_strength_far|[[Types/vector|vector]]}} | {{Prototype property/short|tree_leaf_distortion_strength_far|[[Types/vector|vector]]}} | ||
{{Prototype property/short|tree_leaf_distortion_distortion_far|[[Types/vector|vector]]}} | {{Prototype property/short|tree_leaf_distortion_distortion_far|[[Types/vector|vector]]}} | ||
Line 124: | Line 140: | ||
{{Prototype property/short|default_scorch_mark_color|[[Types/Color|Color]]}} | {{Prototype property/short|default_scorch_mark_color|[[Types/Color|Color]]}} | ||
{{Prototype property/short|train_button_hovered_tint|[[Types/Color|Color]]}} | {{Prototype property/short|train_button_hovered_tint|[[Types/Color|Color]]}} | ||
{{Prototype property/short|select_group_row_count|[[Types/uint32|uint32]]}} - Must be in range [1, 100]. | |||
{{Prototype property/short|select_slot_row_count|[[Types/uint32|uint32]]}} - Must be in range [1, 100]. | |||
{{Prototype property/short|inventory_width|[[Types/uint32|uint32]]}} - Must be in range [1, 100]. | |||
{{Prototype property/short|module_inventory_width|[[Types/uint32|uint32]]}} - Must be in range [1, 100]. | |||
{{Prototype property/short|tooltip_monitor_edge_border|[[Types/int32|int32]]}} - Must be >= 1. | |||
{{Prototype property/short|normalised_achievement_icon_size|[[Types/uint32|uint32]]}} - Must be >= 1. | |||
{{Prototype property/short|tutorial_notice_icon_size|[[Types/uint32|uint32]]}} - Must be >= 1. | |||
{{Prototype property/short|flying_text_ttl|[[Types/uint32|uint32]]}} - Must be >= 1. | |||
{{Prototype property/short|bonus_gui_ordering|[[Types/table|table]]}} - Table with the following key/value pairs. Note that the base game uses more entries here [https://github.com/wube/factorio-data/blob/master/base/prototypes/categories/ammo-category.lua#L72-L76 that are applied via the ammo categories]. | {{Prototype property/short|bonus_gui_ordering|[[Types/table|table]]}} - Table with the following key/value pairs. Note that the base game uses more entries here [https://github.com/wube/factorio-data/blob/master/base/prototypes/categories/ammo-category.lua#L72-L76 that are applied via the ammo categories]. | ||
** artillery_range - [[Types/Order|Order]] | ** artillery_range - [[Types/Order|Order]] | ||
Line 147: | Line 171: | ||
** train_waiting_at_signal_tick_multiplier_penalty - [[Types/float|float]] - Must be >= 0. | ** train_waiting_at_signal_tick_multiplier_penalty - [[Types/float|float]] - Must be >= 0. | ||
** train_with_no_path_penalty - [[Types/uint32|uint32]] | ** train_with_no_path_penalty - [[Types/uint32|uint32]] | ||
** train_auto_without_schedule_penalty - [[Types/uint32|uint32]] | |||
{{Prototype property/short|map_editor|[[Types/table|table]]}} - Table with the following key/value pairs. | {{Prototype property/short|map_editor|[[Types/table|table]]}} - Table with the following key/value pairs. | ||
** clone_editor_copy_source_color - [[Types/Color|Color]] | ** clone_editor_copy_source_color - [[Types/Color|Color]] |
Latest revision as of 10:43, 21 September 2023
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/UtilityConstants.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.
Prototype definitions » PrototypeBase » Prototype/UtilityConstants
Constants used by the game that are not specific to certain prototypes. See utility-constants.lua for the values used by the base game.
Properties
Inherits all properties from PrototypeBase.
Every property is mandatory if not listed otherwise.
- Color -
- building_buildable_too_far_tint - Color
- building_buildable_tint - Color
- building_not_buildable_tint - Color
- building_ignorable_tint - Color
- building_no_tint - Color
- ghost_tint - Color
- tile_ghost_tint - Color
- equipment_default_background_color - Color
- equipment_default_background_border_color - Color
- equipment_default_grabbed_background_color - Color
- turret_range_visualization_color - Color
- capsule_range_visualization_color - Color
- artillery_range_visualization_color - Color
- train_no_path_color - Color
- train_destination_full_color - Color
- chart - table - Table with the following key/value pairs. Note: Chart = map + minimap.
- electric_lines_color - Color
- electric_lines_color_switch_enabled - Color
- electric_lines_color_switch_disabled - Color
- electric_power_pole_color - Color
- switch_color - Color
- electric_line_width - double
- electric_line_minimum_absolute_width - double
- turret_range_color - Color
- artillery_range_color - Color
- pollution_color - Color
- default_friendly_color - Color
- default_enemy_color - Color
- rail_color - Color
- entity_ghost_color - Color
- vehicle_outer_color - Color
- vehicle_outer_color_selected - Color
- vehicle_inner_color - Color
- vehicle_wagon_connection_color - Color
- resource_outline_selection_color - Color
- chart_train_stop_text_color - Color
- chart_train_stop_disabled_text_color - Color
- chart_train_stop_full_text_color - Color
- red_signal_color - Color
- green_signal_color - Color
- blue_signal_color - Color
- yellow_signal_color - Color
- chart_deconstruct_tint - Color
- default_friendly_color_by_type - table of string to Color - Optional. The strings are entity types.
- default_color_by_type - table of string to Color - Optional. The strings are entity types.
- explosion_visualization_duration - uint32
- train_path_color - Color
- train_preview_path_outline_color - Color
- train_current_path_outline_color - Color
- chart_logistic_robot_color - Color
- chart_construction_robot_color - Color
- chart_mobile_construction_robot_color - Color
- chart_personal_construction_robot_color - Color
- zoom_threshold_to_draw_spider_path - double - Optional. Default 0.5
- custom_tag_scale - float - Optional. Default 0.6
- custom_tag_selected_overlay_tint - Color
- gui_remark_color - Color
- default_player_force_color - Color
- default_enemy_force_color - Color
- default_other_force_color - Color
- deconstruct_mark_tint - Color
- Color -
- int -
- zoom_to_world_can_use_nightvision - bool
- zoom_to_world_effect_strength - float
- max_terrain_building_size - uint8
- small_area_size - float
- medium_area_size - float
- small_blueprint_area_size - float
- medium_blueprint_area_size - float
- enabled_recipe_slot_tint - Color
- disabled_recipe_slot_tint - Color
- disabled_recipe_slot_background_tint - Color
- forced_enabled_recipe_slot_background_tint - Color
- rail_segment_colors - table (array) of Color
- player_colors - table (array) of tables - The inner tables have the following key/value pairs. The table with name = default must exist and be the first member of the array.
- server_command_console_chat_color - Color
- script_command_console_chat_color - Color
- default_alert_icon_scale - float
- default_alert_icon_shift_by_type - table of string to vector - Optional.
- default_alert_icon_scale_by_type - table of string to float - Optional.
- daytime_color_lookup - DaytimeColorLookupTable
- zoom_to_world_daytime_color_lookup - DaytimeColorLookupTable
- checkerboard_white - Color
- checkerboard_black - Color
- item_outline_color - Color
- item_outline_radius - float
- item_outline_inset - float
- item_outline_sharpness - float
- filter_outline_color - Color
- icon_shadow_radius - float
- icon_shadow_inset - float
- icon_shadow_sharpness - float
- icon_shadow_color - Color
- clipboard_history_size - uint32
- recipe_step_limit - uint32
- manual_rail_building_reach_modifier - double
- train_temporary_stop_wait_time - uint32
- train_time_wait_condition_default - uint32
- train_inactivity_wait_condition_default - uint32
- default_trigger_target_mask_by_type - table of string to TriggerTargetMask - Optional. - The strings are entity types.
- unit_group_pathfind_resolution - int8
- unit_group_max_pursue_distance - double
- dynamic_recipe_overload_factor - double
- minimum_recipe_overload_multiplier - uint32
- maximum_recipe_overload_multiplier - uint32
- tree_leaf_distortion_strength_far - vector
- tree_leaf_distortion_distortion_far - vector
- tree_leaf_distortion_speed_far - vector
- tree_leaf_distortion_strength_near - vector
- tree_leaf_distortion_distortion_near - vector
- tree_leaf_distortion_speed_near - vector
- tree_shadow_roughness - float
- tree_shadow_speed - float
- missing_preview_sprite_location - FileName
- FileName -
- table of string to SimulationDefinition - The strings represent the names of the simulations. -
- float -
- float -
- default_scorch_mark_color - Color
- Color -
- select_group_row_count - uint32 - Must be in range [1, 100].
- select_slot_row_count - uint32 - Must be in range [1, 100].
- inventory_width - uint32 - Must be in range [1, 100].
- module_inventory_width - uint32 - Must be in range [1, 100].
- tooltip_monitor_edge_border - int32 - Must be >= 1.
- normalised_achievement_icon_size - uint32 - Must be >= 1.
- tutorial_notice_icon_size - uint32 - Must be >= 1.
- flying_text_ttl - uint32 - Must be >= 1.
- bonus_gui_ordering - table - Table with the following key/value pairs. Note that the base game uses more entries here that are applied via the ammo categories.
- train_path_finding - table - Table with the following key/value pairs.
- train_stop_penalty - uint32
- stopped_manually_controlled_train_penalty - uint32
- stopped_manually_controlled_train_without_passenger_penalty - uint32
- signal_reserved_by_circuit_network_penalty - uint32
- train_in_station_penalty - uint32
- train_in_station_with_no_other_valid_stops_in_schedule - uint32
- train_arriving_to_station_penalty - uint32
- train_arriving_to_signal_penalty - uint32
- train_waiting_at_signal_penalty - uint32
- train_waiting_at_signal_tick_multiplier_penalty - float - Must be >= 0.
- train_with_no_path_penalty - uint32
- train_auto_without_schedule_penalty - uint32
- map_editor - table - Table with the following key/value pairs.
- clone_editor_copy_source_color - Color
- clone_editor_copy_destination_allowed_color - Color
- clone_editor_copy_destination_not_allowed_color - Color
- clone_editor_brush_source_color - Color
- clone_editor_brush_destination_color - Color
- clone_editor_brush_cursor_preview_tint - Color
- clone_editor_brush_world_preview_tint - Color
- script_editor_select_area_color - Color
- script_editor_drag_area_color - Color
- force_editor_select_area_color - Color
- cliff_editor_remove_cliffs_color - Color
- tile_editor_selection_preview_tint - Color
- tile_editor_area_selection_color - Color
- decorative_editor_selection_preview_tint - Color
- tile_editor_selection_preview_radius - uint8
- decorative_editor_selection_preview_radius - uint8
- color_filters - table (array) of tables - The inner tables have the following key/value pairs.
- name - string
- localised_name - LocalisedString
- matrix - table (array) of table (arrays) of float - 4 arrays of 4-length float arrays, essentially a 4x4 matrix
- entity_renderer_search_box_limits - table - Table with the following key/value pairs. How far (in tiles) entities should be rendered outside the visible area of the screen.
- light_renderer_search_distance_limit - uint8 - Can be set to anything from range 0 to 255, but larger values will be clamped to 160. Setting it to larger values can have performance impact (growing geometrically).