Prototype/UtilityConstants

Basics

Prototype type: utility-constants

Constants used by the game that are not specific to certain prototypes. See utility-constants.lua for the values used by the base game.

General mandatory properties

type

Type: Types/string

Must be "utility-constants".

name

Type: Types/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" - Types/Color
• "building_buildable_too_far_tint" - Types/Color
• "building_buildable_tint" - Types/Color
• "building_not_buildable_tint" - Types/Color
• "building_ignorable_tint" - Types/Color
• "building_no_tint" - Types/Color
• "ghost_tint" - Types/Color
• "turret_range_visualization_color" - Types/Color
• "capsule_range_visualization_color" - Types/Color
  • "artillery_range_visualization_color" - Types/Color
• "chart" - Types/table - Table with the following key/value pairs. Note: Chart = map + minimap.
  • "electric_lines_color" - Types/Color
  • "electric_lines_color_switch_enabled" - Types/Color
  • "electric_lines_color_switch_disabled" - Types/Color
  • "electric_power_pole_color" - Types/Color
  • "switch_color" - Types/Color
  • "electric_line_width" - Types/double
  • "electric_line_minimum_absolute_width" - Types/double
  • "turret_range_color" - Types/Color
  • "artillery_range_color" - Types/Color
  • "default_friendly_color" - Types/Color
  • "default_enemy_color" - Types/Color
  • "rail_color" - Types/Color
  • "vehicle_outer_color" - Types/Color
  • "vehicle_outer_color_selected" - Types/Color
  • "vehicle_inner_color" - Types/Color
  • "vehicle_cargo_wagon_color" - Types/Color
  • "vehicle_fluid_wagon_color" - Types/Color
  • "vehicle_wagon_connection_color" - Types/Color
  • "resource_outline_selection_color" - Types/Color
  • "chart_train_stop_disabled_text_color" - Types/Color
  • "red_signal_color" - Types/Color
  • "green_signal_color" - Types/Color
  • "blue_signal_color" - Types/Color
  • "yellow_signal_color" - Types/Color
  • "default_friendly_color_by_type" - Types/table (array) of Types/string to Types/Color - Optional. The strings are entity types.
  • "default_color_by_type" - Types/table (array) of Types/string to Types/Color - Optional. The strings are entity types.
  • "explosion_visualization_duration" - Types/uint32
  • "train_path_color" - Types/Color
  • "train_preview_path_outline_color" - Types/Color
  • "train_current_path_outline_color" - Types/Color
  • "custom_tag_scale" - Types/float - Optional. Default 0.6
  • "custom_tag_selected_overlay_tint" - Types/Color
• "default_player_force_color" - Types/Color
• "default_enemy_force_color" - Types/Color
• "default_other_force_color" - Types/Color
• "deconstruct_mark_tint" - Types/Color
• "zoom_to_world_can_use_nightvision" - Types/bool
• "zoom_to_world_darkness_multiplier" - Types/float
• "zoom_to_world_effect_strength" - Types/float
• "max_terrain_building_size" - Types/uint8
• "enabled_recipe_slot_tint" - Types/Color
• "disabled_recipe_slot_tint" - Types/Color
• "forced_enabled_recipe_slot_tint" - Types/Color
• "rail_segment_colors" - Types/table (array) of Types/Color
• "player_colors" - Types/table (array) of Types/tables with the following key/value pairs. The table with name = "default" must exist and be the first member of the array.
  • name - Types/string
  • player_color - Types/Color
  • chat_color - Types/Color
• "server_command_console_chat_color" - Types/Color
• "script_command_console_chat_color" - Types/Color
• "default_alert_icon_scale" - Types/float
• "default_alert_icon_shift_by_type" - Types/table (array) of Types/string to Types/vector - Optional.
• "default_alert_icon_scale_by_type" - Types/table (array) of Types/string to Types/float - Optional.
• "item_outline_color" - Types/Color
• "item_outline_radius" - Types/float
• "item_outline_inset" - Types/float
• "item_outline_sharpness" - Types/float
• "filter_outline_color" - Types/Color
• "icon_shadow_radius" - Types/float
• "icon_shadow_inset" - Types/float
• "icon_shadow_sharpness" - Types/float
• "icon_shadow_color" - Types/Color
• "clipboard_history_size" - Types/uint32
• "recipe_step_limit" - Types/uint32
• "manual_rail_building_reach_modifier" - Types/double
• "train_temporary_stop_wait_time" - Types/uint32
• "train_time_wait_condition_default" - Types/uint32
• "train_inactivity_wait_condition_default" - Types/uint32
• "default_trigger_target_mask_by_type" - Types/table (array) of Types/string to Types/TriggerTargetMask - Optional. The strings are entity types.
• "bonus_gui_ordering" - Types/table - Table with the following key/value pairs. Note that the base game uses more entries here that are applied via the ammo categories.
  • "artillery_range" - Types/Order
  • "worker_robots" - Types/Order
  • "character" - Types/Order
  • "follower_robots" - Types/Order
  • "research_speed" - Types/Order
  • "inserter" - Types/Order
  • "stack_inserter" - Types/Order
  • "turret_attack" - Types/Order
  • "mining_productivity" - Types/Order
  • "train_braking_force" - Types/Order
• "train_path_finding" - Types/table - Table with the following key/value pairs.
  • "train_stop_penalty" - Types/uint32
  • "stopped_manually_controlled_train_penalty" - Types/uint32
  • "stopped_manually_controlled_train_without_passenger_penalty" - Types/uint32
  • "signal_reserved_by_circuit_network_penalty" - Types/uint32
  • "train_in_station_penalty" - Types/uint32
  • "train_in_station_with_no_other_valid_stops_in_schedule" - Types/uint32
  • "train_arriving_to_station_penalty" - Types/uint32
  • "train_arriving_to_signal_penalty" - Types/uint32
  • "train_waiting_at_signal_penalty" - Types/uint32
  • "train_waiting_at_signal_tick_multiplier_penalty" - Types/float - Must be >= 0.
  • "train_with_no_path_penalty" - Types/uint32
• "map_editor" - Types/table - Table with the following key/value pairs.
  • "clone_editor_copy_source_color" - Types/Color
  • "clone_editor_copy_destination_allowed_color" - Types/Color
  • "clone_editor_copy_destination_not_allowed_color" - Types/Color
  • "script_editor_select_area_color" - Types/Color
  • "script_editor_drag_area_color" - Types/Color
  • "force_editor_select_area_color" - Types/Color
  • "cliff_editor_remove_cliffs_color" - Types/Color
  • "tile_editor_selection_preview_tint" - Types/Color
  • "decorative_editor_selection_preview_tint" - Types/Color
  • "tile_editor_selection_preview_radius" - Types/uint8
  • "decorative_editor_selection_preview_radius" - Types/uint8
• "entity_renderer_search_box_limits" - Types/table - Table with the following key/value pairs. How far (in tiles) entities should be rendered outside the visible area of the screen.
  • "left" - Types/uint8 - Min value 6, max value 15 - Min value 6 to compensate for shadows
  • "top" - Types/uint8 - Min value 3, max value 15
  • "right" - Types/uint8 - Min value 3, max value 15
  • "bottom" - Types/uint8 - Min value 4, max value 15 - Min value 4 to compensate for tall entities like electric poles