Prototype/Font: Difference between revisions

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

Prototype definitions » Prototype/Font

Fonts are used in all gui in the game.

Prototype/Font — `font`
from	::	string
name	::	string
size	::	int32
type	::	string
border	::	bool (optional)
border_color	::	Color (optional)
filtered	::	bool (optional)
spacing	::	float (optional)

Mandatory properties

type

Type: string
Must be "font".

name

Type: string
Name of the font.

size

Type: int32
Size of the font.

from

Type: 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

spacing

Type: float
Default: 0

border

Type: bool
Default: false
Whether the font has a border.

filtered

Type: bool
Default: false

border_color

Type: Color
The color of the border, if enabled.

Example

{
    type = "font",
    name = "default-button",
    from = "default-bold",
    size = 18
  },

@@ 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/FontPrototype.html https://lua-api.factorio.com/latest/prototypes/FontPrototype.html]
+</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}}
 Fonts are used in all gui in the game.
+{{Prototype TOC|font}}
 == Mandatory properties ==
-=== type ===
+{{Prototype property|type|[[Types/string|string]]}}
-'''Type''': [[Types/string]]
 Must be "font".
-=== name ===
+{{Prototype property|name|[[Types/string|string]]}}
-'''Type''': [[Types/string]]
 Name of the font.
-=== size ===
+{{Prototype property|size|[[Types/int32|int32]]}}
-'''Type''': [[Types/uint]]
 Size of the font.
-=== from ===
+{{Prototype property|from|[[Types/string|string]]}}
-'''Type''': [[Types/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 ==
-=== border ===
+{{Prototype property|spacing|[[Types/float|float]]|0|optional=true}}
-'''Type''': [[Types/bool]]
+{{Prototype property|border|[[Types/bool|bool]]|false|optional=true}}
 Whether the font has a border.
-=== border_color ===
+{{Prototype property|filtered|[[Types/bool|bool]]|false|optional=true}}
-'''Type''': [[Types/color]]
+{{Prototype property|border_color|[[Types/Color|Color]]|optional=true}}
 The color of the border, if enabled.