Class TMP_SpriteCharacter

A basic element of text representing a pictograph, image, sprite or emoji.

Inheritance

object

TMP_TextElement

TMP_SpriteCharacter

Inherited Members

TMP_TextElement.elementType

TMP_TextElement.unicode

TMP_TextElement.textAsset

TMP_TextElement.glyph

TMP_TextElement.glyphIndex

TMP_TextElement.scale

TMP_TextElement.m_ElementType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: TMPro

Assembly: Unity.TextMeshPro.dll

Syntax

[Serializable]
public class TMP_SpriteCharacter : TMP_TextElement

Constructors

TMP_SpriteCharacter()

Default constructor.

Declaration

public TMP_SpriteCharacter()

TMP_SpriteCharacter(uint, TMP_SpriteAsset, TMP_SpriteGlyph)

Constructor for new sprite character.

Declaration

public TMP_SpriteCharacter(uint unicode, TMP_SpriteAsset spriteAsset, TMP_SpriteGlyph glyph)

Parameters

Type	Name	Description
uint	unicode	Unicode value of the sprite character.
TMP_SpriteAsset	spriteAsset	Sprite Asset used by this sprite character.
TMP_SpriteGlyph	glyph	Glyph used by the sprite character.

TMP_SpriteCharacter(uint, TMP_SpriteGlyph)

Constructor for new sprite character.

Declaration

public TMP_SpriteCharacter(uint unicode, TMP_SpriteGlyph glyph)

Parameters

Type	Name	Description
uint	unicode	Unicode value of the sprite character.
TMP_SpriteGlyph	glyph	Glyph used by the sprite character.

Properties

hashCode

The hashcode value which is computed from the name of the sprite element. This value is read-only and updated when the name of the text sprite is changed.

Declaration

public int hashCode { get; }

Property Value

Type	Description
int

name

The name of the sprite element.

Declaration

public string name { get; set; }

Property Value

Type	Description
string