Prototype/Generator: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.18.10)
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Properties ==
{{Prototype parent|Prototype/EntityWithHealth}}
This prototype inherits all the properties from [[Prototype/EntityWithHealth]]
An entity that produces power from fluids, for example a [[steam engine]].


=== effectivity ===
{{Prototype TOC|generator}}
Type: [[Types/float]]


== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
Must be an electric energy source.
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
{{Prototype property|horizontal_animation|[[Types/Animation|Animation]]}}
{{Prototype property|vertical_animation|[[Types/Animation|Animation]]}}
{{Prototype property|effectivity|[[Types/double|double]]}}
The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator.
The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator.


=== fluid_usage_per_tick ===
{{Prototype property|fluid_usage_per_tick|[[Types/double|double]]}}
Type: [[Types/unsigned]]
The number of fluid units the generator uses per tick.
 
{{Prototype property|maximum_temperature|[[Types/double|double]]}}
 
== Optional properties ==
 
{{Prototype property|smoke|[[Types/table|table]] of [[Types/SmokeSource|SmokeSource]]|optional=true}}
Array of 1 or more smoke sources.
 
{{Prototype property|burns_fluid|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|scale_fluid_usage|[[Types/bool|bool]]|false|optional=true}}
Scales the generator's fluid usage to its maximum power output.


The number of water units the generator uses per tick.
{{Prototype property|min_perceived_performance|[[Types/double|double]]|0.25|optional=true}}
Animation runs at least this fast. This corresponds to the sound.


=== energy_source ===
{{Prototype property|performance_to_sound_speedup|[[Types/double|double]]|0.5|optional=true}}
Type: [[Types/EnergySource]]


Defines how the generator is powered.
{{Prototype property|max_power_output|[[Types/Energy|Energy]]|optional=true}}

Revision as of 11:07, 3 March 2020

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


An entity that produces power from fluids, for example a steam engine.


Prototype/Generator — generator
effectivity::double
energy_source::EnergySource
fluid_box::FluidBox
fluid_usage_per_tick::double
horizontal_animation::Animation
maximum_temperature::double
vertical_animation::Animation
burns_fluid::bool (optional)
destroy_non_fuel_fluid::bool (optional)
max_power_output::Energy (optional)
min_perceived_performance::double (optional)
performance_to_sound_speedup::double (optional)
scale_fluid_usage::bool (optional)
smoke::table of SmokeSource (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/EntityWithHealth.

energy_source

Type: EnergySource
Must be an electric energy source.

fluid_box

Type: FluidBox

horizontal_animation

Type: Animation

vertical_animation

Type: Animation

effectivity

Type: double
The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator.

fluid_usage_per_tick

Type: double
The number of fluid units the generator uses per tick.

maximum_temperature

Type: double

Optional properties

smoke

Type: table of SmokeSource
Array of 1 or more smoke sources.

burns_fluid

Type: bool
Default: false

scale_fluid_usage

Type: bool
Default: false
Scales the generator's fluid usage to its maximum power output.

min_perceived_performance

Type: double
Default: 0.25
Animation runs at least this fast. This corresponds to the sound.

performance_to_sound_speedup

Type: double
Default: 0.5

max_power_output

Type: Energy