Prototype/Font: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (shorter file path (no steam))
(Removed old prototype docs)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Prototype parent}}
<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/FontPrototype.html https://lua-api.factorio.com/latest/prototypes/FontPrototype.html]
Fonts are used in all gui in the game.


{{Prototype TOC|font}}
</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>
 
== Mandatory properties ==
 
{{Prototype property|type|[[Types/string|string]]}}
Must be "font".
 
{{Prototype property|name|[[Types/string|string]]}}
Name of the font.
 
{{Prototype property|size|[[Types/int32|int32]]}}
Size of the font.
 
{{Prototype property|from|[[Types/string|string]]}}
The name of the fonts .ttf descriptor. This descriptor must be defined in the locale info.json. Refer to data/core/locale/_language_/info.json for examples.
 
== Optional properties ==
 
{{Prototype property|spacing|[[Types/float|float]]|0|optional=true}}
 
{{Prototype property|border|[[Types/bool|bool]]|false|optional=true}}
Whether the font has a border.
 
{{Prototype property|filtered|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|border_color|[[Types/Color|Color]]|optional=true}}
The color of the border, if enabled.
 
== Example ==
<syntaxhighlight lang="lua">{
    type = "font",
    name = "default-button",
    from = "default-bold",
    size = 18
  },</syntaxhighlight>

Latest revision as of 14:32, 25 October 2024

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/FontPrototype.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.