Prototype/BurnerGenerator: Difference between revisions

Revision as of 12:31, 3 March 2020

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

An entity that produces power from a burner energy source.

Prototype/BurnerGenerator — `burner-generator`
animation	::	Animation4Way
burner	::	EnergySource
energy_source	::	EnergySource
max_power_output	::	Energy
always_draw_idle_animation	::	bool (optional)
idle_animation	::	Animation4Way (optional)
min_perceived_performance	::	double (optional)
performance_to_sound_speedup	::	double (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
The output energy source of the generator. Any emissions specified on this energy source are ignored, they must be specified on burner. Must be an electric energy source.

burner

Type: EnergySource
The input energy source of the generator. Must be a burner energy source.

animation

Type: Animation4Way
Plays when the generator is active. Idle animation must have the same frame count as animation.

max_power_output

Type: Energy
How much energy this generator can produce.

Optional properties

idle_animation

Type: Animation4Way
Plays when the generator is inactive. Idle animation must have the same frame count as animation.

always_draw_idle_animation

Type: bool
Default: false
Whether the idle_animation should also play when the generator is active.

min_perceived_performance

Type: double
Default: 0.25
Animation runs at least this fast.

performance_to_sound_speedup

Type: double
Default: 0.5

@@ Line 21: / Line 21: @@
 == Optional properties ==
-{{Prototype property|idle_animation|[[Types/Animation4Way|Animation4Way]]}}
+{{Prototype property|idle_animation|[[Types/Animation4Way|Animation4Way]]|optional=true}}
 Plays when the generator is inactive. Idle animation must have the same frame count as animation.
-{{Prototype property|always_draw_idle_animation|[[Types/bool|bool]]|false}}
+{{Prototype property|always_draw_idle_animation|[[Types/bool|bool]]|false|optional=true}}
 Whether the <code>idle_animation</code> should also play when the generator is active.
-{{Prototype property|min_perceived_performance|[[Types/double|double]]|0.25}}
+{{Prototype property|min_perceived_performance|[[Types/double|double]]|0.25|optional=true}}
 Animation runs at least this fast.
-{{Prototype property|performance_to_sound_speedup|[[Types/double|double]]|0.5}}
+{{Prototype property|performance_to_sound_speedup|[[Types/double|double]]|0.5|optional=true}}