Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TrueTypeFontImporter

class in UnityEditor

/

Inherits from: AssetImporter

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

AssetImporter for importing Fonts.

Variables

ascentCalculationModeCalculation mode for determining font's ascent.
characterPaddingBorder pixels added to character images for padding. This is useful if you want to render text using a shader which needs to render outside of the character area (like an outline shader).
characterSpacingSpacing between character images in the generated texture in pixels. This is useful if you want to render text using a shader which samples pixels outside of the character area (like an outline shader).
customCharactersA custom set of characters to be included in the Font Texture.
fontNamesAn array of font names, to be used when includeFontData is set to false.
fontReferencesReferences to other fonts to be used looking for fallbacks.
fontRenderingModeFont rendering mode to use for this font.
fontSizeFont size to use for importing the characters.
fontTextureCaseUse this to adjust which characters should be imported.
fontTTFNameThe internal font name of the TTF file.
includeFontDataIf this is enabled, the actual font will be embedded into the asset for Dynamic fonts.

Public Functions

GenerateEditableFontCreate an editable copy of the font asset at path.

Inherited members

Variables

assetBundleNameGet or set the AssetBundle name.
assetBundleVariantGet or set the AssetBundle variant.
assetPathThe path name of the asset for this importer. (Read Only)
userDataGet or set any user data.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

SaveAndReimportSave asset importer settings if asset importer is dirty.
SetAssetBundleNameAndVariantSet the AssetBundle name and variant.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

GetAtPathRetrieves the asset importer for the asset at path.
DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateReturns a copy of the object original.

Operators

boolDoes 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.