Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Static Public Member Functions | Properties | List of all members
TMPro.TMP_Settings Class Reference
Inheritance diagram for TMPro.TMP_Settings:

Classes

class  LineBreakingTable
 

Static Public Member Functions

static TMP_FontAsset GetFontAsset ()
 Returns the Font Asset defined in the TMP Settings file. More...
 
static TMP_Settings GetSettings ()
 Returns the Sprite Asset defined in the TMP Settings file. More...
 
static TMP_SpriteAsset GetSpriteAsset ()
 Returns the Sprite Asset defined in the TMP Settings file. More...
 
static TMP_StyleSheet GetStyleSheet ()
 Returns the Sprite Asset defined in the TMP Settings file. More...
 
static TMP_Settings LoadDefaultSettings ()
 Static Function to load the TMP Settings file. More...
 
static void LoadLinebreakingRules ()
 

Properties

static bool autoSizeTextContainer [get]
 Set the size of the text container of newly created text objects to match the size of the text. More...
 
static string defaultColorGradientPresetsPath [get]
 The relative path to a Resources folder in the project that contains Color Gradient Presets. More...
 
static TMP_FontAsset defaultFontAsset [get]
 Returns the Default Font Asset to be used by newly created text objects. More...
 
static string defaultFontAssetPath [get]
 The relative path to a Resources folder in the project. More...
 
static float defaultFontSize [get]
 The Default Point Size of newly created text objects. More...
 
static TMP_SpriteAsset defaultSpriteAsset [get]
 The Default Sprite Asset to be used by default. More...
 
static string defaultSpriteAssetPath [get]
 The relative path to a Resources folder in the project. More...
 
static TMP_StyleSheet defaultStyleSheet [get]
 The Default Style Sheet used by the text objects. More...
 
static float defaultTextAutoSizingMaxRatio [get]
 The multiplier used to computer the default Max point size when Text Auto Sizing is used. More...
 
static float defaultTextAutoSizingMinRatio [get]
 The multiplier used to computer the default Min point size when Text Auto Sizing is used. More...
 
static Vector2 defaultTextMeshProTextContainerSize [get]
 The Default Size of the Text Container of a TextMeshPro object. More...
 
static Vector2 defaultTextMeshProUITextContainerSize [get]
 The Default Width of the Text Container of a TextMeshProUI object. More...
 
static bool enableEmojiSupport [get, set]
 Determines if Emoji support is enabled in the Input Field TouchScreenKeyboard. More...
 
static bool enableExtraPadding [get]
 Controls if Extra Padding is enabled on newly created text objects by default. More...
 
static bool enableKerning [get]
 Controls if Kerning is enabled on newly created text objects by default. More...
 
static bool enableParseEscapeCharacters [get]
 Controls if Escape Characters will be parsed in the Text Input Box on newly created text objects. More...
 
static bool enableTintAllSprites [get]
 Controls if TintAllSprites is enabled on newly created text objects by default. More...
 
static bool enableWordWrapping [get]
 Controls if Word Wrapping will be enabled on newly created text objects by default. More...
 
static List< TMP_FontAssetfallbackFontAssets [get]
 Returns the list of Fallback Fonts defined in the TMP Settings file. More...
 
static TextAsset followingCharacters [get]
 Text file that contains the following characters used for line breaking for Asian languages. More...
 
static TMP_Settings instance [get]
 Get a singleton instance of the settings class. More...
 
static TextAsset leadingCharacters [get]
 Text file that contains the leading characters used for line breaking for Asian languages. More...
 
static LineBreakingTable linebreakingRules [get]
 
static bool matchMaterialPreset [get]
 Controls whether or not TMP will create a matching material preset or use the default material of the fallback font asset. More...
 
static int missingGlyphCharacter [get]
 The character the will be used as a replacement for missing glyphs in a font asset. More...
 
static string version [get]
 Returns the release version of the product. More...
 
static bool warningsDisabled [get]
 Controls the display of warning message in the console. More...
 

Member Function Documentation

static TMP_FontAsset TMPro.TMP_Settings.GetFontAsset ( )
inlinestatic

Returns the Font Asset defined in the TMP Settings file.

Returns
static TMP_Settings TMPro.TMP_Settings.GetSettings ( )
inlinestatic

Returns the Sprite Asset defined in the TMP Settings file.

Returns
static TMP_SpriteAsset TMPro.TMP_Settings.GetSpriteAsset ( )
inlinestatic

Returns the Sprite Asset defined in the TMP Settings file.

Returns
static TMP_StyleSheet TMPro.TMP_Settings.GetStyleSheet ( )
inlinestatic

Returns the Sprite Asset defined in the TMP Settings file.

Returns
static TMP_Settings TMPro.TMP_Settings.LoadDefaultSettings ( )
inlinestatic

Static Function to load the TMP Settings file.

Returns
static void TMPro.TMP_Settings.LoadLinebreakingRules ( )
inlinestatic

Property Documentation

bool TMPro.TMP_Settings.autoSizeTextContainer
staticget

Set the size of the text container of newly created text objects to match the size of the text.

string TMPro.TMP_Settings.defaultColorGradientPresetsPath
staticget

The relative path to a Resources folder in the project that contains Color Gradient Presets.

TMP_FontAsset TMPro.TMP_Settings.defaultFontAsset
staticget

Returns the Default Font Asset to be used by newly created text objects.

string TMPro.TMP_Settings.defaultFontAssetPath
staticget

The relative path to a Resources folder in the project.

float TMPro.TMP_Settings.defaultFontSize
staticget

The Default Point Size of newly created text objects.

TMP_SpriteAsset TMPro.TMP_Settings.defaultSpriteAsset
staticget

The Default Sprite Asset to be used by default.

string TMPro.TMP_Settings.defaultSpriteAssetPath
staticget

The relative path to a Resources folder in the project.

TMP_StyleSheet TMPro.TMP_Settings.defaultStyleSheet
staticget

The Default Style Sheet used by the text objects.

float TMPro.TMP_Settings.defaultTextAutoSizingMaxRatio
staticget

The multiplier used to computer the default Max point size when Text Auto Sizing is used.

float TMPro.TMP_Settings.defaultTextAutoSizingMinRatio
staticget

The multiplier used to computer the default Min point size when Text Auto Sizing is used.

Vector2 TMPro.TMP_Settings.defaultTextMeshProTextContainerSize
staticget

The Default Size of the Text Container of a TextMeshPro object.

Vector2 TMPro.TMP_Settings.defaultTextMeshProUITextContainerSize
staticget

The Default Width of the Text Container of a TextMeshProUI object.

bool TMPro.TMP_Settings.enableEmojiSupport
staticgetset

Determines if Emoji support is enabled in the Input Field TouchScreenKeyboard.

bool TMPro.TMP_Settings.enableExtraPadding
staticget

Controls if Extra Padding is enabled on newly created text objects by default.

bool TMPro.TMP_Settings.enableKerning
staticget

Controls if Kerning is enabled on newly created text objects by default.

bool TMPro.TMP_Settings.enableParseEscapeCharacters
staticget

Controls if Escape Characters will be parsed in the Text Input Box on newly created text objects.

bool TMPro.TMP_Settings.enableTintAllSprites
staticget

Controls if TintAllSprites is enabled on newly created text objects by default.

bool TMPro.TMP_Settings.enableWordWrapping
staticget

Controls if Word Wrapping will be enabled on newly created text objects by default.

List<TMP_FontAsset> TMPro.TMP_Settings.fallbackFontAssets
staticget

Returns the list of Fallback Fonts defined in the TMP Settings file.

TextAsset TMPro.TMP_Settings.followingCharacters
staticget

Text file that contains the following characters used for line breaking for Asian languages.

TMP_Settings TMPro.TMP_Settings.instance
staticget

Get a singleton instance of the settings class.

TextAsset TMPro.TMP_Settings.leadingCharacters
staticget

Text file that contains the leading characters used for line breaking for Asian languages.

LineBreakingTable TMPro.TMP_Settings.linebreakingRules
staticget

bool TMPro.TMP_Settings.matchMaterialPreset
staticget

Controls whether or not TMP will create a matching material preset or use the default material of the fallback font asset.

int TMPro.TMP_Settings.missingGlyphCharacter
staticget

The character the will be used as a replacement for missing glyphs in a font asset.

string TMPro.TMP_Settings.version
staticget

Returns the release version of the product.

bool TMPro.TMP_Settings.warningsDisabled
staticget

Controls the display of warning message in the console.


The documentation for this class was generated from the following file: