Prototype/MapSettings - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:55Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:15Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''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/MapSettings.html https://lua-api.factorio.com/latest/prototypes/MapSettings.html]		<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/MapSettings.html https://lua-api.factorio.com/latest/prototypes/MapSettings.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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].		</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>

BilkaBot: Protected "Prototype/MapSettings": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:49Z

Protected "Prototype/MapSettings": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:52, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:52:49Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:52, 16 August 2023
Line 1:		Line 1:
			'''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/MapSettings.html https://lua-api.factorio.com/latest/prototypes/MapSettings.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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].



	{{Prototype parent}}		{{Prototype parent}}
	The default map settings. Only 1 instance of this prototype can exist.		The default map settings. Only 1 instance of this prototype can exist.

Bilka: 1.1.49: fwd2bwd_ratio changed

2021-12-10T12:45:50Z

1.1.49: fwd2bwd_ratio changed

← Older revision		Revision as of 12:45, 10 December 2021
Line 83:		Line 83:
	{{Prototype property\|path_finder\|[[Types/table\|table]]}}		{{Prototype property\|path_finder\|[[Types/table\|table]]}}
	Table with the following mandatory members:		Table with the following mandatory members:
	* fwd2bwd_ratio - [[Types/~~int32~~\|~~int32~~]] - ~~Defines whether we prefer forward (>1) or~~ backward ~~(<-1) or symmetrical (1)~~ search.		* fwd2bwd_ratio - [[Types/uint32\|uint32]] - The pathfinder performs a step of the backward search every fwd2bwd_ratio'th step. The minimum allowed value is 2, which means symmetric search.
	* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.		* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.
	* use_path_cache - [[Types/bool\|bool]]		* use_path_cache - [[Types/bool\|bool]]

Bilka: 0.18.22

2020-04-30T17:19:56Z

0.18.22

← Older revision		Revision as of 17:19, 30 April 2020
Line 85:		Line 85:
	* fwd2bwd_ratio - [[Types/int32\|int32]] - Defines whether we prefer forward (>1) or backward (<-1) or symmetrical (1) search.		* fwd2bwd_ratio - [[Types/int32\|int32]] - Defines whether we prefer forward (>1) or backward (<-1) or symmetrical (1) search.
	* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.		* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.
			* use_path_cache - [[Types/bool\|bool]]
	* max_steps_worked_per_tick - [[Types/double\|double]] - When this is exhausted no more requests are allowed, at the moment the first path to exhaust this will be finished (even if it is hundreds of steps).		* max_steps_worked_per_tick - [[Types/double\|double]] - When this is exhausted no more requests are allowed, at the moment the first path to exhaust this will be finished (even if it is hundreds of steps).
	* ~~use_path_cache~~ - [[Types/~~bool~~\|~~bool~~]]		* max_work_done_per_tick - [[Types/uint32\|uint32]]
	* short_cache_size - [[Types/uint32\|uint32]] - Number of elements in the cache.		* short_cache_size - [[Types/uint32\|uint32]] - Number of elements in the cache.
	* long_cache_size - [[Types/uint32\|uint32]]		* long_cache_size - [[Types/uint32\|uint32]]
Line 112:		Line 113:
	* min_steps_to_check_path_find_termination - [[Types/uint32\|uint32]] - Absolute minimum of steps that will be performed for every path find request no matter what.		* min_steps_to_check_path_find_termination - [[Types/uint32\|uint32]] - Absolute minimum of steps that will be performed for every path find request no matter what.
	* start_to_goal_cost_multiplier_to_terminate_path_find - [[Types/double\|double]] - If the current actual cost from start is higher than this times estimate of start to goal then path finding is terminated.		* start_to_goal_cost_multiplier_to_terminate_path_find - [[Types/double\|double]] - If the current actual cost from start is higher than this times estimate of start to goal then path finding is terminated.
			* overload_levels - [[Types/table\|table]] (array) of [[Types/uint32\|uint32]]
			* overload_multipliers - [[Types/table\|table]] (array) of [[Types/double\|double]]

	{{Prototype property\|max_failed_behavior_count\|[[Types/uint32\|uint32]]}}		{{Prototype property\|max_failed_behavior_count\|[[Types/uint32\|uint32]]}}
Line 117:		Line 120:

	{{Prototype property\|difficulty_settings\|[[Types/table\|table]]}}		{{Prototype property\|difficulty_settings\|[[Types/table\|table]]}}
	Table with the following ~~mandatory~~ members:		Table with the following members:
	* recipe_difficulty - [[Types/uint8\|uint8]] - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.recipe_difficulty].		* recipe_difficulty - [[Types/uint8\|uint8]] - Mandatory. - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.recipe_difficulty].
	* technology_difficulty - [[Types/uint8\|uint8]] - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.technology_difficulty].		* technology_difficulty - [[Types/uint8\|uint8]] - Mandatory. - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.technology_difficulty].
	* technology_price_multiplier - [[Types/double\|double]] - Must be >= 0.001 and <= 1000.		* technology_price_multiplier - [[Types/double\|double]] - Optional, defaults to 1. - Must be >= 0.001 and <= 1000.
	* research_queue_setting - [[Types/string\|string]] - Either "always", "after-victory" or "never".		* research_queue_setting - [[Types/string\|string]] - Optional. - Either "always", "after-victory" or "never".

Bilka: /* Mandatory properties */ 0.17.77 pathfinder.extended_collision_penalty

2019-11-18T10:55:14Z

Mandatory properties: 0.17.77 pathfinder.extended_collision_penalty

← Older revision		Revision as of 10:55, 18 November 2019
Line 104:		Line 104:
	* general_entity_collision_penalty - [[Types/double\|double]] - Simplification for now; collision with everything else is this.		* general_entity_collision_penalty - [[Types/double\|double]] - Simplification for now; collision with everything else is this.
	* general_entity_subsequent_collision_penalty - [[Types/double\|double]] - Collision penalty for successors of positions that require destroy to reach.		* general_entity_subsequent_collision_penalty - [[Types/double\|double]] - Collision penalty for successors of positions that require destroy to reach.
			* extended_collision_penalty - [[Types/double\|double]] - Collision penalty for collisions in the extended bounding box but outside the entity's actual bounding box.
	* max_clients_to_accept_any_new_request - [[Types/uint32\|uint32]] - Up until this amount any client will be served by the path finder (no estimate on the path length).		* max_clients_to_accept_any_new_request - [[Types/uint32\|uint32]] - Up until this amount any client will be served by the path finder (no estimate on the path length).
	* max_clients_to_accept_short_new_request - [[Types/uint32\|uint32]] - From max_clients_to_accept_any_new_request till this one only those that have a short estimate will be served.		* max_clients_to_accept_short_new_request - [[Types/uint32\|uint32]] - From max_clients_to_accept_any_new_request till this one only those that have a short estimate will be served.

Bilka: Converted to SMW format

2019-07-27T22:11:31Z

Converted to SMW format

Show changes

Bilka: 0.17.59 comment update

2019-07-26T12:28:28Z

0.17.59 comment update

← Older revision		Revision as of 12:28, 26 July 2019
Line 74:		Line 74:
	* neighbouring_base_chunk_coefficient - [[Types/double]]		* neighbouring_base_chunk_coefficient - [[Types/double]]
	* max_colliding_tiles_coefficient - [[Types/double]] - A chunk has to have at most this much percent unbuildable tiles for it to be considered a candidate. This is to avoid chunks full of water to be marked as candidates.		* max_colliding_tiles_coefficient - [[Types/double]] - A chunk has to have at most this much percent unbuildable tiles for it to be considered a candidate. This is to avoid chunks full of water to be marked as candidates.
	* settler_group_min_size - [[Types/uint32]] - Size of the group that goes to build new base (in game ~~this is multiplied by the~~ evolution factor).		* settler_group_min_size - [[Types/uint32]] - Size of the group that goes to build new base (the game interpolates between min size and max size based on evolution factor).
	* settler_group_max_size - [[Types/uint32]]		* settler_group_max_size - [[Types/uint32]]
	* min_expansion_cooldown - [[Types/uint32]] - Ticks to expand to a single position for a base is used. Cooldown is calculated as follows: <code>cooldown = lerp(max_expansion_cooldown, min_expansion_cooldown, -e^2 + 2 * e)</code> where lerp is the linear interpolation function, and e is the current evolution factor.		* min_expansion_cooldown - [[Types/uint32]] - Ticks to expand to a single position for a base is used. Cooldown is calculated as follows: <code>cooldown = lerp(max_expansion_cooldown, min_expansion_cooldown, -e^2 + 2 * e)</code> where lerp is the linear interpolation function, and e is the current evolution factor.
Line 128:		Line 128:
	* short_request_ratio - [[Types/double]] - How many steps will be allocated to short requests each tick, as a ratio of all available steps per tick.		* short_request_ratio - [[Types/double]] - How many steps will be allocated to short requests each tick, as a ratio of all available steps per tick.
	* min_steps_to_check_path_find_termination - [[Types/uint32]] - Absolute minimum of steps that will be performed for every path find request no matter what.		* min_steps_to_check_path_find_termination - [[Types/uint32]] - Absolute minimum of steps that will be performed for every path find request no matter what.
	* start_to_goal_cost_multiplier_to_terminate_path_find - [[Types/double]] - If the ~~amount of steps~~ is higher than this times estimate of start to goal then path finding is terminated.		* start_to_goal_cost_multiplier_to_terminate_path_find - [[Types/double]] - If the current actual cost from start is higher than this times estimate of start to goal then path finding is terminated.

	=== max_failed_behavior_count ===		=== max_failed_behavior_count ===

Bilka: Set prototype parent

2019-07-24T14:53:57Z

Set prototype parent

← Older revision		Revision as of 14:53, 24 July 2019
Line 1:		Line 1:
			{{Prototype parent}}

	== Basics ==		== Basics ==
	Prototype type: '''map-settings'''		Prototype type: '''map-settings'''

← Older revision		Revision as of 12:45, 10 December 2021
Line 83:		Line 83:
	{{Prototype property\|path_finder\|[[Types/table\|table]]}}		{{Prototype property\|path_finder\|[[Types/table\|table]]}}
	Table with the following mandatory members:		Table with the following mandatory members:
	* fwd2bwd_ratio - [[Types/~~int32~~\|~~int32~~]] - ~~Defines whether we prefer forward (>1) or~~ backward ~~(<-1) or symmetrical (1)~~ search.		* fwd2bwd_ratio - [[Types/uint32\|uint32]] - The pathfinder performs a step of the backward search every fwd2bwd_ratio'th step. The minimum allowed value is 2, which means symmetric search.
	* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.		* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.
	* use_path_cache - [[Types/bool\|bool]]		* use_path_cache - [[Types/bool\|bool]]

← Older revision		Revision as of 17:19, 30 April 2020
Line 85:		Line 85:
	* fwd2bwd_ratio - [[Types/int32\|int32]] - Defines whether we prefer forward (>1) or backward (<-1) or symmetrical (1) search.		* fwd2bwd_ratio - [[Types/int32\|int32]] - Defines whether we prefer forward (>1) or backward (<-1) or symmetrical (1) search.
	* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.		* goal_pressure_ratio - [[Types/double\|double]] - When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.
			* use_path_cache - [[Types/bool\|bool]]
	* max_steps_worked_per_tick - [[Types/double\|double]] - When this is exhausted no more requests are allowed, at the moment the first path to exhaust this will be finished (even if it is hundreds of steps).		* max_steps_worked_per_tick - [[Types/double\|double]] - When this is exhausted no more requests are allowed, at the moment the first path to exhaust this will be finished (even if it is hundreds of steps).
	* ~~use_path_cache~~ - [[Types/~~bool~~\|~~bool~~]]		* max_work_done_per_tick - [[Types/uint32\|uint32]]
	* short_cache_size - [[Types/uint32\|uint32]] - Number of elements in the cache.		* short_cache_size - [[Types/uint32\|uint32]] - Number of elements in the cache.
	* long_cache_size - [[Types/uint32\|uint32]]		* long_cache_size - [[Types/uint32\|uint32]]
Line 112:		Line 113:
	* min_steps_to_check_path_find_termination - [[Types/uint32\|uint32]] - Absolute minimum of steps that will be performed for every path find request no matter what.		* min_steps_to_check_path_find_termination - [[Types/uint32\|uint32]] - Absolute minimum of steps that will be performed for every path find request no matter what.
	* start_to_goal_cost_multiplier_to_terminate_path_find - [[Types/double\|double]] - If the current actual cost from start is higher than this times estimate of start to goal then path finding is terminated.		* start_to_goal_cost_multiplier_to_terminate_path_find - [[Types/double\|double]] - If the current actual cost from start is higher than this times estimate of start to goal then path finding is terminated.
			* overload_levels - [[Types/table\|table]] (array) of [[Types/uint32\|uint32]]
			* overload_multipliers - [[Types/table\|table]] (array) of [[Types/double\|double]]

	{{Prototype property\|max_failed_behavior_count\|[[Types/uint32\|uint32]]}}		{{Prototype property\|max_failed_behavior_count\|[[Types/uint32\|uint32]]}}
Line 117:		Line 120:

	{{Prototype property\|difficulty_settings\|[[Types/table\|table]]}}		{{Prototype property\|difficulty_settings\|[[Types/table\|table]]}}
	Table with the following ~~mandatory~~ members:		Table with the following members:
	* recipe_difficulty - [[Types/uint8\|uint8]] - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.recipe_difficulty].		* recipe_difficulty - [[Types/uint8\|uint8]] - Mandatory. - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.recipe_difficulty].
	* technology_difficulty - [[Types/uint8\|uint8]] - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.technology_difficulty].		* technology_difficulty - [[Types/uint8\|uint8]] - Mandatory. - A [https://lua-api.factorio.com/latest/defines.html#defines.difficulty_settings defines.difficulty_settings.technology_difficulty].
	* technology_price_multiplier - [[Types/double\|double]] - Must be >= 0.001 and <= 1000.		* technology_price_multiplier - [[Types/double\|double]] - Optional, defaults to 1. - Must be >= 0.001 and <= 1000.
	* research_queue_setting - [[Types/string\|string]] - Either "always", "after-victory" or "never".		* research_queue_setting - [[Types/string\|string]] - Optional. - Either "always", "after-victory" or "never".

← Older revision		Revision as of 10:55, 18 November 2019
Line 104:		Line 104:
	* general_entity_collision_penalty - [[Types/double\|double]] - Simplification for now; collision with everything else is this.		* general_entity_collision_penalty - [[Types/double\|double]] - Simplification for now; collision with everything else is this.
	* general_entity_subsequent_collision_penalty - [[Types/double\|double]] - Collision penalty for successors of positions that require destroy to reach.		* general_entity_subsequent_collision_penalty - [[Types/double\|double]] - Collision penalty for successors of positions that require destroy to reach.
			* extended_collision_penalty - [[Types/double\|double]] - Collision penalty for collisions in the extended bounding box but outside the entity's actual bounding box.
	* max_clients_to_accept_any_new_request - [[Types/uint32\|uint32]] - Up until this amount any client will be served by the path finder (no estimate on the path length).		* max_clients_to_accept_any_new_request - [[Types/uint32\|uint32]] - Up until this amount any client will be served by the path finder (no estimate on the path length).
	* max_clients_to_accept_short_new_request - [[Types/uint32\|uint32]] - From max_clients_to_accept_any_new_request till this one only those that have a short estimate will be served.		* max_clients_to_accept_short_new_request - [[Types/uint32\|uint32]] - From max_clients_to_accept_any_new_request till this one only those that have a short estimate will be served.