Prototype/TrainStop: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(Updated styling of prototype doc migration note)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Basics ==
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/TrainStopPrototype.html https://lua-api.factorio.com/latest/prototypes/TrainStopPrototype.html]
Prototype type: '''train-stop'''


Extends [[Prototype/EntityWithHealth]].
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
 
 
{{Prototype parent|Prototype/EntityWithOwner}}
A [[train stop]].
 
{{Prototype TOC|train-stop}}


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


=== animation_ticks_per_frame ===
{{Prototype property|animation_ticks_per_frame|[[Types/uint32|uint32]]}}
'''Type''': [[Types/uint32]]


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


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


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


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


=== default_train_stopped_signal ===
{{Prototype property|default_train_stopped_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
'''Type''': [[Types/SignalIDConnector]]


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


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


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


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


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


=== light1 ===
{{Prototype property|color|[[Types/Color|Color]]|optional=true}}
'''Type''': [[Types/table]]


{{Prototype property|chart_name|[[Types/bool|bool]]|true|optional=true}}
{{Prototype property|light1|[[Types/table|table]]|optional=true}}
Table with the following mandatory members:
Table with the following mandatory members:


* picture - [[Types/Sprite4Way]]
* picture - [[Types/Sprite4Way|Sprite4Way]]
* red_picture - [[Types/Sprite4Way]]
* red_picture - [[Types/Sprite4Way|Sprite4Way]]
* light - [[Types/LightDefinition]]
* light - [[Types/LightDefinition|LightDefinition]]
 
=== light2 ===
'''Type''': [[Types/table]]


{{Prototype property|light2|[[Types/table|table]]|optional=true}}
Table with the following mandatory members:
Table with the following mandatory members:


* picture - [[Types/Sprite4Way]]
* picture - [[Types/Sprite4Way|Sprite4Way]]
* red_picture - [[Types/Sprite4Way]]
* red_picture - [[Types/Sprite4Way|Sprite4Way]]
* light - [[Types/LightDefinition]]
* light - [[Types/LightDefinition|LightDefinition]]
 
=== drawing_boxes ===
'''Type''': [[Types/table]]


{{Prototype property|drawing_boxes|[[Types/table|table]]|optional=true}}
Table with the following mandatory members:
Table with the following mandatory members:


* north - [[Types/BoundingBox]]
* north - [[Types/BoundingBox|BoundingBox]]
* east - [[Types/BoundingBox]]
* east - [[Types/BoundingBox|BoundingBox]]
* south - [[Types/BoundingBox]]
* south - [[Types/BoundingBox|BoundingBox]]
* west - [[Types/BoundingBox]]
* west - [[Types/BoundingBox|BoundingBox]]
 
=== circuit_wire_connection_points ===
'''Type''': [[Types/table]] of [[Types/WireConnectionPoint]]


{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Array of 4 WireConnectionPoints. Mandatory if circuit_wire_max_distance > 0.  
Array of 4 WireConnectionPoints. Mandatory if circuit_wire_max_distance > 0.  


=== circuit_connector_sprites ===
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/CircuitConnectorSprites]]
 
Array of 4 CircuitConnectorSpritess. Mandatory if circuit_wire_max_distance > 0.
Array of 4 CircuitConnectorSpritess. Mandatory if circuit_wire_max_distance > 0.

Latest revision as of 10:43, 21 September 2023

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/TrainStopPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.


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


A train stop.


Prototype/TrainStop — train-stop
animation_ticks_per_frame::uint32
animations::Animation4Way (optional)
chart_name::bool (optional)
circuit_connector_sprites::table of CircuitConnectorSprites (optional)
circuit_wire_connection_points::table of WireConnectionPoint (optional)
circuit_wire_max_distance::double (optional)
color::Color (optional)
default_train_stopped_signal::SignalIDConnector (optional)
default_trains_count_signal::SignalIDConnector (optional)
default_trains_limit_signal::SignalIDConnector (optional)
draw_circuit_wires::bool (optional)
draw_copper_wires::bool (optional)
drawing_boxes::table (optional)
light1::table (optional)
light2::table (optional)
rail_overlay_animations::Animation4Way (optional)
top_animations::Animation4Way (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.

animation_ticks_per_frame

Type: uint32

Optional properties

rail_overlay_animations

Type: Animation4Way

animations

Type: Animation4Way

top_animations

Type: Animation4Way

default_train_stopped_signal

Type: SignalIDConnector

default_trains_count_signal

Type: SignalIDConnector

default_trains_limit_signal

Type: SignalIDConnector

circuit_wire_max_distance

Type: double
Default: 0

draw_copper_wires

Type: bool
Default: true

draw_circuit_wires

Type: bool
Default: true

color

Type: Color

chart_name

Type: bool
Default: true

light1

Type: table
Table with the following mandatory members:

light2

Type: table
Table with the following mandatory members:

drawing_boxes

Type: table
Table with the following mandatory members:

circuit_wire_connection_points

Type: table of WireConnectionPoint
Array of 4 WireConnectionPoints. Mandatory if circuit_wire_max_distance > 0.

circuit_connector_sprites

Type: table of CircuitConnectorSprites
Array of 4 CircuitConnectorSpritess. Mandatory if circuit_wire_max_distance > 0.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/TrainStop&oldid=193943"