Class SettingsButton
- Namespace
- ContentSettings.API.Settings.UI
- Assembly
- RedstoneWizard08.ContentLibrary.dll
A component representing a button in a settings menu, providing hover and selection states.
public class SettingsButton : MonoBehaviour, IPointerEnterHandler, IPointerExitHandler, IEventSystemHandler
- Inheritance
-
ObjectComponentBehaviourMonoBehaviourSettingsButton
- Implements
-
IPointerEnterHandlerIPointerExitHandlerIEventSystemHandler
- Derived
- Inherited Members
-
MonoBehaviour.m_CancellationTokenSourceMonoBehaviour.RaiseCancellation()MonoBehaviour.IsInvoking()MonoBehaviour.CancelInvoke()MonoBehaviour.StopCoroutine(Coroutine)MonoBehaviour.StopAllCoroutines()MonoBehaviour.Internal_CancelInvokeAll(MonoBehaviour)MonoBehaviour.Internal_IsInvokingAll(MonoBehaviour)MonoBehaviour.IsObjectMonoBehaviour(Object)MonoBehaviour.StopCoroutineManaged(Coroutine)MonoBehaviour.GetScriptClassName()MonoBehaviour.OnCancellationTokenCreated()MonoBehaviour.destroyCancellationTokenMonoBehaviour.useGUILayoutBehaviour.enabledBehaviour.isActiveAndEnabledComponent.GetComponent<T>()Component.TryGetComponent<T>(out T)Component.GetComponentInChildren<T>()Component.GetComponentsInChildren<T>()Component.GetComponentInParent<T>()Component.GetComponentsInParent<T>()Component.GetComponents<T>()Component.transformComponent.gameObjectComponent.tagObject.m_CachedPtrObject.OffsetOfInstanceIDInCPlusPlusObjectObject.objectIsNullMessageObject.cloneDestroyedMessageObject.GetInstanceID()Object.GetHashCode()Object.CompareBaseObjects(Object, Object)Object.EnsureRunningOnMainThread()Object.IsNativeObjectAlive(Object)Object.GetCachedPtr()Object.Instantiate(Object, Vector3, Quaternion)Object.Instantiate(Object, Vector3, Quaternion, Transform)Object.Instantiate(Object)Object.Instantiate(Object, Transform)Object.Instantiate<T>(T)Object.Instantiate<T>(T, Vector3, Quaternion)Object.Instantiate<T>(T, Vector3, Quaternion, Transform)Object.Instantiate<T>(T, Transform)Object.Destroy(Object)Object.DestroyImmediate(Object)Object.DontDestroyOnLoad(Object)Object.DestroyObject(Object)Object.FindObjectsOfType<T>()Object.FindObjectsByType<T>(FindObjectsSortMode)Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)Object.FindObjectOfType<T>()Object.FindFirstObjectByType<T>()Object.FindAnyObjectByType<T>()Object.FindFirstObjectByType<T>(FindObjectsInactive)Object.FindAnyObjectByType<T>(FindObjectsInactive)Object.ToString()Object.GetOffsetOfInstanceIDInCPlusPlusObject()Object.CurrentThreadIsMainThread()Object.Internal_CloneSingle(Object)Object.Internal_InstantiateSingle(Object, Vector3, Quaternion)Object.Internal_InstantiateSingleWithParent(Object, Transform, Vector3, Quaternion)Object.ToString(Object)Object.GetName(Object)Object.IsPersistent(Object)Object.MarkDirty()Object.Internal_InstantiateSingle_Injected(Object, ref Vector3, ref Quaternion)Object.Internal_InstantiateSingleWithParent_Injected(Object, Transform, ref Vector3, ref Quaternion)Object.nameObject.hideFlags
Properties
IsHovered
Gets a value indicating whether the tab is hovered over.
[UsedImplicitly]
public bool IsHovered { get; }
Property Value
IsSelected
Gets a value indicating whether the tab is selected.
[UsedImplicitly]
public bool IsSelected { get; }
Property Value
Name
Gets or sets the display name of the button.
public string Name { get; set; }
Property Value
Methods
Awake()
Awake is called by Unity when the script instance is being loaded.
protected virtual void Awake()
Deselect()
Deselect the tab.
public void Deselect()
Remarks
See OnDeselected() for the event triggered by this.
OnDeselected()
Called when the tab is deselected.
public virtual void OnDeselected()
OnHover()
Called when the tab is hovered over.
public virtual void OnHover()
OnPointerEnter(PointerEventData)
Called when the tab is hovered over.
public void OnPointerEnter(PointerEventData eventData)
Parameters
eventData
PointerEventDataThe pointer event data.
OnPointerExit(PointerEventData)
Called when the tab is no longer hovered over.
public void OnPointerExit(PointerEventData eventData)
Parameters
eventData
PointerEventDataThe pointer event data.
OnSelected()
Called when the tab is selected.
public virtual void OnSelected()
OnUnhover()
Called when the tab is no longer hovered over.
public virtual void OnUnhover()
Select()
Select the tab.
public void Select()
Remarks
See OnSelected() for the event triggered by this.