Prototype/EnemySpawner - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:48Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</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>		</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>



	~~{{Prototype parent\|Prototype/EntityWithOwner}}~~
	~~Can spawn entities. Used for biter/spitter nests.~~

	~~{{Prototype TOC\|unit-spawner}}~~

	~~== Mandatory properties ==~~
	~~This prototype inherits all the properties from [[Prototype/EntityWithOwner]].~~

	~~{{Prototype property\|animations\|[[Types/AnimationVariations\|AnimationVariations]]}}~~

	~~{{Prototype property\|max_count_of_owned_units\|[[Types/uint32\|uint32]]}}~~
	~~Count of enemies this spawner can sustain.~~

	~~{{Prototype property\|max_friends_around_to_spawn\|[[Types/uint32\|uint32]]}}~~
	~~How many friendly units are required within the [[#spawning_radius\|spawning_radius]] of this spawner for it to stop producing more units.~~

	~~{{Prototype property\|spawning_cooldown\|[[Types/table\|array]] of two [[Types/double\|double]]}}~~
	~~Ticks for cooldown after unit is spawned~~

	~~{{Prototype property\|spawning_radius\|[[Types/double\|double]]}}~~
	~~How far from the spawner can the units be spawned.~~

	~~{{Prototype property\|spawning_spacing\|[[Types/double\|double]]}}~~
	~~What spaces should be between the spawned units.~~

	~~{{Prototype property\|max_richness_for_spawn_shift\|[[Types/double\|double]]}}~~
	~~Max richness to determine spawn shift. Spawn shift is linear interpolation between 0 and maxSpawnShift.~~

	~~{{Prototype property\|max_spawn_shift\|[[Types/double\|double]]}}~~
	~~Caps how much richness can be added on top of evolution when spawning units. (See also [https://www.reddit.com/r/factorio/comments/8pjscm/friday_facts_246_the_gui_update_part_3/e0bttnp/])~~

	~~{{Prototype property\|pollution_absorption_absolute\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|pollution_absorption_proportional\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|call_for_help_radius\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|result_units\|[[Types/table\|table]] of [[Types/UnitSpawnDefinition\|UnitSpawnDefinition]]}}~~
	~~Array of the [[Prototype/Entity\|entities]] that this spawner can spawn and their spawn probabilities. The sum of probabilities is expected to be 1.0. The array must not be empty.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|dying_sound\|[[Types/Sound\|Sound]]\|optional=true}}~~

	~~{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}~~

	~~{{Prototype property\|min_darkness_to_spawn\|[[Types/float\|float]]\|0.0\|optional=true}}~~

	~~{{Prototype property\|max_darkness_to_spawn\|[[Types/float\|float]]\|1.0\|optional=true}}~~

	~~{{Prototype property\|random_animation_offset\|[[Types/bool\|bool]]\|true\|optional=true}}~~

	~~{{Prototype property\|spawn_decorations_on_expansion\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	~~Whether <code>spawn_decoration</code> should be spawned when enemies [[Enemies#Expansions\|expand]].~~

	{{Prototype property\|spawn_decoration\|[[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or [[Types/table\|table]] of [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]]\|optional=true}}
	A single [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or an array of them. Decoratives to be created when the spawner is created by the [[map generator]]. Placed when enemies expand if <code>spawn_decorations_on_expansion</code> is set to true.

	~~== Mandatory values ==~~
	~~Enemy spawners have additional requirements for the properties inherited from [[Prototype/EntityWithOwner]]:~~
	* [[Prototype/EntityWithOwner#is_military_target]] must be true.
	* [[Prototype/EntityWithOwner#allow_run_time_change_of_is_military_target]] must be false.

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:00Z

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/EnemySpawnerPrototype.html https://lua-api.factorio.com/latest/prototypes/EnemySpawnerPrototype.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/EnemySpawnerPrototype.html https://lua-api.factorio.com/latest/prototypes/EnemySpawnerPrototype.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/EnemySpawner": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:22Z

Protected "Prototype/EnemySpawner": 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:22Z

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/EnemySpawnerPrototype.html https://lua-api.factorio.com/latest/prototypes/EnemySpawnerPrototype.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/EntityWithOwner}}		{{Prototype parent\|Prototype/EntityWithOwner}}
	Can spawn entities. Used for biter/spitter nests.		Can spawn entities. Used for biter/spitter nests.

Bilka: mandatory value for Prototype/EntityWithOwner#allow_run_time_change_of_is_military_target

2022-01-21T21:00:58Z

mandatory value for Prototype/EntityWithOwner#allow_run_time_change_of_is_military_target

← Older revision		Revision as of 21:00, 21 January 2022
Line 60:		Line 60:
	Enemy spawners have additional requirements for the properties inherited from [[Prototype/EntityWithOwner]]:		Enemy spawners have additional requirements for the properties inherited from [[Prototype/EntityWithOwner]]:
	* [[Prototype/EntityWithOwner#is_military_target]] must be true.		* [[Prototype/EntityWithOwner#is_military_target]] must be true.
			* [[Prototype/EntityWithOwner#allow_run_time_change_of_is_military_target]] must be false.

Bilka: 1.1.51: Prototype/EntityWithOwner added

2022-01-21T19:26:42Z

1.1.51: Prototype/EntityWithOwner added

← Older revision		Revision as of 19:26, 21 January 2022
Line 1:		Line 1:
	{{Prototype parent\|Prototype/~~EntityWithHealth~~}}		{{Prototype parent\|Prototype/EntityWithOwner}}
	Can spawn entities. Used for biter/spitter nests.		Can spawn entities. Used for biter/spitter nests.

Line 5:		Line 5:

	== Mandatory properties ==		== Mandatory properties ==
	This prototype inherits all the properties from [[Prototype/~~EntityWithHealth~~]].		This prototype inherits all the properties from [[Prototype/EntityWithOwner]].

	{{Prototype property\|animations\|[[Types/AnimationVariations\|AnimationVariations]]}}		{{Prototype property\|animations\|[[Types/AnimationVariations\|AnimationVariations]]}}
Line 56:		Line 56:
	{{Prototype property\|spawn_decoration\|[[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or [[Types/table\|table]] of [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]]\|optional=true}}		{{Prototype property\|spawn_decoration\|[[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or [[Types/table\|table]] of [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]]\|optional=true}}
	A single [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or an array of them. Decoratives to be created when the spawner is created by the [[map generator]]. Placed when enemies expand if <code>spawn_decorations_on_expansion</code> is set to true.		A single [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or an array of them. Decoratives to be created when the spawner is created by the [[map generator]]. Placed when enemies expand if <code>spawn_decorations_on_expansion</code> is set to true.

			== Mandatory values ==
			Enemy spawners have additional requirements for the properties inherited from [[Prototype/EntityWithOwner]]:
			* [[Prototype/EntityWithOwner#is_military_target]] must be true.

Bilka: 1.0.0: added spawn_decorations_on_expansion, spawn_decoration

2020-09-08T11:20:53Z

1.0.0: added spawn_decorations_on_expansion, spawn_decoration

← Older revision		Revision as of 11:20, 8 September 2020
Line 44:		Line 44:

	{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}		{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}

			{{Prototype property\|min_darkness_to_spawn\|[[Types/float\|float]]\|0.0\|optional=true}}

			{{Prototype property\|max_darkness_to_spawn\|[[Types/float\|float]]\|1.0\|optional=true}}

	{{Prototype property\|random_animation_offset\|[[Types/bool\|bool]]\|true\|optional=true}}		{{Prototype property\|random_animation_offset\|[[Types/bool\|bool]]\|true\|optional=true}}

	{{Prototype property\|~~min_darkness_to_spawn~~\|[[Types/~~float~~\|~~float~~]]\|~~0.0~~\|optional=true}}		{{Prototype property\|spawn_decorations_on_expansion\|[[Types/bool\|bool]]\|false\|optional=true}}
			Whether <code>spawn_decoration</code> should be spawned when enemies [[Enemies#Expansions\|expand]].

	{{Prototype property\|~~max_darkness_to_spawn~~\|[[Types/~~float~~\|~~float~~]]\|~~1.0~~\|optional=true}}		{{Prototype property\|spawn_decoration\|[[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or [[Types/table\|table]] of [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]]\|optional=true}}
			A single [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or an array of them. Decoratives to be created when the spawner is created by the [[map generator]]. Placed when enemies expand if <code>spawn_decorations_on_expansion</code> is set to true.

Bilka: dying_sound is optional

2020-04-01T19:09:43Z

dying_sound is optional

← Older revision		Revision as of 19:09, 1 April 2020
Line 6:		Line 6:
	== Mandatory properties ==		== Mandatory properties ==
	This prototype inherits all the properties from [[Prototype/EntityWithHealth]].		This prototype inherits all the properties from [[Prototype/EntityWithHealth]].

	~~{{Prototype property\|dying_sound\|[[Types/Sound\|Sound]]}}~~

	{{Prototype property\|animations\|[[Types/AnimationVariations\|AnimationVariations]]}}		{{Prototype property\|animations\|[[Types/AnimationVariations\|AnimationVariations]]}}
Line 42:		Line 40:

	== Optional properties ==		== Optional properties ==

			{{Prototype property\|dying_sound\|[[Types/Sound\|Sound]]\|optional=true}}

	{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}		{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}

Bilka: /* Mandatory properties */ fixed link

2019-10-07T09:28:29Z

Mandatory properties: fixed link

← Older revision		Revision as of 09:28, 7 October 2019
Line 17:		Line 17:
	How many friendly units are required within the [[#spawning_radius\|spawning_radius]] of this spawner for it to stop producing more units.		How many friendly units are required within the [[#spawning_radius\|spawning_radius]] of this spawner for it to stop producing more units.

	{{Prototype property\|spawning_cooldown\|[[Types/table\|array]] of two ~~types~~/double}}		{{Prototype property\|spawning_cooldown\|[[Types/table\|array]] of two [[Types/double\|double]]}}
	Ticks for cooldown after unit is spawned		Ticks for cooldown after unit is spawned

Bilka: /* Mandatory properties */ typo

2019-08-07T18:07:25Z

Mandatory properties: typo

← Older revision		Revision as of 18:07, 7 August 2019
Line 17:		Line 17:
	How many friendly units are required within the [[#spawning_radius\|spawning_radius]] of this spawner for it to stop producing more units.		How many friendly units are required within the [[#spawning_radius\|spawning_radius]] of this spawner for it to stop producing more units.

	{{Prototype property\|spawning_cooldown\|[[Types/table\|~~Array~~]] of two types/double}}		{{Prototype property\|spawning_cooldown\|[[Types/table\|array]] of two types/double}}
	Ticks for cooldown after unit is spawned		Ticks for cooldown after unit is spawned

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</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>		</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>



	~~{{Prototype parent\|Prototype/EntityWithOwner}}~~
	~~Can spawn entities. Used for biter/spitter nests.~~

	~~{{Prototype TOC\|unit-spawner}}~~

	~~== Mandatory properties ==~~
	~~This prototype inherits all the properties from [[Prototype/EntityWithOwner]].~~

	~~{{Prototype property\|animations\|[[Types/AnimationVariations\|AnimationVariations]]}}~~

	~~{{Prototype property\|max_count_of_owned_units\|[[Types/uint32\|uint32]]}}~~
	~~Count of enemies this spawner can sustain.~~

	~~{{Prototype property\|max_friends_around_to_spawn\|[[Types/uint32\|uint32]]}}~~
	~~How many friendly units are required within the [[#spawning_radius\|spawning_radius]] of this spawner for it to stop producing more units.~~

	~~{{Prototype property\|spawning_cooldown\|[[Types/table\|array]] of two [[Types/double\|double]]}}~~
	~~Ticks for cooldown after unit is spawned~~

	~~{{Prototype property\|spawning_radius\|[[Types/double\|double]]}}~~
	~~How far from the spawner can the units be spawned.~~

	~~{{Prototype property\|spawning_spacing\|[[Types/double\|double]]}}~~
	~~What spaces should be between the spawned units.~~

	~~{{Prototype property\|max_richness_for_spawn_shift\|[[Types/double\|double]]}}~~
	~~Max richness to determine spawn shift. Spawn shift is linear interpolation between 0 and maxSpawnShift.~~

	~~{{Prototype property\|max_spawn_shift\|[[Types/double\|double]]}}~~
	~~Caps how much richness can be added on top of evolution when spawning units. (See also [https://www.reddit.com/r/factorio/comments/8pjscm/friday_facts_246_the_gui_update_part_3/e0bttnp/])~~

	~~{{Prototype property\|pollution_absorption_absolute\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|pollution_absorption_proportional\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|call_for_help_radius\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|result_units\|[[Types/table\|table]] of [[Types/UnitSpawnDefinition\|UnitSpawnDefinition]]}}~~
	~~Array of the [[Prototype/Entity\|entities]] that this spawner can spawn and their spawn probabilities. The sum of probabilities is expected to be 1.0. The array must not be empty.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|dying_sound\|[[Types/Sound\|Sound]]\|optional=true}}~~

	~~{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}~~

	~~{{Prototype property\|min_darkness_to_spawn\|[[Types/float\|float]]\|0.0\|optional=true}}~~

	~~{{Prototype property\|max_darkness_to_spawn\|[[Types/float\|float]]\|1.0\|optional=true}}~~

	~~{{Prototype property\|random_animation_offset\|[[Types/bool\|bool]]\|true\|optional=true}}~~

	~~{{Prototype property\|spawn_decorations_on_expansion\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	~~Whether <code>spawn_decoration</code> should be spawned when enemies [[Enemies#Expansions\|expand]].~~

	{{Prototype property\|spawn_decoration\|[[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or [[Types/table\|table]] of [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]]\|optional=true}}
	A single [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or an array of them. Decoratives to be created when the spawner is created by the [[map generator]]. Placed when enemies expand if <code>spawn_decorations_on_expansion</code> is set to true.

	~~== Mandatory values ==~~
	~~Enemy spawners have additional requirements for the properties inherited from [[Prototype/EntityWithOwner]]:~~
	* [[Prototype/EntityWithOwner#is_military_target]] must be true.
	* [[Prototype/EntityWithOwner#allow_run_time_change_of_is_military_target]] must be false.

← Older revision		Revision as of 11:20, 8 September 2020
Line 44:		Line 44:

	{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}		{{Prototype property\|integration\|[[Types/SpriteVariations\|SpriteVariations]]\|optional=true}}

			{{Prototype property\|min_darkness_to_spawn\|[[Types/float\|float]]\|0.0\|optional=true}}

			{{Prototype property\|max_darkness_to_spawn\|[[Types/float\|float]]\|1.0\|optional=true}}

	{{Prototype property\|random_animation_offset\|[[Types/bool\|bool]]\|true\|optional=true}}		{{Prototype property\|random_animation_offset\|[[Types/bool\|bool]]\|true\|optional=true}}

	{{Prototype property\|~~min_darkness_to_spawn~~\|[[Types/~~float~~\|~~float~~]]\|~~0.0~~\|optional=true}}		{{Prototype property\|spawn_decorations_on_expansion\|[[Types/bool\|bool]]\|false\|optional=true}}
			Whether <code>spawn_decoration</code> should be spawned when enemies [[Enemies#Expansions\|expand]].

	{{Prototype property\|~~max_darkness_to_spawn~~\|[[Types/~~float~~\|~~float~~]]\|~~1.0~~\|optional=true}}		{{Prototype property\|spawn_decoration\|[[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or [[Types/table\|table]] of [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]]\|optional=true}}
			A single [[Types/CreateDecorativesTriggerEffectItem\|CreateDecorativesTriggerEffectItem]] or an array of them. Decoratives to be created when the spawner is created by the [[map generator]]. Placed when enemies expand if <code>spawn_decorations_on_expansion</code> is set to true.