Class Tooltip
Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
UnityEngine.EventSystems.UIBehaviour
Tooltip
Inherited Members
UnityEngine.EventSystems.UIBehaviour.OnEnable()
UnityEngine.EventSystems.UIBehaviour.Start()
UnityEngine.EventSystems.UIBehaviour.OnDisable()
UnityEngine.EventSystems.UIBehaviour.OnDestroy()
UnityEngine.EventSystems.UIBehaviour.IsActive()
UnityEngine.EventSystems.UIBehaviour.OnValidate()
UnityEngine.EventSystems.UIBehaviour.Reset()
UnityEngine.EventSystems.UIBehaviour.OnRectTransformDimensionsChange()
UnityEngine.EventSystems.UIBehaviour.OnBeforeTransformParentChanged()
UnityEngine.EventSystems.UIBehaviour.OnTransformParentChanged()
UnityEngine.EventSystems.UIBehaviour.OnDidApplyAnimationProperties()
UnityEngine.EventSystems.UIBehaviour.OnCanvasGroupChanged()
UnityEngine.EventSystems.UIBehaviour.OnCanvasHierarchyChanged()
UnityEngine.EventSystems.UIBehaviour.IsDestroyed()
UnityEngine.MonoBehaviour.IsInvoking()
UnityEngine.MonoBehaviour.CancelInvoke()
UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
UnityEngine.MonoBehaviour.CancelInvoke(System.String)
UnityEngine.MonoBehaviour.IsInvoking(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
UnityEngine.MonoBehaviour.StopCoroutine(System.String)
UnityEngine.MonoBehaviour.StopAllCoroutines()
UnityEngine.MonoBehaviour.print(System.Object)
UnityEngine.MonoBehaviour.useGUILayout
UnityEngine.MonoBehaviour.runInEditMode
UnityEngine.Behaviour.enabled
UnityEngine.Behaviour.isActiveAndEnabled
UnityEngine.Component.GetComponent(System.Type)
UnityEngine.Component.GetComponent<T>()
UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)
UnityEngine.Component.TryGetComponent<T>(T)
UnityEngine.Component.GetComponent(System.String)
UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInChildren(System.Type)
UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentInChildren<T>()
UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInChildren(System.Type)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInChildren<T>()
UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentInParent(System.Type)
UnityEngine.Component.GetComponentInParent<T>()
UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInParent(System.Type)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInParent<T>()
UnityEngine.Component.GetComponents(System.Type)
UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponents<T>()
UnityEngine.Component.CompareTag(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object)
UnityEngine.Component.SendMessageUpwards(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, System.Object)
UnityEngine.Component.SendMessage(System.String)
UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object)
UnityEngine.Component.BroadcastMessage(System.String)
UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.transform
UnityEngine.Component.gameObject
UnityEngine.Component.tag
UnityEngine.Object.GetInstanceID()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
UnityEngine.Object.Destroy(UnityEngine.Object)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
UnityEngine.Object.FindObjectsOfType(System.Type)
UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.ToString()
UnityEngine.Object.name
UnityEngine.Object.hideFlags
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NoXP.RuntimeComponents.UITooltip
Assembly: NoXP.RuntimeComponents.dll
Syntax
[RequireComponent(typeof(CanvasGroup))]
public class Tooltip : UIBehaviour
Properties
FadeInDuration
gets or sets the duration in seconds the tooltip takes to fade in completely
Declaration
public float FadeInDuration { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single |
FadeInFunction
gets or sets the easing function used during the tooltip fading in
Declaration
public EaseUtility.EaseFunctions FadeInFunction { get; set; }
Property Value
| Type | Description |
|---|---|
| EaseUtility.EaseFunctions |
FadeInMode
gets or sets the easing mode used during the tooltip fading in
Declaration
public EaseUtility.EaseModes FadeInMode { get; set; }
Property Value
| Type | Description |
|---|---|
| EaseUtility.EaseModes |
FadeOutDuration
gets or sets the duration in seconds the tooltip takes to fade out completely
Declaration
public float FadeOutDuration { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single |
FadeOutFunction
gets or sets the easing function used during the tooltip fading out
Declaration
public EaseUtility.EaseFunctions FadeOutFunction { get; set; }
Property Value
| Type | Description |
|---|---|
| EaseUtility.EaseFunctions |
FadeOutMode
gets or sets the easing mode used during the tooltip fading out
Declaration
public EaseUtility.EaseModes FadeOutMode { get; set; }
Property Value
| Type | Description |
|---|---|
| EaseUtility.EaseModes |
UpdateBehaviour
gets or sets whether the tooltip should auto update its position in relation to the mouse cursor when it is displayed.
Declaration
public Tooltip.PositionUpdateBehaviour UpdateBehaviour { get; set; }
Property Value
| Type | Description |
|---|---|
| Tooltip.PositionUpdateBehaviour |
Methods
Awake()
Declaration
protected override void Awake()
Overrides
UnityEngine.EventSystems.UIBehaviour.Awake()
Hide()
hides the tooltip using a fade-out
Declaration
public virtual void Hide()
OnHidden()
Declaration
protected void OnHidden()
OnShown()
Declaration
protected void OnShown()
Show(Int32, PointerEventData)
shows the tooltip using a fade-in
Declaration
public virtual void Show(int activeIndex, PointerEventData eventData)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | activeIndex | the index of the tooltip child to activate |
| UnityEngine.EventSystems.PointerEventData | eventData | ui event data to process correct positioning |
Events
Hidden
Declaration
public event Action<Tooltip> Hidden
Event Type
| Type | Description |
|---|---|
| System.Action<Tooltip> |
Shown
Declaration
public event Action<Tooltip> Shown
Event Type
| Type | Description |
|---|---|
| System.Action<Tooltip> |