Component:DynamicSpriteFont: Difference between revisions

Latest revision as of 06:01, 17 March 2025

Component image

**Dynamic Sprite Font** component as seen in the Scene Inspector

The DynamicSpriteFont component is used to construct a font asset that can be used to create custom fonts character by character.

This component can cause memory leaks! See Issue #2771

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`HighPriorityIntegration`	Bool	If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
`MaxSize`	Int	The max size of a glyph in the font sheet.
`Glyphs`	list of DynamicSpriteFont.SpriteGlyph	A list of Font characters that should make up this dynamic font.

Glyph Example

SpriteGlyph

Fields
Name	Type	Description
`SpriteURL`	Uri	The resource URI of the Font character.
`UnicodeCodepoint`	UInt	the Unicode number of this Font character. See Wikipedia list of unicode characters.
`SpriteName`	String	The name of the Sprite.
`Bearing`	Float2	See Glyph Example.
`Advance`	Float2	See Glyph Example.
`Size`	Float	See Glyph Example.
`Tintable`	Bool	Whether this glyph is affectable by Font color.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 7: / Line 7: @@
 }}
 The '''DynamicSpriteFont''' component is used to construct a font asset that can be used to create custom fonts character by character.
+{{Note|This component can cause memory leaks! See [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/2771 Issue #2771]|danger}}
 <!--T:2-->
@@ Line 13: / Line 15: @@
 |HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
 |MaxSize|Int| The max size of a glyph in the font sheet.
-|Glyphs|{{RootFieldType|SyncList`1|[[#SpriteGlyph|SpriteGlyph]]}}|TypeAdv2=true| A list of Font characters that should make up this dynamic font.
+|Glyphs|{{RootFieldType|SyncList`1|[[#SpriteGlyph|DynamicSpriteFont.SpriteGlyph]]}}|TypeAdv2=true| A list of Font characters that should make up this dynamic font.
 }}
+== Glyph Example ==
+[[File:freetype2_docs_glyphs_glyph-metrics-3.png|thumb|none|upright=1.7]]
 == SpriteGlyph ==
@@ Line 21: / Line 26: @@
 |UnicodeCodepoint|UInt| the Unicode number of this Font character. See [https://en.m.wikipedia.org/wiki/List_of_Unicode_characters Wikipedia list of unicode characters].
 |SpriteName|String| The name of the Sprite.
-|Bearing|Float2| The gap from this glyph from other Glyphs on the sheet.
+|Bearing|Float2| See [[#Glyph Example|Glyph Example]].
-|Advance|Float2| How much to advance the cursor when making the sheet.
+|Advance|Float2| See [[#Glyph Example|Glyph Example]].
-|Size|Float| the size of the glyph on the sheet.
+|Size|Float| See [[#Glyph Example|Glyph Example]].
 |Tintable|Bool| Whether this glyph is affectable by Font color.
 }}