Automated: create new component page |
Automated: update 'HighPriorityIntegration' description |
||
(One intermediate revision by one other user not shown) | |||
Line 3: | Line 3: | ||
|Name=Font Chain | |Name=Font Chain | ||
}} | }} | ||
The '''FontChain''' component provides an easy way to use "Fallback" fonts for a main font, usually in the event that the main font does not contain certain Unicode characters. Any place where a [[Component:StaticFont|StaticFont]] can be used, a FontChain can be used. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|HighPriorityIntegration|Bool| | |HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}} | ||
|MainFont|{{RootFieldType|AssetRef`1|[[Type:Font|Font]]}}|TypeAdv1=true| | |MainFont|{{RootFieldType|AssetRef`1|[[Type:Font|Font]]}}|TypeAdv1=true|The main font to use. | ||
|FallbackFonts|{{RootFieldType|SyncAssetList`1|[[Type:Font|Font]]}}|TypeAdv2=true| | |FallbackFonts|{{RootFieldType|SyncAssetList`1|[[Type:Font|Font]]}}|TypeAdv2=true|The fallback fonts to use. | ||
}} | }} | ||
== Behavior == | == Behavior == | ||
The <code>MainFont</code> defines which font will be primarily used for the text. For any characters of a text that do not exist in the main font, all the <code>FallbackFonts</code> will be searched through, in order, to find a matching character. Only if all fallback fonts do not contain the character will a "true fallback" of a box will appear. | |||
== Examples == | == Examples == |
Latest revision as of 11:59, 1 August 2024
Component image
The FontChain component provides an easy way to use "Fallback" fonts for a main font, usually in the event that the main font does not contain certain Unicode characters. Any place where a StaticFont can be used, a FontChain can be used.
Usage
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. |
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. |
MainFont
|
Font | The main font to use. |
FallbackFonts
|
list of Font | The fallback fonts to use. |
Behavior
The MainFont
defines which font will be primarily used for the text. For any characters of a text that do not exist in the main font, all the FallbackFonts
will be searched through, in order, to find a matching character. Only if all fallback fonts do not contain the character will a "true fallback" of a box will appear.