Prototype/ProgrammableSpeaker: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(1.1.51: Prototype/EntityWithOwner added)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/EntityWithOwner}}
Prototype type: '''programmable-speaker'''
A [[programmable speaker]].


Extends [[Prototype/EntityWithHealth]].
{{Prototype TOC|programmable-speaker}}


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


=== energy_source ===
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
'''Type''': [[Types/EnergySource]]
Must be an electric or void energy source.


Must be an electric energy source.
{{Prototype property|energy_usage_per_tick|[[Types/Energy|Energy]]}}


=== energy_usage_per_tick ===
{{Prototype property|sprite|[[Types/Sprite|Sprite]]}}
'''Type''': [[Types/Energy]]


=== sprite ===
{{Prototype property|maximum_polyphony|[[Types/uint32|uint32]]}}
'''Type''': [[Types/Sprite]]
 
=== maximum_polyphony ===
'''Type''': [[Types/uint32]]
 
=== instruments ===
'''Type''': [[Types/table]]


{{Prototype property|instruments|[[Types/table|table]]}}
Array of ''instrument''s.
Array of ''instrument''s.


An ''instrument'' is a table with the following members:
An ''instrument'' is a table with the following members:


* name - [[Types/string]] - Mandatory
* name - [[Types/string|string]] - Mandatory
* notes - [[Types/table]] of ''note''s - Mandatory
* notes - [[Types/table|table]] of ''note''s - Mandatory


A ''note'' is a table with the following members:
A ''note'' is a table with the following members:
* name - [[Types/string]] - Mandatory
* name - [[Types/string|string]] - Mandatory
* sound - [[Types/Sound]] - Mandatory
* sound - [[Types/Sound|Sound]] - Mandatory


== Optional properties ==
== Optional properties ==


=== audible_distance_modifier ===
{{Prototype property|audible_distance_modifier|[[Types/float|float]]|1|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 1
{{Prototype property|circuit_wire_connection_point|[[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}


=== circuit_wire_connection_point ===
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
'''Type''': [[Types/WireConnectionPoint]]


=== circuit_wire_max_distance ===
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/double]]


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


=== circuit_connector_sprites ===
{{Prototype property|circuit_connector_sprites|[[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
'''Type''': [[Types/CircuitConnectorSprites]]

Latest revision as of 19:27, 21 January 2022

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


A programmable speaker.


Prototype/ProgrammableSpeaker — programmable-speaker
energy_source::EnergySource
energy_usage_per_tick::Energy
instruments::table
maximum_polyphony::uint32
sprite::Sprite
audible_distance_modifier::float (optional)
circuit_connector_sprites::CircuitConnectorSprites (optional)
circuit_wire_connection_point::WireConnectionPoint (optional)
circuit_wire_max_distance::double (optional)
draw_circuit_wires::bool (optional)
draw_copper_wires::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.

energy_source

Type: EnergySource
Must be an electric or void energy source.

energy_usage_per_tick

Type: Energy

sprite

Type: Sprite

maximum_polyphony

Type: uint32

instruments

Type: table
Array of instruments.

An instrument is a table with the following members:

  • name - string - Mandatory
  • notes - table of notes - Mandatory

A note is a table with the following members:

Optional properties

audible_distance_modifier

Type: float
Default: 1

circuit_wire_connection_point

Type: WireConnectionPoint

circuit_wire_max_distance

Type: double
Default: 0

draw_copper_wires

Type: bool
Default: true

draw_circuit_wires

Type: bool
Default: true

circuit_connector_sprites

Type: CircuitConnectorSprites

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