summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorfollower <follower@rancidbacon.com>2019-04-06 23:06:08 +1300
committerGitHub <noreply@github.com>2019-04-06 23:06:08 +1300
commitc89cc44a5e73de4d5c9558a224f5bfa99d538974 (patch)
tree6ee78ed15fb7d55f743122e3e1dcbe31fc0f1b6c /doc/classes
parent506ff1f065936153efef0ace24e0d922b999b9e6 (diff)
Add example of loading a font from .ttf file
As this is a multi-step process it would be nice to have this documented.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/DynamicFont.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml
index 500da1b30f..b3bb711db2 100644
--- a/doc/classes/DynamicFont.xml
+++ b/doc/classes/DynamicFont.xml
@@ -5,6 +5,12 @@
</brief_description>
<description>
DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths.
+ [codeblock]
+ var dynamic_font = DynamicFont.new()
+ dynamic_font.font_data = load("res://BarlowCondensed-Bold.ttf")
+ dynamic_font.size = 64
+ $"Label".set("custom_fonts/font", dynamic_font)
+ [/codeblock]
</description>
<tutorials>
</tutorials>