Unity |
A helper class to display Rewired glyphs and display names inline in TMPro Text (Unity UI).
Parses tags within text and replaces them with Sprites or text.
Enter text in this component's text field, not in the TMPro Text field. Text entered here
will be parsed, then the Text Mesh Pro Text component will be updated with the text, including Sprite tags.
Inheritance HierarchySystemObject
Object
Component
Behaviour
MonoBehaviour
Rewired.Glyphs.UnityUIUnityUITextMeshProGlyphHelper
Object
Component
Behaviour
MonoBehaviour
Rewired.Glyphs.UnityUIUnityUITextMeshProGlyphHelper
Namespace: Rewired.Glyphs.UnityUI
Assembly: Rewired_Glyphs (in Rewired_Glyphs.dll) Version: 0.0.0.0
SyntaxC#
public class UnityUITextMeshProGlyphHelper : MonoBehaviour
The UnityUITextMeshProGlyphHelper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | UnityUITextMeshProGlyphHelper | Initializes a new instance of the UnityUITextMeshProGlyphHelper class |
Properties| Name | Description | |
|---|---|---|
 | animation | (Inherited from Component) Obsolete |
| audio | (Inherited from Component) Obsolete |
| baseSpriteMaterial | Optional material for Sprites. If blank, the default material will be used. Material is instantiated for each Sprite Asset, so making changes to values in the base material later will not affect Sprites. Changing the base material at runtime will copy only certain properties from the new material to Sprite materials. |
| camera | (Inherited from Component) Obsolete |
| collider | (Inherited from Component) Obsolete |
| collider2D | (Inherited from Component) Obsolete |
| constantForce | (Inherited from Component) Obsolete |
| enabled | (Inherited from Behaviour) |
| gameObject | (Inherited from Component) |
| guiElement | (Inherited from Component) Obsolete |
| guiText | (Inherited from Component) Obsolete |
| guiTexture | (Inherited from Component) Obsolete |
| hideFlags | (Inherited from Object) |
| hingeJoint | (Inherited from Component) Obsolete |
| isActiveAndEnabled | (Inherited from Behaviour) |
| isRewiredElementAllowedHandler | Allows you to filter which Action Element Maps are displayed by the rewiredElement tag. When searching for mappings in the Player, the handler will be invoked for each Action Element Map found. This allows you to, for example, allow only Action Element Maps belonging to a Controller Map in particular Map Category. ActionElementMap for properties which can be used as filtering criteria. IMPORTANT: By setting this value, you are taking over the responsibility for filtering mappings results entirely. The default filter removes disabled Action Element Maps and mappings in disabled Controller Maps. Disabled mappings are no longer removed when this handler is overriden with your own, so you must check the enabled states if you want to exclude these mappings. Note: This handler overrides any handler set in isActionElementMapAllowedHandler. |
| light | (Inherited from Component) Obsolete |
| name | (Inherited from Object) |
| networkView | (Inherited from Component) Obsolete |
| options | Optional reference to an object that defines options. If blank, the global default options will be used. |
| overrideSpriteMaterialProperties | If enabled, local values such as Sprite color will be used instead of the value on the base material. |
| particleSystem | (Inherited from Component) Obsolete |
| renderer | (Inherited from Component) Obsolete |
| rewiredElementResult2dSelectionHandler | Allows you to evaluate all the results and decide which to display for the rewiredElement tag for two Actions. This only works if combining two Actions. If using a single Action, use rewiredElementResultSelectionHandler instead. After searching for mappings in the Player and collecting all possible results, the handler will be invoked. This can be used, for example, to display the second result found instead of the first. It could also be used to choose results from any user-defined criteria such as controller type, controller map cateogry, etc. ActionElementMap for properties which can be used as selection criteria. The list contains all results from the search of Action Element Maps. Each result can contain one result for each Action. Each Action result can contain either one or two Action Element Maps. The number of Action Element Maps returned depends on the bindings found. If a full-axis binding is found, it will be returned in the [!:a] field. If negative and positive split-axis bindings are found instead, at least one Action Element Map will be returned in the [!:a] (negative) or [!:b] (positive) field. |
| rewiredElementResultSelectionHandler | Allows you to evaluate all the results and decide which to display for the rewiredElement tag. This only works for single Actions. If combining two Actions, use rewiredElementResult2dSelectionHandler instead. After searching for mappings in the Player and collecting all possible results, the handler will be invoked. This can be used, for example, to display the second result found instead of the first. It could also be used to choose results from any user-defined criteria such as controller type, controller map cateogry, etc. ActionElementMap for properties which can be used as selection criteria. The list contains all results from the search of Action Element Maps given a particular Action Range. Each result can contain either one or two Action Element Maps. The number of Action Element Maps returned depends on the Action Range used for the search and the bindings found. For a full Action Range search, if a full-axis binding is found, it will be returned in the [!:a] field. If negative and positive split-axis bindings are found instead, at least one Action Element Map will be returned in the [!:a] (negative) or [!:b] (positive) field. For a positive/negative Action Range search, a single Action Element Map will be returned in the [!:a] field. |
| rigidbody | (Inherited from Component) Obsolete |
| rigidbody2D | (Inherited from Component) Obsolete |
| runInEditMode | (Inherited from MonoBehaviour) |
| spriteMaterialProperties | These properties will override the properties on the Sprite material if overrideSpriteMaterialProperties is true. |
| spriteOptions | Options that control how Text Mesh Pro displays Sprites. |
| tag | (Inherited from Component) |
 | text | Text will be parsed for special tags, and the final result will be passed on to the Text Mesh Pro Text component. |
| transform | (Inherited from Component) |
| useGUILayout | (Inherited from MonoBehaviour) |
Methods| Name | Description | |
|---|---|---|
| BroadcastMessage(String) | (Inherited from Component) |
| BroadcastMessage(String, Object) | (Inherited from Component) |
| BroadcastMessage(String, SendMessageOptions) | (Inherited from Component) |
| BroadcastMessage(String, Object, SendMessageOptions) | (Inherited from Component) |
| CancelInvoke | (Inherited from MonoBehaviour) |
| CancelInvoke(String) | (Inherited from MonoBehaviour) |
| CompareTag | (Inherited from Component) |
| Equals | (Inherited from Object) |
| ForceUpdate | Updates glyphs / text and TMPro text value immedately. Normally, this happens automatically in the Update loop. |
| GetComponent(String) | (Inherited from Component) |
| GetComponent(Type) | (Inherited from Component) |
| GetComponent``1 | (Inherited from Component) |
| GetComponentInChildren(Type) | (Inherited from Component) |
| GetComponentInChildren(Type, Boolean) | (Inherited from Component) |
| GetComponentInChildren``1 | (Inherited from Component) |
| GetComponentInChildren``1(Boolean) | (Inherited from Component) |
| GetComponentInParent(Type) | (Inherited from Component) |
| GetComponentInParent``1 | (Inherited from Component) |
| GetComponents(Type) | (Inherited from Component) |
| GetComponents(Type, ListComponent) | (Inherited from Component) |
| GetComponents``1 | (Inherited from Component) |
| GetComponents``1(ListUMP) | (Inherited from Component) |
| GetComponentsInChildren(Type) | (Inherited from Component) |
| GetComponentsInChildren(Type, Boolean) | (Inherited from Component) |
| GetComponentsInChildren``1 | (Inherited from Component) |
| GetComponentsInChildren``1(Boolean) | (Inherited from Component) |
| GetComponentsInChildren``1(ListUMP) | (Inherited from Component) |
| GetComponentsInChildren``1(Boolean, ListUMP) | (Inherited from Component) |
| GetComponentsInParent(Type) | (Inherited from Component) |
| GetComponentsInParent(Type, Boolean) | (Inherited from Component) |
| GetComponentsInParent``1 | (Inherited from Component) |
| GetComponentsInParent``1(Boolean) | (Inherited from Component) |
| GetComponentsInParent``1(Boolean, ListUMP) | (Inherited from Component) |
| GetHashCode | (Inherited from Object) |
| GetInstanceID | (Inherited from Object) |
| Invoke | (Inherited from MonoBehaviour) |
| InvokeRepeating | (Inherited from MonoBehaviour) |
| IsInvoking | (Inherited from MonoBehaviour) |
| IsInvoking(String) | (Inherited from MonoBehaviour) |
| SendMessage(String) | (Inherited from Component) |
| SendMessage(String, Object) | (Inherited from Component) |
| SendMessage(String, SendMessageOptions) | (Inherited from Component) |
| SendMessage(String, Object, SendMessageOptions) | (Inherited from Component) |
| SendMessageUpwards(String) | (Inherited from Component) |
| SendMessageUpwards(String, Object) | (Inherited from Component) |
| SendMessageUpwards(String, SendMessageOptions) | (Inherited from Component) |
| SendMessageUpwards(String, Object, SendMessageOptions) | (Inherited from Component) |
| StartCoroutine(IEnumerator) | (Inherited from MonoBehaviour) |
| StartCoroutine(String) | (Inherited from MonoBehaviour) |
| StartCoroutine(String, Object) | (Inherited from MonoBehaviour) |
| StartCoroutine_Auto | (Inherited from MonoBehaviour) Obsolete |
| StopAllCoroutines | (Inherited from MonoBehaviour) |
| StopCoroutine(Coroutine) | (Inherited from MonoBehaviour) |
| StopCoroutine(IEnumerator) | (Inherited from MonoBehaviour) |
| StopCoroutine(String) | (Inherited from MonoBehaviour) |
| ToString | (Inherited from Object) |
See Also