Prototype/UtilityConstants

From Official Factorio Wiki
Revision as of 17:53, 16 August 2023 by BilkaBot (talk | contribs) (Protected "Prototype/UtilityConstants": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
Jump to navigation Jump to search

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.


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

Template:Prototype TOC

Properties

Inherits all properties from PrototypeBase.

Every property is mandatory if not listed otherwise.

Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short - 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

Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short - The inner tables have the following key/value pairs. The table with name = default must exist and be the first member of the array.

Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short - The strings are entity types. Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short - The strings represent the names of the simulations. Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short Template:Prototype property/short - Must be in range [1, 100]. Template:Prototype property/short - Must be in range [1, 100]. Template:Prototype property/short - Must be in range [1, 100]. Template:Prototype property/short - Must be in range [1, 100]. Template:Prototype property/short - Must be >= 1. Template:Prototype property/short - Must be >= 1. Template:Prototype property/short - Must be >= 1. Template:Prototype property/short - Must be >= 1. Template:Prototype property/short - Table with the following key/value pairs. Note that the base game uses more entries here that are applied via the ammo categories.

Template:Prototype property/short - 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

Template:Prototype property/short - 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

Template:Prototype property/short - The inner tables have the following key/value pairs.

Template:Prototype property/short - 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

Template:Prototype property/short - 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).