Component:DynamicSpriteFont

CollapseComponent 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 Collapse

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.