Prototype/ElectricEnergyInterface: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(1.1.51: Prototype/EntityWithOwner added)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/EntityWithOwner}}
Prototype type: '''electric-energy-interface'''
Entity with electric energy source with that can have some of its values changed runtime. Useful for modding in energy consumers/producers.


Entity with energy source with that can have some of its values changed runtime. Useful for modding in energy consumers/producers.
{{Prototype TOC|electric-energy-interface}}
Extends the [[Prototype/EntityWithHealth]]
== Properties ==
=== energy_source ===
'''Type''': [[Types/EnergySource]]


== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
Must be an electric energy source.
Must be an electric energy source.
=== energy_production ===
'''Type''': [[Types/Energy]]


'''Default''': 0
== Optional properties ==


=== energy_usage ===
{{Prototype property|energy_production|[[Types/Energy|Energy]]|0|optional=true}}
'''Type''': [[Types/Energy]]


'''Default''': 0
{{Prototype property|energy_usage|[[Types/Energy|Energy]]|0|optional=true}}


=== enable_gui ===
{{Prototype property|gui_mode|[[Types/string|string]]|"none"|optional=true}}
'''Type''': [[Types/bool]]
Possible options: "all", "none", "admins".


'''Default''': false
{{Prototype property|continuous_animation|[[Types/bool|bool]]|false|optional=true}}
Whether the electric energy interface animation always runs instead of being scaled to activity.


=== render_layer ===
{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}}
'''Type''': [[Types/RenderLayer]]


'''Default''': "object"
{{Prototype property|light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
The light that this electric energy interface emits.


''One of the below properties has to exist:''


''One of the below properties has to exist:''
{{Prototype property|picture|[[Types/Sprite|Sprite]]|optional=true}}
=== picture ===
'''Type''': [[Types/Sprite]]


=== pictures ===
{{Prototype property|pictures|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}
'''Type''': [[Types/Sprite4Way]]


=== animation ===
{{Prototype property|animation|[[Types/Animation|Animation]]|optional=true}}
'''Type''': [[Types/Animation]]


=== animations ===
{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]|optional=true}}
'''Type''': [[Types/Animation4Way]]


== Differing defaults ==
== Differing defaults ==

Latest revision as of 19:26, 21 January 2022

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


Entity with electric energy source with that can have some of its values changed runtime. Useful for modding in energy consumers/producers.


Prototype/ElectricEnergyInterface — electric-energy-interface
energy_source::EnergySource
animation::Animation (optional)
animations::Animation4Way (optional)
continuous_animation::bool (optional)
energy_production::Energy (optional)
energy_usage::Energy (optional)
gui_mode::string (optional)
light::LightDefinition (optional)
picture::Sprite (optional)
pictures::Sprite4Way (optional)
render_layer::RenderLayer (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.

energy_source

Type: EnergySource
Must be an electric energy source.

Optional properties

energy_production

Type: Energy
Default: 0

energy_usage

Type: Energy
Default: 0

gui_mode

Type: string
Default: "none"
Possible options: "all", "none", "admins".

continuous_animation

Type: bool
Default: false
Whether the electric energy interface animation always runs instead of being scaled to activity.

render_layer

Type: RenderLayer
Default: "object"

light

Type: LightDefinition
The light that this electric energy interface emits.

One of the below properties has to exist:

picture

Type: Sprite

pictures

Type: Sprite4Way

animation

Type: Animation

animations

Type: Animation4Way

Differing defaults

The defaults of the ElectricEnergyInterfacePrototype differ from the defaults of the EntityPrototype:

  • allow_copy_paste defaults to false