Prototype/UtilityConstants: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.18.22: default_scorch_mark_color)
(Removed old prototype docs)
Tag: Replaced
 
(11 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/UtilityConstants.html https://lua-api.factorio.com/latest/prototypes/UtilityConstants.html]
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.


{{Prototype TOC|utility-constants}}
</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>
 
== General mandatory properties ==
 
{{Prototype property|type|[[Types/string|string]]}}
Must be "utility-constants".
 
{{Prototype property|name|[[Types/string|string]]}}
The base uses <code>"default"</code> and only one instance of UtilityConstants can be defined, so unless the base game definition is completely removed, <code>name</code> will have to be <code>"default"</code>.
 
== The constants ==
Every property is mandatory if not listed otherwise.
 
{{Prototype property/short|entity_button_background_color|[[Types/Color|Color]]}}
{{Prototype property/short|building_buildable_too_far_tint|[[Types/Color|Color]]}}
{{Prototype property/short|building_buildable_tint|[[Types/Color|Color]]}}
{{Prototype property/short|building_not_buildable_tint|[[Types/Color|Color]]}}
{{Prototype property/short|building_ignorable_tint|[[Types/Color|Color]]}}
{{Prototype property/short|building_no_tint|[[Types/Color|Color]]}}
{{Prototype property/short|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|capsule_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.
** electric_lines_color - [[Types/Color|Color]]
** electric_lines_color_switch_enabled - [[Types/Color|Color]]
** electric_lines_color_switch_disabled - [[Types/Color|Color]]
** electric_power_pole_color - [[Types/Color|Color]]
** switch_color - [[Types/Color|Color]]
** electric_line_width - [[Types/double|double]]
** electric_line_minimum_absolute_width - [[Types/double|double]]
** turret_range_color - [[Types/Color|Color]]
** artillery_range_color - [[Types/Color|Color]]
** default_friendly_color - [[Types/Color|Color]]
** default_enemy_color - [[Types/Color|Color]]
** rail_color - [[Types/Color|Color]]
** vehicle_outer_color - [[Types/Color|Color]]
** vehicle_outer_color_selected - [[Types/Color|Color]]
** vehicle_inner_color - [[Types/Color|Color]]
** vehicle_wagon_connection_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]]
** red_signal_color - [[Types/Color|Color]]
** green_signal_color - [[Types/Color|Color]]
** blue_signal_color - [[Types/Color|Color]]
** yellow_signal_color - [[Types/Color|Color]]
** default_friendly_color_by_type - [[Types/table|table]] (array) of [[Types/string|string]] to [[Types/Color|Color]] - Optional. The strings are entity types.
** default_color_by_type - [[Types/table|table]] (array) of [[Types/string|string]] to [[Types/Color|Color]] - Optional. The strings are entity types.
** explosion_visualization_duration - [[Types/uint32|uint32]]
** train_path_color - [[Types/Color|Color]]
** train_preview_path_outline_color - [[Types/Color|Color]]
** train_current_path_outline_color - [[Types/Color|Color]]
** custom_tag_scale - [[Types/float|float]] - Optional. Default 0.6
** custom_tag_selected_overlay_tint - [[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_other_force_color|[[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_effect_strength|[[Types/float|float]]}}
{{Prototype property/short|max_terrain_building_size|[[Types/uint8|uint8]]}}
{{Prototype property/short|small_area_size|[[Types/float|float]]}}
{{Prototype property/short|medium_area_size|[[Types/float|float]]}}
{{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_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|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]]
** player_color - [[Types/Color|Color]]
** chat_color - [[Types/Color|Color]]
{{Prototype property/short|server_command_console_chat_color|[[Types/Color|Color]]}}
{{Prototype property/short|script_command_console_chat_color|[[Types/Color|Color]]}}
{{Prototype property/short|default_alert_icon_scale|[[Types/float|float]]}}
{{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|daytime_color_lookup|[[Types/DaytimeColorLookupTable|DaytimeColorLookupTable]]}}
{{Prototype property/short|zoom_to_world_daytime_color_lookup|[[Types/DaytimeColorLookupTable|DaytimeColorLookupTable]]}}
{{Prototype property/short|item_outline_color|[[Types/Color|Color]]}}
{{Prototype property/short|item_outline_radius|[[Types/float|float]]}}
{{Prototype property/short|item_outline_inset|[[Types/float|float]]}}
{{Prototype property/short|item_outline_sharpness|[[Types/float|float]]}}
{{Prototype property/short|filter_outline_color|[[Types/Color|Color]]}}
{{Prototype property/short|icon_shadow_radius|[[Types/float|float]]}}
{{Prototype property/short|icon_shadow_inset|[[Types/float|float]]}}
{{Prototype property/short|icon_shadow_sharpness|[[Types/float|float]]}}
{{Prototype property/short|icon_shadow_color|[[Types/Color|Color]]}}
{{Prototype property/short|clipboard_history_size|[[Types/uint32|uint32]]}}
{{Prototype property/short|recipe_step_limit|[[Types/uint32|uint32]]}}
{{Prototype property/short|manual_rail_building_reach_modifier|[[Types/double|double]]}}
{{Prototype property/short|train_temporary_stop_wait_time|[[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|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_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|default_scorch_mark_color|[[Types/Color|Color]]}}
{{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]]
** worker_robots - [[Types/Order|Order]]
** character - [[Types/Order|Order]]
** follower_robots - [[Types/Order|Order]]
** research_speed - [[Types/Order|Order]]
** inserter - [[Types/Order|Order]]
** stack_inserter - [[Types/Order|Order]]
** turret_attack - [[Types/Order|Order]]
** mining_productivity - [[Types/Order|Order]]
** train_braking_force - [[Types/Order|Order]]
{{Prototype property/short|train_path_finding|[[Types/table|table]]}} - Table with the following key/value pairs.
** train_stop_penalty - [[Types/uint32|uint32]]
** stopped_manually_controlled_train_penalty - [[Types/uint32|uint32]]
** stopped_manually_controlled_train_without_passenger_penalty - [[Types/uint32|uint32]]
** signal_reserved_by_circuit_network_penalty - [[Types/uint32|uint32]]
** train_in_station_penalty - [[Types/uint32|uint32]]
** train_in_station_with_no_other_valid_stops_in_schedule - [[Types/uint32|uint32]]
** train_arriving_to_station_penalty - [[Types/uint32|uint32]]
** train_arriving_to_signal_penalty - [[Types/uint32|uint32]]
** train_waiting_at_signal_penalty - [[Types/uint32|uint32]]
** train_waiting_at_signal_tick_multiplier_penalty - [[Types/float|float]] - Must be >= 0.
** train_with_no_path_penalty - [[Types/uint32|uint32]]
{{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_destination_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_drag_area_color - [[Types/Color|Color]]
** force_editor_select_area_color - [[Types/Color|Color]]
** cliff_editor_remove_cliffs_color - [[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]]
** tile_editor_selection_preview_radius - [[Types/uint8|uint8]]
** decorative_editor_selection_preview_radius - [[Types/uint8|uint8]]
{{Prototype property/short|entity_renderer_search_box_limits|[[Types/table|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|uint8]] - Min value 6, max value 15 - Min value 6 to compensate for shadows
** top - [[Types/uint8|uint8]] - Min value 3, max value 15
** right - [[Types/uint8|uint8]] - Min value 3, max value 15
** bottom - [[Types/uint8|uint8]] - Min value 4, max value 15 - Min value 4 to compensate for tall entities like electric poles
{{Prototype property/short|light_renderer_search_distance_limit|[[Types/uint8|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).

Latest revision as of 14:33, 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/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.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/UtilityConstants&oldid=203026"