Prototype/EnemySpawner: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.17)
(mandatory value for Prototype/EntityWithOwner#allow_run_time_change_of_is_military_target)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/EntityWithOwner}}
Prototype type: '''unit-spawner'''
Can spawn entities. Used for biter/spitter nests.


Extends [[Prototype/EntityWithHealth]].
{{Prototype TOC|unit-spawner}}


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


=== dying_sound ===
{{Prototype property|animations|[[Types/AnimationVariations|AnimationVariations]]}}
'''Type''': [[Types/Sound]]
 
=== animations ===
'''Type''': [[Types/AnimationVariations]]
 
=== max_count_of_owned_units ===
'''Type''': [[Types/uint32]]


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


=== max_friends_around_to_spawn ===
{{Prototype property|max_friends_around_to_spawn|[[Types/uint32|uint32]]}}
'''Type''': [[Types/uint32]]
 
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.


=== spawning_cooldown ===
{{Prototype property|spawning_cooldown|[[Types/table|array]] of two [[Types/double|double]]}}
'''Type''': [[Types/Range]]
 
Ticks for cooldown after unit is spawned
Ticks for cooldown after unit is spawned


=== spawning_radius ===
{{Prototype property|spawning_radius|[[Types/double|double]]}}
'''Type''': [[Types/double]]
 
How far from the spawner can the units be spawned.
How far from the spawner can the units be spawned.


=== spawning_spacing ===
{{Prototype property|spawning_spacing|[[Types/double|double]]}}
'''Type''': [[Types/double]]
 
What spaces should be between the spawned units.
What spaces should be between the spawned units.


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


=== max_spawn_shift ===
{{Prototype property|max_spawn_shift|[[Types/double|double]]}}
'''Type''': [[Types/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/])
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/])


=== pollution_absorption_absolute ===
{{Prototype property|pollution_absorption_absolute|[[Types/double|double]]}}
'''Type''': [[Types/double]]


=== pollution_absorption_proportional ===
{{Prototype property|pollution_absorption_proportional|[[Types/double|double]]}}
'''Type''': [[Types/double]]


=== call_for_help_radius ===
{{Prototype property|call_for_help_radius|[[Types/double|double]]}}
'''Type''': [[Types/double]]


=== result_units ===
{{Prototype property|result_units|[[Types/table|table]] of [[Types/UnitSpawnDefinition|UnitSpawnDefinition]]}}
'''Type''': [[Types/table]] of [[Types/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.


Array of the [[Prototype/Unit]]s 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 ==


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


=== integration ===
{{Prototype property|integration|[[Types/SpriteVariations|SpriteVariations]]|optional=true}}
'''Type''': [[Types/SpriteVariations]]


=== random_animation_offset ===
{{Prototype property|min_darkness_to_spawn|[[Types/float|float]]|0.0|optional=true}}
'''Type''': [[Types/bool]]


'''Default''': true
{{Prototype property|max_darkness_to_spawn|[[Types/float|float]]|1.0|optional=true}}


=== min_darkness_to_spawn ===
{{Prototype property|random_animation_offset|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 0.0
{{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]].


=== max_darkness_to_spawn ===
{{Prototype property|spawn_decoration|[[Types/CreateDecorativesTriggerEffectItem|CreateDecorativesTriggerEffectItem]] or [[Types/table|table]] of [[Types/CreateDecorativesTriggerEffectItem|CreateDecorativesTriggerEffectItem]]|optional=true}}
'''Type''': [[Types/float]]
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.


'''Default''': 1.0
== 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.

Latest revision as of 21:00, 21 January 2022

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/EnemySpawner


Can spawn entities. Used for biter/spitter nests.


Prototype/EnemySpawner — unit-spawner
animations::AnimationVariations
call_for_help_radius::double
max_count_of_owned_units::uint32
max_friends_around_to_spawn::uint32
max_richness_for_spawn_shift::double
max_spawn_shift::double
pollution_absorption_absolute::double
pollution_absorption_proportional::double
result_units::table of UnitSpawnDefinition
spawning_cooldown::array of two double
spawning_radius::double
spawning_spacing::double
dying_sound::Sound (optional)
integration::SpriteVariations (optional)
max_darkness_to_spawn::float (optional)
min_darkness_to_spawn::float (optional)
random_animation_offset::bool (optional)
spawn_decoration::CreateDecorativesTriggerEffectItem or table of CreateDecorativesTriggerEffectItem (optional)
spawn_decorations_on_expansion::bool (optional)
Inherited from Prototype/EntityWithOwner
allow_run_time_change_of_is_military_target::bool (optional)
is_military_target::bool (optional)
Inherited from Prototype/EntityWithHealth
alert_when_damaged::bool (optional)
attack_reaction::AttackReaction (optional)
corpse::string or table of strings (optional)
create_ghost_on_death::bool (optional)
damaged_trigger_effect::TriggerEffect (optional)
dying_explosion::ExplosionDefinition or table of ExplosionDefinition (optional)
dying_trigger_effect::TriggerEffect (optional)
healing_per_tick::float (optional)
hide_resistances::bool (optional)
integration_patch::Sprite4Way (optional)
integration_patch_render_layer::RenderLayer (optional)
loot::Loot (optional)
max_health::float (optional)
random_corpse_variation::bool (optional)
repair_sound::Sound (optional)
repair_speed_modifier::float (optional)
resistances::Resistances (optional)
Inherited from Prototype/Entity
icons, icon, icon_size (IconSpecification)::IconSpecification
additional_pastable_entities::table of string (optional)
alert_icon_scale::float (optional)
alert_icon_shift::vector (optional)
allow_copy_paste::bool (optional)
autoplace::AutoplaceSpecification (optional)
build_base_evolution_requirement::double (optional)
build_grid_size::uint8 (optional)
build_sound::Sound (optional)
close_sound::Sound (optional)
collision_box::BoundingBox (optional)
collision_mask::CollisionMask (optional)
created_effect::Trigger (optional)
created_smoke::CreateTrivialSmokeEffectItem (optional)
drawing_box::BoundingBox (optional)
emissions_per_second::double (optional)
enemy_map_color::Color (optional)
fast_replaceable_group::string (optional)
flags::EntityPrototypeFlags (optional)
friendly_map_color::Color (optional)
hit_visualization_box::BoundingBox (optional)
map_color::Color (optional)
map_generator_bounding_box::BoundingBox (optional)
minable::MinableProperties (optional)
mined_sound::Sound (optional)
mining_sound::Sound (optional)
next_upgrade::string (optional)
open_sound::Sound (optional)
placeable_by::ItemToPlace or table of ItemToPlace (optional)
protected_from_tile_building::bool (optional)
radius_visualisation_specification::RadiusVisualisationSpecification (optional)
remains_when_mined::string or table of string (optional)
remove_decoratives::string (optional)
rotated_sound::Sound (optional)
selectable_in_game::bool (optional)
selection_box::BoundingBox (optional)
selection_priority::uint8 (optional)
shooting_cursor_size::double (optional)
sticker_box::BoundingBox (optional)
subgroup::string (optional)
tile_height::uint32 (optional)
tile_width::uint32 (optional)
trigger_target_mask::TriggerTargetMask (optional)
vehicle_impact_sound::Sound (optional)
water_reflection::WaterReflectionDefinition (optional)
working_sound::WorkingSound (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

Mandatory properties

This prototype inherits all the properties from Prototype/EntityWithOwner.

animations

Type: AnimationVariations

max_count_of_owned_units

Type: uint32
Count of enemies this spawner can sustain.

max_friends_around_to_spawn

Type: uint32
How many friendly units are required within the spawning_radius of this spawner for it to stop producing more units.

spawning_cooldown

Type: array of two double
Ticks for cooldown after unit is spawned

spawning_radius

Type: double
How far from the spawner can the units be spawned.

spawning_spacing

Type: double
What spaces should be between the spawned units.

max_richness_for_spawn_shift

Type: double
Max richness to determine spawn shift. Spawn shift is linear interpolation between 0 and maxSpawnShift.

max_spawn_shift

Type: double
Caps how much richness can be added on top of evolution when spawning units. (See also [1])

pollution_absorption_absolute

Type: double

pollution_absorption_proportional

Type: double

call_for_help_radius

Type: double

result_units

Type: table of UnitSpawnDefinition
Array of the 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

dying_sound

Type: Sound

integration

Type: SpriteVariations

min_darkness_to_spawn

Type: float
Default: 0.0

max_darkness_to_spawn

Type: float
Default: 1.0

random_animation_offset

Type: bool
Default: true

spawn_decorations_on_expansion

Type: bool
Default: false
Whether spawn_decoration should be spawned when enemies expand.

spawn_decoration

Type: CreateDecorativesTriggerEffectItem or table of CreateDecorativesTriggerEffectItem
A single CreateDecorativesTriggerEffectItem or an array of them. Decoratives to be created when the spawner is created by the map generator. Placed when enemies expand if spawn_decorations_on_expansion is set to true.

Mandatory values

Enemy spawners have additional requirements for the properties inherited from Prototype/EntityWithOwner:

Retrieved from "https://testing-wiki.factorio.com/index.php?title=Prototype/EnemySpawner&oldid=187993"