TextMeshPro components
There are 8 TextMeshPro components.
TMP_Dropdown
Section titled “TMP_Dropdown”| Types | TMPro.TMP_Dropdown |
| Transform | Gets a RectTransform |
It has 35 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
alphaFadeSpeed | float | 0.15 | |
animationTriggers.disabledTrigger | string | Disabled | |
animationTriggers.highlightedTrigger | string | Highlighted | |
animationTriggers.normalTrigger | string | Normal | |
animationTriggers.pressedTrigger | string | Pressed | |
animationTriggers.selectedTrigger | string | Selected | |
captionImage | Image | None | A path to an object in the same prefab |
captionText | TMP_Text | None | A path to an object in the same prefab |
colors.colorMultiplier | float | 1 | |
colors.disabledColor | Color | #C8C8C880 | |
colors.fadeDuration | float | 0.1 | ≥ 0 |
colors.highlightedColor | Color | #F5F5F5 | |
colors.normalColor | Color | #FFFFFF | |
colors.pressedColor | Color | #C8C8C8 | |
colors.selectedColor | Color | #F5F5F5 | |
enabled | bool | true | |
interactable | bool | true | |
itemImage | Image | None | A path to an object in the same prefab |
itemText | TMP_Text | None | A path to an object in the same prefab |
navigation.mode | Enumerations | Automatic | None・Horizontal・Vertical・Automatic・Explicit |
navigation.selectOnDown | Selectable | None | A path to an object in the same prefab |
navigation.selectOnLeft | Selectable | None | A path to an object in the same prefab |
navigation.selectOnRight | Selectable | None | A path to an object in the same prefab |
navigation.selectOnUp | Selectable | None | A path to an object in the same prefab |
navigation.wrapAround | bool | false | |
onValueChanged | UnityEvent | None | |
placeholder | Graphic | None | A path to an object in the same prefab |
spriteState.disabledSprite | Sprite | None | |
spriteState.highlightedSprite | Sprite | None | |
spriteState.pressedSprite | Sprite | None | |
spriteState.selectedSprite | Sprite | None | |
targetGraphic | Graphic | None | A path to an object in the same prefab |
template | RectTransform | None | A path to an object in the same prefab |
transition | Enumerations | ColorTint | None・ColorTint・SpriteSwap・Animation |
value | int | 0 |
Attributes of the child element <OptionData> (Arrays of structs) | Types | Default value |
|---|---|---|
text | string | Empty |
image | Sprite asset | None |
TMP_InputField
Section titled “TMP_InputField”| Types | TMPro.TMP_InputField |
It has 65 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
animationTriggers.disabledTrigger | string | Disabled | |
animationTriggers.highlightedTrigger | string | Highlighted | |
animationTriggers.normalTrigger | string | Normal | |
animationTriggers.pressedTrigger | string | Pressed | |
animationTriggers.selectedTrigger | string | Selected | |
caretBlinkRate | float | 0.85 | |
caretColor | Color | #323232 | |
caretWidth | int | 1 | |
characterLimit | int | 0 | ≥ 0 |
characterValidation | Enumerations | None | None・Digit・Integer・Decimal・Alphanumeric・Name・Regex・EmailAddress・CustomValidator |
colors.colorMultiplier | float | 1 | |
colors.disabledColor | Color | #C8C8C880 | |
colors.fadeDuration | float | 0.1 | ≥ 0 |
colors.highlightedColor | Color | #F5F5F5 | |
colors.normalColor | Color | #FFFFFF | |
colors.pressedColor | Color | #C8C8C8 | |
colors.selectedColor | Color | #F5F5F5 | |
contentType | Enumerations | Standard | Standard・Autocorrected・IntegerNumber・DecimalNumber・Alphanumeric・Name・EmailAddress・Password・Pin・Custom |
customCaretColor | bool | false | |
enabled | bool | true | |
globalFontAsset | TMP_FontAsset | None | |
globalPointSize | float | 14 | |
inputType | Enumerations | Standard | Standard・AutoCorrect・Password |
interactable | bool | true | |
isRichTextEditingAllowed | bool | false | |
keyboardType | Enumerations | Default | Default・ASCIICapable・NumbersAndPunctuation・URL・NumberPad・PhonePad・NamePhonePad・EmailAddress・NintendoNetworkAccount・Social・Search・DecimalPad・OneTimeCode |
layoutGroup | LayoutGroup | None | A path to an object in the same prefab |
lineLimit | int | 0 | |
lineType | Enumerations | SingleLine | SingleLine・MultiLineSubmit・MultiLineNewline |
navigation.mode | Enumerations | Automatic | None・Horizontal・Vertical・Automatic・Explicit |
navigation.selectOnDown | Selectable | None | A path to an object in the same prefab |
navigation.selectOnLeft | Selectable | None | A path to an object in the same prefab |
navigation.selectOnRight | Selectable | None | A path to an object in the same prefab |
navigation.selectOnUp | Selectable | None | A path to an object in the same prefab |
navigation.wrapAround | bool | false | |
onDeselect | UnityEvent | None | |
onEndEdit | UnityEvent | None | |
onEndTextSelection | UnityEvent | None | |
onFocusSelectAll | bool | true | |
onSelect | UnityEvent | None | |
onSubmit | UnityEvent | None | |
onTextSelection | UnityEvent | None | |
onTouchScreenKeyboardStatusChanged | UnityEvent | None | |
onValueChanged | UnityEvent | None | |
placeholder | Graphic | None | A path to an object in the same prefab |
readOnly | bool | false | |
regexValue | string | Empty | |
resetOnDeActivation | bool | true | |
restoreOriginalTextOnEscape | bool | true | |
richText | bool | true | |
scrollSensitivity | float | 1 | |
selectionColor | Color | #A8CEFFC0 | |
shouldHideMobileInput | bool | false | |
shouldHideSoftKeyboard | bool | false | |
spriteState.disabledSprite | Sprite | None | |
spriteState.highlightedSprite | Sprite | None | |
spriteState.pressedSprite | Sprite | None | |
spriteState.selectedSprite | Sprite | None | |
targetGraphic | Graphic | None | A path to an object in the same prefab |
text | string | Empty | |
textComponent | TMP_Text | None | A path to an object in the same prefab |
textViewport | RectTransform | None | A path to an object in the same prefab |
transition | Enumerations | ColorTint | None・ColorTint・SpriteSwap・Animation |
verticalScrollbar | Scrollbar | None | A path to an object in the same prefab |
verticalScrollbarEventHandler | TMP_ScrollbarEventHandler | None | A path to an object in the same prefab |
TMP_ScrollbarEventHandler
Section titled “TMP_ScrollbarEventHandler”| Types | TMPro.TMP_ScrollbarEventHandler |
It has 2 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
enabled | bool | true | |
isSelected | bool | false |
TMP_SelectionCaret
Section titled “TMP_SelectionCaret”| Types | TMPro.TMP_SelectionCaret |
| Components added automatically | CanvasRenderer |
| Transform | Gets a RectTransform |
It has 7 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
color | Color | #FFFFFF | |
enabled | bool | true | |
maskable | bool | true | |
material | Material | None | |
onCullStateChanged | UnityEvent | None | |
raycastPadding | Vector4 | 0 0 0 0 | |
raycastTarget | bool | true |
TMP_SpriteAnimator
Section titled “TMP_SpriteAnimator”| Types | TMPro.TMP_SpriteAnimator |
It has 1 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
enabled | bool | true |
TextContainer
Section titled “TextContainer”| Types | TMPro.TextContainer |
| Transform | Gets a RectTransform |
It has 5 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
anchorPosition | Enumerations | Middle | TopLeft・Top・TopRight・Left・Middle・Right・BottomLeft・Bottom・BottomRight・Custom |
enabled | bool | true | |
margins | Vector4 | 0 0 0 0 | |
pivot | Vector2 | 0 0 | |
rect | Rect | 0 0 0 0 |
TextMeshPro
Section titled “TextMeshPro”| Types | TMPro.TextMeshPro |
| Components added automatically | MeshRenderer |
| Transform | Gets a RectTransform |
It has 71 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
_SortingLayer | int | 0 | |
characterSpacing | float | 0 | |
characterWidthAdjustment | float | 0 | |
checkPaddingRequired | bool | false | |
color | Color | #FFFFFF | |
colorGradientPreset | TMP_ColorGradient | None | |
colorMode | Enumerations | FourCornersGradient | Single・HorizontalGradient・VerticalGradient・FourCornersGradient |
enableAutoSizing | bool | false | |
enableCulling | bool | false | |
enableKerning | bool | true | |
enableVertexGradient | bool | false | |
enableWordWrapping | bool | true | |
enabled | bool | true | |
extraPadding | bool | false | |
fontAsset | TMP_FontAsset | A default asset | |
fontColorGradient.bottomLeft | Color | #FFFFFF | |
fontColorGradient.bottomRight | Color | #FFFFFF | |
fontColorGradient.topLeft | Color | #FFFFFF | |
fontColorGradient.topRight | Color | #FFFFFF | |
fontMaterial | Material | None | |
fontMaterials | List (Material) | Empty | A path to an asset |
fontSharedMaterial | Material | A default asset | |
fontSharedMaterials | List (Material) | Empty | A path to an asset |
fontSize | float | 36 | |
fontSizeBase | float | 36 | |
fontSizeMax | float | 72 | |
fontSizeMin | float | 18 | |
fontStyle | Enum (combinable) | Normal | Normal・Bold・Italic・Underline・LowerCase・UpperCase・SmallCaps・Strikethrough・Superscript・Subscript・Highlight |
fontWeight | Enumerations | Regular | Thin・ExtraLight・Light・Regular・Medium・SemiBold・Bold・Heavy・Black |
geometrySortingOrder | Enumerations | Normal | Normal・Reverse |
hasFontAssetChanged | bool | false | |
horizontalAlignment | Enumerations | Left | Left・Center・Right・Justified・Flush・Geometry |
horizontalMapping | Enumerations | Character | Character・Line・Paragraph・MatchAspect |
isOrthographic | bool | false | |
isRightToLeftText | bool | false | |
isTextObjectScaleStatic | bool | false | |
isUsingLegacyAnimationComponent | bool | false | |
isVolumetricText | bool | false | |
lineSpacing | float | 0 | |
lineSpacingAdjustment | float | 0 | |
linkedTextComponent | TMP_Text | None | A path to an object in the same prefab |
mappingUvLineOffset | float | 0 | |
margin | Vector4 | 0 0 0 0 | |
maskType | Enumerations | MaskOff | MaskOff・MaskHard・MaskSoft |
maskable | bool | true | |
material | Material | None | |
onCullStateChanged | UnityEvent | None | |
overflowMode | Enumerations | Overflow | Overflow・Ellipsis・Masking・Truncate・ScrollRect・Page・Linked |
overrideColorTags | bool | false | |
pageToDisplay | int | 1 | |
paragraphSpacing | float | 0 | |
parentLinkedComponent | TMP_Text | None | A path to an object in the same prefab |
parseCtrlCharacters | bool | true | |
raycastPadding | Vector4 | 0 0 0 0 | |
raycastTarget | bool | true | |
renderer | Renderer | . | A path to an object in the same prefab |
richText | bool | true | |
sortingLayerID | int | 0 | |
sortingOrder | int | 0 | |
spriteAsset | TMP_SpriteAsset | None | |
styleSheet | TMP_StyleSheet | None | |
text | string | Empty | |
textAlignment | Enumerations | Converted | TopLeft・Top・TopRight・TopJustified・TopFlush・TopGeoAligned・Left・Center・Right・Justified・Flush・CenterGeoAligned・BottomLeft・Bottom・BottomRight・BottomJustified・BottomFlush・BottomGeoAligned・BaselineLeft・Baseline・BaselineRight・BaselineJustified・BaselineFlush・BaselineGeoAligned・MidlineLeft・Midline・MidlineRight・MidlineJustified・MidlineFlush・MidlineGeoAligned・CaplineLeft・Capline・CaplineRight・CaplineJustified・CaplineFlush・CaplineGeoAligned・Converted |
textStyleHashCode | int | 0 | |
tintAllSprites | bool | false | |
useMaxVisibleDescender | bool | true | |
vertexBufferAutoSizeReduction | bool | false | |
verticalAlignment | Enumerations | Top | Top・Middle・Bottom・Baseline・Geometry・Capline |
verticalMapping | Enumerations | Character | Character・Line・Paragraph・MatchAspect |
wordSpacing | float | 0 | |
wordWrappingRatios | float | 0.4 |
TextMeshProUGUI
Section titled “TextMeshProUGUI”| Types | TMPro.TextMeshProUGUI |
| Components added automatically | CanvasRenderer |
| Transform | Gets a RectTransform |
It has 68 attributes.
| Attributes | Types | Default value | Choices |
|---|---|---|---|
baseMaterial | Material | None | |
characterSpacing | float | 0 | |
characterWidthAdjustment | float | 0 | |
checkPaddingRequired | bool | false | |
color | Color | #FFFFFF | |
colorGradientPreset | TMP_ColorGradient | None | |
colorMode | Enumerations | FourCornersGradient | Single・HorizontalGradient・VerticalGradient・FourCornersGradient |
enableAutoSizing | bool | false | |
enableCulling | bool | false | |
enableKerning | bool | true | |
enableVertexGradient | bool | false | |
enableWordWrapping | bool | true | |
enabled | bool | true | |
extraPadding | bool | false | |
fontAsset | TMP_FontAsset | A default asset | |
fontColorGradient.bottomLeft | Color | #FFFFFF | |
fontColorGradient.bottomRight | Color | #FFFFFF | |
fontColorGradient.topLeft | Color | #FFFFFF | |
fontColorGradient.topRight | Color | #FFFFFF | |
fontMaterial | Material | None | |
fontMaterials | List (Material) | Empty | A path to an asset |
fontSharedMaterial | Material | A default asset | |
fontSharedMaterials | List (Material) | Empty | A path to an asset |
fontSize | float | 36 | |
fontSizeBase | float | 36 | |
fontSizeMax | float | 72 | |
fontSizeMin | float | 18 | |
fontStyle | Enum (combinable) | Normal | Normal・Bold・Italic・Underline・LowerCase・UpperCase・SmallCaps・Strikethrough・Superscript・Subscript・Highlight |
fontWeight | Enumerations | Regular | Thin・ExtraLight・Light・Regular・Medium・SemiBold・Bold・Heavy・Black |
geometrySortingOrder | Enumerations | Normal | Normal・Reverse |
hasFontAssetChanged | bool | false | |
horizontalAlignment | Enumerations | Left | Left・Center・Right・Justified・Flush・Geometry |
horizontalMapping | Enumerations | Character | Character・Line・Paragraph・MatchAspect |
isOrthographic | bool | true | |
isRightToLeftText | bool | false | |
isTextObjectScaleStatic | bool | false | |
isUsingLegacyAnimationComponent | bool | false | |
isVolumetricText | bool | false | |
lineSpacing | float | 0 | |
lineSpacingAdjustment | float | 0 | |
linkedTextComponent | TMP_Text | None | A path to an object in the same prefab |
mappingUvLineOffset | float | 0 | |
margin | Vector4 | 0 0 0 0 | |
maskOffset | Vector4 | 0 0 0 0 | |
maskable | bool | true | |
material | Material | None | |
onCullStateChanged | UnityEvent | None | |
overflowMode | Enumerations | Overflow | Overflow・Ellipsis・Masking・Truncate・ScrollRect・Page・Linked |
overrideColorTags | bool | false | |
pageToDisplay | int | 1 | |
paragraphSpacing | float | 0 | |
parentLinkedComponent | TMP_Text | None | A path to an object in the same prefab |
parseCtrlCharacters | bool | true | |
raycastPadding | Vector4 | 0 0 0 0 | |
raycastTarget | bool | true | |
richText | bool | true | |
spriteAsset | TMP_SpriteAsset | None | |
styleSheet | TMP_StyleSheet | None | |
text | string | Empty | |
textAlignment | Enumerations | Converted | TopLeft・Top・TopRight・TopJustified・TopFlush・TopGeoAligned・Left・Center・Right・Justified・Flush・CenterGeoAligned・BottomLeft・Bottom・BottomRight・BottomJustified・BottomFlush・BottomGeoAligned・BaselineLeft・Baseline・BaselineRight・BaselineJustified・BaselineFlush・BaselineGeoAligned・MidlineLeft・Midline・MidlineRight・MidlineJustified・MidlineFlush・MidlineGeoAligned・CaplineLeft・Capline・CaplineRight・CaplineJustified・CaplineFlush・CaplineGeoAligned・Converted |
textStyleHashCode | int | 0 | |
tintAllSprites | bool | false | |
useMaxVisibleDescender | bool | true | |
vertexBufferAutoSizeReduction | bool | false | |
verticalAlignment | Enumerations | Top | Top・Middle・Bottom・Baseline・Geometry・Capline |
verticalMapping | Enumerations | Character | Character・Line・Paragraph・MatchAspect |
wordSpacing | float | 0 | |
wordWrappingRatios | float | 0.4 |