Contains deprecated FontAsset APIs that are being phased out as ATG (Advanced Text Generator) becomes the primary text backend. These APIs are no longer required for ATG-based text rendering.
| Property | Description |
|---|---|
| atlasHeight | The height of the atlas texture(s) used by this font asset. |
| atlasPadding | The padding used between glyphs contained in the atlas texture(s) used by this font asset. |
| atlasTexture | The font atlas used by this font asset. This is always the texture at index [0] of the fontAtlasTextures. |
| atlasTextureCount | Number of atlas textures used by this font asset. |
| atlasTextures | Array of atlas textures that contain the glyphs used by this font asset. |
| atlasWidth | The width of the atlas texture(s) used by this font asset. |
| boldStyleSpacing | The spacing between characters when using regular style. |
| boldStyleWeight | Defines the dilation of the text when using bold style. |
| faceInfo | Information about the font's face. |
| fallbackFontAssetTable | List containing the Fallback font assets for this font. |
| fontAssetCreationEditorSettings | The settings used in the Font Asset Creator when this font asset was created or edited. |
| fontWeightTable | Array containing font assets to be used as alternative typefaces for the various potential font weights of this font asset. |
| getFontFeatures | Determines if OpenType font features should be retrieved from the source font file as new characters and glyphs are added dynamically to the font asset. |
| isMultiAtlasTexturesEnabled | Enables the font asset to create additional atlas textures as needed. |
| italicStyleSlant | Defines the slant of the text when using italic style. |
| regularStyleSpacing | The spacing between characters when using regular style. |
| regularStyleWeight | Defines the dilation of the text when using regular style. |
| sourceFontFile | Source font file when atlas population mode is set to dynamic. Null when the atlas population mode is set to static. |
| tabMultiple | The number of spaces that a tab represents. |
| Method | Description |
|---|---|
| ClearFontAssetData | Clears font asset data including the glyph and character tables and textures. Function might be changed to Internal and only used in tests. |
| HasCharacter | Function to check if a certain character exists in the font asset. |
| HasCharacters | Function to check if certain characters exists in the font asset. Function returns a list of missing characters. |
| ReadFontAssetDefinition | Reads the various data tables of the font asset and populates various data structures to allow for faster lookup of related font asset data. |
| TryAddCharacters | Try adding the characters from the provided string to the font asset. |
| Method | Description |
|---|---|
| CreateFontAsset | Creates a new font asset instance from the given family name and style. |
| GetCharacters | Function to extract all the characters from a font asset. |
| GetCharactersArray | Function which returns an array that contains all the characters from a font asset. |
| Property | Description |
|---|---|
| hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
| name | The name of the object. |
| Method | Description |
|---|---|
| GetEntityId | Gets the EntityId of the object. |
| ToString | Returns the name of the object. |
| Method | Description |
|---|---|
| Destroy | Removes a GameObject, component, or asset. |
| DestroyImmediate | Destroys the specified object immediately. Use with caution and in Edit mode only. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindAnyObjectByType | Retrieves any active loaded object of Type type. |
| FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
| CreateInstance | Creates an instance of a scriptable object. |
| Operator | Description |
|---|---|
| bool | Does the object exist? |
| operator != | Compares if two objects refer to a different object. |
| operator == | Compares two object references to see if they refer to the same object. |
| Message | Description |
|---|---|
| Awake | Called when an instance of ScriptableObject is created. |
| OnDestroy | This function is called when the scriptable object will be destroyed. |
| OnDisable | This function is called when the scriptable object goes out of scope. |
| OnEnable | This function is called when the object is loaded. |
| OnValidate | Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector. |
| Reset | Reset to default values. |