Prototype/Generator: Difference between revisions

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

@@ Line 1: / Line 1: @@
 {{Prototype parent|Prototype/EntityWithHealth}}
-A power generator, for example a [[steam engine]].
+An entity that produces power from fluids, for example a [[steam engine]].
 {{Prototype TOC|generator}}
@@ Line 9: / Line 9: @@
 {{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]]}}
@@ Line 16: / Line 18: @@
 {{Prototype property|effectivity|[[Types/double|double]]}}
 The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator.
+{{Prototype property|fluid_usage_per_tick|[[Types/double|double]]}}
+The number of fluid units the generator uses per tick.
+{{Prototype property|maximum_temperature|[[Types/double|double]]}}
 == Optional properties ==
@@ Line 33: / Line 40: @@
 {{Prototype property|max_power_output|[[Types/Energy|Energy]]|optional=true}}
-Mandatory if <code>burner</code> is used, otherwise optional.
-{{Prototype property|burner|[[Types/EnergySource|EnergySource]]|optional=true}}
-Must be a burner energy source.
-{{Prototype property|fluid_usage_per_tick|[[Types/double|double]]|optional=true}}
-The number of fluid units the generator uses per tick.
-Mandatory if <code>fluid_box</code> is used, otherwise not read.
-{{Prototype property|maximum_temperature|[[Types/double|double]]|optional=true}}
-Mandatory if <code>fluid_box</code> is used, otherwise not read.
-{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}
-Mandatory if <code>burner</code> is '''not''' used, otherwise not read.