Editor.Assets.FontCollection
ClassAn ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
const collection = model.project.assetManager.assets.find((a) => a.isOfType('FontCollection')) as
| Editor.Assets.FontCollection
| undefined;
const obj = scene.createSceneObject('TaggedText');
const text = obj.addComponent('Text');
text.text = '<b>Bold</b> and <i>italic</i> tags';
text.enableRichText = true;
text.size = 36;
if (collection && !Editor.isNull(collection)) {
text.fontSource = collection;
console.log(`Text using FontCollection "${collection.name}" with rich-text tags`);
} else {
console.log('No FontCollection found; rich-text rendering uses default font');
}
Extends
Properties
cacheFile
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
entries
entries:
FontCollectionEntry[]
Ordered list of font entries that make up this collection.
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
readonlyname:string
The name of the asset.
Inherited from
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Asset.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean