TextMesh

Info

TextMesh inherits from [Component](/docs/create/lua/API/Component/index.html)

A script interface for the text mesh component.

Members

Properties

Name	Description
TextMesh.alignment	How lines of text are aligned (Left, Right, Center).
TextMesh.anchor	Which point of the text shares the position of the Transform.
TextMesh.characterSize	The size of each character (This scales the whole text).
TextMesh.color	The color used to render the text.
TextMesh.fontSize	The font size to use (for dynamic fonts).
TextMesh.fontStyle	The font style to use (for dynamic fonts).
TextMesh.lineSpacing	How much space will be in-between lines of text.
TextMesh.offsetZ	How far should the text be offset from the transform.position.z when drawing.
TextMesh.richText	Enable HTML-style tags for Text Formatting Markup.
TextMesh.tabSize	How much space will be inserted for a tab '\t' character. This is a multiplum of the 'spacebar' character offset.
TextMesh.text	The text that is displayed.

Inherited Members

Inherited Properties

Name	Description
TextMesh.gameObject	The game object this component is attached to. A component is always attached to a game object.
TextMesh.tag	The tag of this game object.
TextMesh.transform	The Transform attached to this GameObject.
TextMesh.hideFlags	Should the object be hidden, saved with the Scene or modifiable by the user?
TextMesh.name	The name of the object.

Inherited Methods

Name	Description
TextMesh.BroadcastMessage(methodName, parameter=nil)	Calls the method named methodName on every Lua Script in this game object or any of its children.
TextMesh.CompareTag(tag)	Is this game object tagged with tag ?
TextMesh.GetAllLuaScripts()	Returns an array of all Lua scripts that attached to the game object.
TextMesh.GetComponent(type)	Returns the component of Type type if the game object has one attached, nil if it doesn't.
TextMesh.GetComponentInChildren(t)	Returns the component of Type type in the GameObject or any of its children using depth first search.
TextMesh.GetComponentInParent(t)	Returns the component of Type type in the GameObject or any of its parents.
TextMesh.GetComponents(type)	Returns all components of Type type in the GameObject.
TextMesh.GetComponentsInChildren(t)	Returns all components of Type type in the GameObject or any of its children.
TextMesh.GetComponentsInParent(t)	Returns all components of Type type in the GameObject or any of its parents.
TextMesh.SendMessage(methodName, value=nil)	Calls the method named methodName on every Lua Script in this game object.
TextMesh.SendMessageUpwards(methodName, value=nil)	Calls the method named methodName on every LuaScript in this game object and on every ancestor of the behaviour.
TextMesh.TryGetComponent(type)	Gets the component of the specified type, if it exists.
TextMesh.GetInstanceID()	Returns the instance id of the object.