Unity |
Base class for a Unity UI Player Controller Element Glyph component.
Displays glyphs / text for a specific Action for a Player.
Inheritance HierarchySystemObject
Object
Component
Behaviour
MonoBehaviour
Rewired.GlyphsControllerElementGlyphBase
Rewired.Glyphs.UnityUIUnityUIControllerElementGlyphBase
Rewired.Glyphs.UnityUIUnityUIPlayerControllerElementGlyphBase
Rewired.Glyphs.UnityUIUnityUIPlayerControllerElementGlyph
Object
Component
Behaviour
MonoBehaviour
Rewired.GlyphsControllerElementGlyphBase
Rewired.Glyphs.UnityUIUnityUIControllerElementGlyphBase
Rewired.Glyphs.UnityUIUnityUIPlayerControllerElementGlyphBase
Rewired.Glyphs.UnityUIUnityUIPlayerControllerElementGlyph
Namespace: Rewired.Glyphs.UnityUI
Assembly: Rewired_Glyphs (in Rewired_Glyphs.dll) Version: 0.0.0.0
SyntaxC#
public abstract class UnityUIPlayerControllerElementGlyphBase : UnityUIControllerElementGlyphBase
The UnityUIPlayerControllerElementGlyphBase type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | action1FirstPole | Determines the display order of split-axis and button glyphs for the first Action. When two glyphs for a axis-type action are displayed, this determines which pole is displayed first. |
| action2FirstPole | Determines the display order of split-axis and button glyphs for the second Action. When two glyphs for an axis-type action are displayed, this determines which pole is displayed first. |
| actionId | The Action id. |
| actionId2 | The second Action id (for 2D Actions). |
| actionRange | The range of the Action for which to show glyphs / text. This determines whether to show the glyph for an axis-type Action (ex: Move Horizontal), or the positive/negative pole of an Action (ex: Move Right). For button-type Actions, Full and Positive are equivalent. This value has no effect when displaying two Actions. |
| allowedTypes |
Determines what types of objects are allowed.
(Inherited from ControllerElementGlyphBase) |
| animation | (Inherited from Component) Obsolete |
| audio | (Inherited from Component) Obsolete |
| 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) |
| glyphOrTextPrefab |
If set, when glyph/text objects are created, they will be instantiated from this prefab.
If left blank, the global default prefab will be used.
(Inherited from ControllerElementGlyphBase) |
| group1 | Optional parent Transform of the first group of instantiated glyph / text objects. For a single Action query, if an axis-type Action is bound to multiple elements, the glyphs bound to the negative pole of the Action will be instantiated under this Transform. For a two Action query, if multiple glyphs are returned, the glyphs bound to the first Action will be instantiated under this Transform. If a single glyph is returned, it will be instantiated under this Transform as well. This allows you to separate results by negative / positive binding or Action 1 / Action 2 in order to stack glyph groups horizontally or vertically, for example. If an Action is only bound to one element, the glyph will be instantiated under this transform. If blank, objects will be created as children of this object's Transform. |
| group2 | Optional parent Transform of the second group of instantiated glyph / text objects. For a single Action query, if an axis-type Action is bound to multiple elements, the glyphs bound to the positive pole of the Action will be instantiated under this Transform. For a two Action query, if multiple glyphs are returned, the glyphs bound to the second Action will be instantiated under this Transform unless there were no results found for the first Action, in which case they will be displayed under group1. Otherwise, if a single glyph is returned, it will be instantiated under group1. This allows you to separate results by negative / positive binding or Action 1 / Action 2 in order to stack glyph groups horizontally or vertically, for example. If an Action is only bound to one element, the glyph will be instantiated under group1 instead. If blank,If blank, objects will be created as children of either group1 if set or the object's Transform. |
| 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) |
| 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. |
| particleSystem | (Inherited from Component) Obsolete |
| playerId | The Player id. |
| renderer | (Inherited from Component) Obsolete |
| result2dSelectionHandler | Allows you to evaluate all the results and decide which to display for two Actions. This only works if combining two Actions. If using a single Action, use resultSelectionHandler 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. |
| resultIndex | The index of the result to return. This can be used to return, for example, the second matching glpyh(s) instead of the first found. This will be ignored if you are using a custom result selector. |
| resultSelectionHandler | Allows you to evaluate all the results and decide which to display. This only works for single Actions. If combining two Actions, use result2dSelectionHandler 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) |
| tag | (Inherited from 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) |
| 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) |
| RequireRebuild |
Clears all instantiated glyph / text objects so they can be recreated from the prefab.
(Inherited from ControllerElementGlyphBase) |
| 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