Prototype/FlyingText: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Changed links going to the redirect Types/uint to go to Types/uint32.)
(Updated styling of prototype doc migration note)
 
(6 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/FlyingTextPrototype.html https://lua-api.factorio.com/latest/prototypes/FlyingTextPrototype.html]
An upwards flying text that disappears after a certain time (setting active = false stops the flying and the disappearing.) Based on [[Prototype/Entity]].


== Properties ==
</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>


=== speed ===
'''Type''': [[Types/float]]


{{Prototype parent|Prototype/Entity}}
An upwards flying text that disappears after a certain time (setting active = false stops the flying and the disappearing.)
{{Prototype TOC|flying-text}}
== Mandatory properties ==
{{Prototype property|speed|[[Types/float|float]]}}
How fast the text flies up. Seems to be tiles/tick.
How fast the text flies up. Seems to be tiles/tick.


=== time_to_live ===
{{Prototype property|time_to_live|[[Types/uint32|uint32]]}}
'''Type''': [[Types/uint32]]
 
Time in ticks this flying-text lasts.
Time in ticks this flying-text lasts.


=== text_alignment ===
== Optional properties ==
'''Type''': [[Types/string]]
 
'''Default''': "left"


{{Prototype property|text_alignment|[[Types/string|string]]|"left"|optional=true}}
Options: "left", "center", "right"
Options: "left", "center", "right"

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/FlyingTextPrototype.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/FlyingText


An upwards flying text that disappears after a certain time (setting active = false stops the flying and the disappearing.)


Prototype/FlyingText — flying-text
speed::float
time_to_live::uint32
text_alignment::string (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

speed

Type: float
How fast the text flies up. Seems to be tiles/tick.

time_to_live

Type: uint32
Time in ticks this flying-text lasts.

Optional properties

text_alignment

Type: string
Default: "left"
Options: "left", "center", "right"

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