Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

TextSettings

class in UnityEngine.TextCore.Text

/

Inherits from:ScriptableObject

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

Submission failed

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

Close

Cancel

Description

Contains deprecated TextSettings APIs that are being phased out.

Properties

Property Description
clearDynamicDataOnBuild Determines if the "Clear Dynamic Data on Build" property will be set to true or false on newly created dynamic font assets.
defaultColorGradientPresetsPath The relative path to a Resources folder in the project where the text system will look to load color gradient presets. The default location is "Resources/Color Gradient Presets".
defaultFontAssetPath The relative path to a Resources folder in the project where the text system will look to load font assets. The default location is "Resources/Fonts & Materials".
defaultSpriteAsset The Sprite Asset to be used by default.
defaultSpriteAssetPath The relative path to a Resources folder in the project where the text system will look to load sprite assets. The default location is "Resources/Sprite Assets".
defaultStyleSheet The Default Style Sheet used by the text objects.
displayWarnings Controls the display of warning messages in the console.
emojiFallbackTextAssets list of Fallback Text Assets (Font Assets and Sprite Assets) used to lookup characters defined in the Unicode as Emojis.
fallbackFontAssets List of potential font assets the text system will search recursively to look for requested characters.
version The version of the TextSettings class. Version 1.2.0 was introduced with the TextCore package

Inherited Members

Properties

PropertyDescription
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

MethodDescription
GetEntityIdGets the EntityId of the object.
ToStringReturns the name of the object.

Static Methods

MethodDescription
DestroyRemoves a GameObject, component, or asset.
DestroyImmediateDestroys the specified object immediately. Use with caution and in Edit mode only.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.
CreateInstanceCreates an instance of a scriptable object.

Operators

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

Messages

MessageDescription
AwakeCalled when an instance of ScriptableObject is created.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.