Class CanvasGroupFader

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

CanvasGroupFader

FloatingContainer

FloatingOptions

Inherited Members

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, System.Boolean)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>(System.Boolean)

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.FindObjectsOfType(System.Type, System.Boolean)

UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)

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.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindFirstObjectByType<T>()

UnityEngine.Object.FindAnyObjectByType<T>()

UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindFirstObjectByType(System.Type)

UnityEngine.Object.FindAnyObjectByType(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)

UnityEngine.Object.FindFirstObjectByType(System.Type, UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindAnyObjectByType(System.Type, UnityEngine.FindObjectsInactive)

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: GameKit.Dependencies.Utilities.Types

Assembly: GameKit.Dependencies.dll

Syntax

public class CanvasGroupFader : MonoBehaviour

Fields

CanvasGroup

CanvasGroup to fade in and out.

Declaration

[Tooltip("CanvasGroup to fade in and out.")]
[SerializeField]
protected CanvasGroup CanvasGroup

Field Value

Type	Description
UnityEngine.CanvasGroup

FadeInDuration

How long it should take to fade in the CanvasGroup.

Declaration

[SerializeField]
protected float FadeInDuration

Field Value

Type	Description
System.Single

FadeOutDuration

How long it should take to fade out the CanvasGroup.

Declaration

[SerializeField]
protected float FadeOutDuration

Field Value

Type	Description
System.Single

UpdateCanvasBlocking

True to update the CanvasGroup blocking settings when showing and hiding.

Declaration

[Tooltip("True to update the CanvasGroup blocking settings when showing and hiding.")]
[SerializeField]
protected bool UpdateCanvasBlocking

Field Value

Type	Description
System.Boolean

Properties

FadeGoal

Current goal for the fader.

Declaration

public CanvasGroupFader.FadeGoalType FadeGoal { get; }

Property Value

Type	Description
CanvasGroupFader.FadeGoalType

IsHiding

True if hidden or in the process of hiding.

Declaration

public bool IsHiding { get; }

Property Value

Type	Description
System.Boolean

IsVisible

True if visible. Will be true long as the CanvasGroup has alpha. Also see IsHiding.

Declaration

public bool IsVisible { get; }

Property Value

Type	Description
System.Boolean

Methods

CompleteFade(Boolean)

Called when the fade completes.

Declaration

protected virtual void CompleteFade(bool fadingIn)

Parameters

Type	Name	Description
System.Boolean	fadingIn

Hide()

Hides CanvasGroup with a fade.

Declaration

public virtual void Hide()

HideImmediately()

Hides CanvasGroup immediately.

Declaration

public virtual void HideImmediately()

OnDisable()

Declaration

protected virtual void OnDisable()

OnEnable()

Declaration

protected virtual void OnEnable()

OnHide()

Called after Hide or HideImmediate.

Declaration

protected virtual void OnHide()

OnShow()

Called after Show or ShowImmediate.

Declaration

protected virtual void OnShow()

SetCanvasGroupBlockingType(CanvasGroupBlockingType)

Changes the CanvasGroups interactable and bloacking state.

Declaration

protected virtual void SetCanvasGroupBlockingType(CanvasGroupBlockingType blockingType)

Parameters

Type	Name	Description
CanvasGroupBlockingType	blockingType

Show()

Shows CanvasGroup with a fade.

Declaration

public virtual void Show()

ShowImmediately()

Shows CanvasGroup immediately.

Declaration

public virtual void ShowImmediately()

Update()

Declaration

protected virtual void Update()