Prototype/UtilityConstants: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.17.72)
(0.18.14)
Line 23: Line 23:
{{Prototype property/short|ghost_tint|[[Types/Color|Color]]}}
{{Prototype property/short|ghost_tint|[[Types/Color|Color]]}}
{{Prototype property/short|tile_ghost_tint|[[Types/Color|Color]]}}
{{Prototype property/short|tile_ghost_tint|[[Types/Color|Color]]}}
{{Prototype property/short|equipment_default_background_color|[[Types/Color|Color]]}}
{{Prototype property/short|weapon_equipment_default_background_color|[[Types/Color|Color]]}}
{{Prototype property/short|turret_range_visualization_color|[[Types/Color|Color]]}}
{{Prototype property/short|turret_range_visualization_color|[[Types/Color|Color]]}}
{{Prototype property/short|capsule_range_visualization_color|[[Types/Color|Color]]}}
{{Prototype property/short|capsule_range_visualization_color|[[Types/Color|Color]]}}
** artillery_range_visualization_color - [[Types/Color|Color]]
{{Prototype property/short|artillery_range_visualization_color|[[Types/Color|Color]]}}
{{Prototype property/short|chart|[[Types/table|table]]}} - Table with the following key/value pairs. Note: Chart = map + minimap.
{{Prototype property/short|chart|[[Types/table|table]]}} - Table with the following key/value pairs. Note: Chart = map + minimap.
** electric_lines_color - [[Types/Color|Color]]
** electric_lines_color - [[Types/Color|Color]]
Line 42: Line 44:
** vehicle_outer_color_selected - [[Types/Color|Color]]
** vehicle_outer_color_selected - [[Types/Color|Color]]
** vehicle_inner_color - [[Types/Color|Color]]
** vehicle_inner_color - [[Types/Color|Color]]
** vehicle_cargo_wagon_color - [[Types/Color|Color]]
** vehicle_fluid_wagon_color - [[Types/Color|Color]]
** vehicle_wagon_connection_color - [[Types/Color|Color]]
** vehicle_wagon_connection_color - [[Types/Color|Color]]
** resource_outline_selection_color - [[Types/Color|Color]]
** resource_outline_selection_color - [[Types/Color|Color]]
** chart_train_stop_text_color - [[Types/Color|Color]]
** chart_train_stop_disabled_text_color - [[Types/Color|Color]]
** chart_train_stop_disabled_text_color - [[Types/Color|Color]]
** red_signal_color - [[Types/Color|Color]]
** red_signal_color - [[Types/Color|Color]]
Line 64: Line 65:
{{Prototype property/short|deconstruct_mark_tint|[[Types/Color|Color]]}}
{{Prototype property/short|deconstruct_mark_tint|[[Types/Color|Color]]}}
{{Prototype property/short|zoom_to_world_can_use_nightvision|[[Types/bool|bool]]}}
{{Prototype property/short|zoom_to_world_can_use_nightvision|[[Types/bool|bool]]}}
{{Prototype property/short|zoom_to_world_darkness_multiplier|[[Types/float|float]]}}
{{Prototype property/short|zoom_to_world_effect_strength|[[Types/float|float]]}}
{{Prototype property/short|zoom_to_world_effect_strength|[[Types/float|float]]}}
{{Prototype property/short|max_terrain_building_size|[[Types/uint8|uint8]]}}
{{Prototype property/short|max_terrain_building_size|[[Types/uint8|uint8]]}}
{{Prototype property/short|enabled_recipe_slot_tint|[[Types/Color|Color]]}}
{{Prototype property/short|enabled_recipe_slot_tint|[[Types/Color|Color]]}}
{{Prototype property/short|disabled_recipe_slot_tint|[[Types/Color|Color]]}}
{{Prototype property/short|disabled_recipe_slot_tint|[[Types/Color|Color]]}}
{{Prototype property/short|forced_enabled_recipe_slot_tint|[[Types/Color|Color]]}}
{{Prototype property/short|disabled_recipe_slot_background_tint|[[Types/Color|Color]]}}
{{Prototype property/short|forced_enabled_recipe_slot_background_tint|[[Types/Color|Color]]}}
{{Prototype property/short|rail_segment_colors|[[Types/table|table]] (array) of [[Types/Color|Color]]}}
{{Prototype property/short|rail_segment_colors|[[Types/table|table]] (array) of [[Types/Color|Color]]}}
{{Prototype property/short|player_colors|[[Types/table|table]] (array) of [[Types/table|table]]s}} The inner tables have the following key/value pairs. The table with name = default must exist and be the first member of the array.
{{Prototype property/short|player_colors|[[Types/table|table]] (array) of [[Types/table|table]]s}} - The inner tables have the following key/value pairs. The table with name = default must exist and be the first member of the array.
** name - [[Types/string|string]]
** name - [[Types/string|string]]
** player_color - [[Types/Color|Color]]
** player_color - [[Types/Color|Color]]
Line 80: Line 81:
{{Prototype property/short|default_alert_icon_shift_by_type|[[Types/table|table]] (array) of [[Types/string|string]] to [[Types/vector|vector]]|optional=true}}
{{Prototype property/short|default_alert_icon_shift_by_type|[[Types/table|table]] (array) of [[Types/string|string]] to [[Types/vector|vector]]|optional=true}}
{{Prototype property/short|default_alert_icon_scale_by_type|[[Types/table|table]] (array) of [[Types/string|string]] to [[Types/float|float]]|optional=true}}
{{Prototype property/short|default_alert_icon_scale_by_type|[[Types/table|table]] (array) of [[Types/string|string]] to [[Types/float|float]]|optional=true}}
{{Prototype property/short|daytime_color_lookup|[[Types/table|table]] (array)}} - First array member must be a [[Types/double|double]], second array member must be a [[Types/FileName|FileName]] or "identity". The file pointed to by the filename must be a sprite of size 16x16.
{{Prototype property/short|zoom_to_world_daytime_color_lookup|[[Types/table|table]] (array)}} - First array member must be a [[Types/double|double]], second array member must be a [[Types/FileName|FileName]] or "identity". The file pointed to by the filename must be a sprite of size 16x16.
{{Prototype property/short|item_outline_color|[[Types/Color|Color]]}}
{{Prototype property/short|item_outline_color|[[Types/Color|Color]]}}
{{Prototype property/short|item_outline_radius|[[Types/float|float]]}}
{{Prototype property/short|item_outline_radius|[[Types/float|float]]}}
Line 95: Line 98:
{{Prototype property/short|train_time_wait_condition_default|[[Types/uint32|uint32]]}}
{{Prototype property/short|train_time_wait_condition_default|[[Types/uint32|uint32]]}}
{{Prototype property/short|train_inactivity_wait_condition_default|[[Types/uint32|uint32]]}}
{{Prototype property/short|train_inactivity_wait_condition_default|[[Types/uint32|uint32]]}}
{{Prototype property/short|default_trigger_target_mask_by_type|[[Types/table|table]] (array) of [[Types/string|string]] to [[Types/TriggerTargetMask|TriggerTargetMask]]|optional=true}} The strings are entity types.
{{Prototype property/short|default_trigger_target_mask_by_type|[[Types/table|table]] (array) of [[Types/string|string]] to [[Types/TriggerTargetMask|TriggerTargetMask]]|optional=true}} - The strings are entity types.
{{Prototype property/short|unit_group_collision_mask|[[Types/CollisionMask|CollisionMask]]}}
{{Prototype property/short|unit_group_pathfind_resolution|[[Types/int8|int8]]}}
{{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_speed_far|[[Types/vector|vector]]}}
{{Prototype property/short|tree_leaf_distortion_strength_near|[[Types/vector|vector]]}}
{{Prototype property/short|tree_leaf_distortion_distortion_near|[[Types/vector|vector]]}}
{{Prototype property/short|tree_leaf_distortion_speed_near|[[Types/vector|vector]]}}
{{Prototype property/short|tree_shadow_roughness|[[Types/float|float]]}}
{{Prototype property/short|tree_shadow_speed|[[Types/float|float]]}}
{{Prototype property/short|missing_preview_sprite_location|[[Types/FileName|FileName]]}}
{{Prototype property/short|main_menu_background_image_location|[[Types/FileName|FileName]]}}
{{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 123: Line 138:
** clone_editor_copy_destination_allowed_color - [[Types/Color|Color]]
** clone_editor_copy_destination_allowed_color - [[Types/Color|Color]]
** clone_editor_copy_destination_not_allowed_color - [[Types/Color|Color]]
** clone_editor_copy_destination_not_allowed_color - [[Types/Color|Color]]
** clone_editor_brush_source_color - [[Types/Color|Color]]
** clone_editor_brush_destination_color - [[Types/Color|Color]]
** clone_editor_brush_cursor_preview_tint - [[Types/Color|Color]]
** clone_editor_brush_world_preview_tint - [[Types/Color|Color]]
** script_editor_select_area_color - [[Types/Color|Color]]
** script_editor_select_area_color - [[Types/Color|Color]]
** script_editor_drag_area_color - [[Types/Color|Color]]
** script_editor_drag_area_color - [[Types/Color|Color]]
Line 128: Line 147:
** cliff_editor_remove_cliffs_color - [[Types/Color|Color]]
** cliff_editor_remove_cliffs_color - [[Types/Color|Color]]
** tile_editor_selection_preview_tint - [[Types/Color|Color]]
** tile_editor_selection_preview_tint - [[Types/Color|Color]]
** tile_editor_area_selection_color - [[Types/Color|Color]]
** decorative_editor_selection_preview_tint - [[Types/Color|Color]]
** decorative_editor_selection_preview_tint - [[Types/Color|Color]]
** tile_editor_selection_preview_radius - [[Types/uint8|uint8]]
** tile_editor_selection_preview_radius - [[Types/uint8|uint8]]

Revision as of 19:23, 19 March 2020

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.


Prototype/UtilityConstants — utility-constants
artillery_range_visualization_color::Color
bonus_gui_ordering::table
building_buildable_tint::Color
building_buildable_too_far_tint::Color
building_ignorable_tint::Color
building_no_tint::Color
building_not_buildable_tint::Color
capsule_range_visualization_color::Color
chart::table
checkerboard_black::Color
checkerboard_white::Color
clipboard_history_size::uint32
color_filters::table (array) of tables
count_button_size::int
daytime_color_lookup::DaytimeColorLookupTable
deconstruct_mark_tint::Color
default_alert_icon_scale::float
default_enemy_force_color::Color
default_other_force_color::Color
default_player_force_color::Color
default_scorch_mark_color::Color
disabled_recipe_slot_background_tint::Color
disabled_recipe_slot_tint::Color
dynamic_recipe_overload_factor::double
enabled_recipe_slot_tint::Color
entity_button_background_color::Color
entity_renderer_search_box_limits::table
equipment_default_background_border_color::Color
equipment_default_background_color::Color
equipment_default_grabbed_background_color::Color
filter_outline_color::Color
flying_text_ttl::uint32
forced_enabled_recipe_slot_background_tint::Color
ghost_tint::Color
gui_remark_color::Color
icon_shadow_color::Color
icon_shadow_inset::float
icon_shadow_radius::float
icon_shadow_sharpness::float
inventory_width::uint32
item_outline_color::Color
item_outline_inset::float
item_outline_radius::float
item_outline_sharpness::float
light_renderer_search_distance_limit::uint8
main_menu_background_image_location::FileName
main_menu_background_vignette_intensity::float
main_menu_background_vignette_sharpness::float
main_menu_simulations::table of string to SimulationDefinition
manual_rail_building_reach_modifier::double
map_editor::table
max_terrain_building_size::uint8
maximum_recipe_overload_multiplier::uint32
medium_area_size::float
medium_blueprint_area_size::float
minimum_recipe_overload_multiplier::uint32
missing_preview_sprite_location::FileName
module_inventory_width::uint32
normalised_achievement_icon_size::uint32
player_colors::table (array) of tables
rail_planner_count_button_color::Color
rail_segment_colors::table (array) of Color
recipe_step_limit::uint32
script_command_console_chat_color::Color
select_group_row_count::uint32
select_slot_row_count::uint32
server_command_console_chat_color::Color
small_area_size::float
small_blueprint_area_size::float
tile_ghost_tint::Color
tooltip_monitor_edge_border::int32
train_button_hovered_tint::Color
train_destination_full_color::Color
train_inactivity_wait_condition_default::uint32
train_no_path_color::Color
train_path_finding::table
train_temporary_stop_wait_time::uint32
train_time_wait_condition_default::uint32
tree_leaf_distortion_distortion_far::vector
tree_leaf_distortion_distortion_near::vector
tree_leaf_distortion_speed_far::vector
tree_leaf_distortion_speed_near::vector
tree_leaf_distortion_strength_far::vector
tree_leaf_distortion_strength_near::vector
tree_shadow_roughness::float
tree_shadow_speed::float
turret_range_visualization_color::Color
tutorial_notice_icon_size::uint32
unit_group_max_pursue_distance::double
unit_group_pathfind_resolution::int8
zoom_to_world_can_use_nightvision::bool
zoom_to_world_daytime_color_lookup::DaytimeColorLookupTable
zoom_to_world_effect_strength::float
default_alert_icon_scale_by_type::table of string to float (optional)
default_alert_icon_shift_by_type::table of string to vector (optional)
default_trigger_target_mask_by_type::table of string to TriggerTargetMask (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

General mandatory properties

type

Type: string
Must be "utility-constants".

name

Type: string
The base uses "default" and only one instance of UtilityConstants can be defined, so unless the base game definition is completely removed, name will have to be "default".

The constants

Every property is mandatory if not listed otherwise.

  • entity_button_background_color - 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
  • weapon_equipment_default_background_color - Color
  • turret_range_visualization_color - Color
  • capsule_range_visualization_color - Color
  • artillery_range_visualization_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
    • default_friendly_color - Color
    • default_enemy_color - Color
    • rail_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
    • red_signal_color - Color
    • green_signal_color - Color
    • blue_signal_color - Color
    • yellow_signal_color - Color
    • default_friendly_color_by_type - table (array) of string to Color - Optional. The strings are entity types.
    • default_color_by_type - table (array) 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
    • custom_tag_scale - float - Optional. Default 0.6
    • custom_tag_selected_overlay_tint - Color
  • default_player_force_color - Color
  • default_enemy_force_color - Color
  • default_other_force_color - Color
  • deconstruct_mark_tint - Color
  • zoom_to_world_can_use_nightvision - bool
  • zoom_to_world_effect_strength - float
  • max_terrain_building_size - uint8
  • 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 (array) of string to vector - Optional.
  • default_alert_icon_scale_by_type - table (array) of string to float - Optional.
  • daytime_color_lookup - table (array) - First array member must be a double, second array member must be a FileName or "identity". The file pointed to by the filename must be a sprite of size 16x16.
  • zoom_to_world_daytime_color_lookup - table (array) - First array member must be a double, second array member must be a FileName or "identity". The file pointed to by the filename must be a sprite of size 16x16.
  • 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 (array) of string to TriggerTargetMask - Optional. - The strings are entity types.
  • unit_group_collision_mask - CollisionMask
  • unit_group_pathfind_resolution - int8
  • 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
  • main_menu_background_image_location - FileName
  • 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
  • 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
  • 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.
    • left - uint8 - Min value 6, max value 15 - Min value 6 to compensate for shadows
    • top - uint8 - Min value 3, max value 15
    • right - uint8 - Min value 3, max value 15
    • bottom - uint8 - Min value 4, max value 15 - Min value 4 to compensate for tall entities like electric poles
  • 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).