Class Fade

Namespace

UILib.Behaviours

Assembly

UILib.dll

A behaviour which uses a Timer internally to manage fading in/out CanvasGroups.

public class Fade : Timer

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

Timer

Fade

Inherited Members

Timer.timeScale

Timer.timer

Timer.running

Timer.paused

Timer.onStart

Timer.onIter

Timer.onEnd

Timer.SetTimeScale(float)

Timer.StartTimer(float, float)

Timer.PauseTimer(bool)

Timer.ReverseTimer()

Timer.StopTimer()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.Internal_CancelInvokeAll(MonoBehaviour)

MonoBehaviour.Internal_IsInvokingAll(MonoBehaviour)

MonoBehaviour.InvokeDelayed(MonoBehaviour, string, float, float)

MonoBehaviour.CancelInvoke(MonoBehaviour, string)

MonoBehaviour.IsInvoking(MonoBehaviour, string)

MonoBehaviour.IsObjectMonoBehaviour(Object)

MonoBehaviour.StartCoroutineManaged(string, object)

MonoBehaviour.StartCoroutineManaged2(IEnumerator)

MonoBehaviour.StopCoroutineManaged(Coroutine)

MonoBehaviour.StopCoroutineFromEnumeratorManaged(IEnumerator)

MonoBehaviour.GetScriptClassName()

MonoBehaviour.useGUILayout

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponentFastPath(Type, IntPtr)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponentsForListInternal(Type, object)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.m_CachedPtr

Object.OffsetOfInstanceIDInCPlusPlusObject

Object.objectIsNullMessage

Object.cloneDestroyedMessage

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

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(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.CheckNullArgument(object, string)

Object.FindObjectOfType(Type)

Object.ToString()

Object.GetOffsetOfInstanceIDInCPlusPlusObject()

Object.CurrentThreadIsMainThread()

Object.Internal_CloneSingle(Object)

Object.Internal_CloneSingleWithParent(Object, Transform, bool)

Object.Internal_InstantiateSingle(Object, Vector3, Quaternion)

Object.Internal_InstantiateSingleWithParent(Object, Transform, Vector3, Quaternion)

Object.ToString(Object)

Object.GetName(Object)

Object.IsPersistent(Object)

Object.SetName(Object, string)

Object.DoesObjectWithInstanceIDExist(int)

Object.FindObjectFromInstanceID(int)

Object.ForceLoadFromInstanceID(int)

Object.Internal_InstantiateSingle_Injected(Object, ref Vector3, ref Quaternion)

Object.Internal_InstantiateSingleWithParent_Injected(Object, Transform, ref Vector3, ref Quaternion)

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Properties

fadeTime

The currently set length of time fading should take.

public float fadeTime { get; }

Property Value

float

fadingIn

Whether this fade is currently fading in.

public bool fadingIn { get; }

Property Value

bool

fadingOut

Whether this fade is currently fading out.

public bool fadingOut { get; }

Property Value

bool

maxOpacity

The currently set maximum opacity.

public float maxOpacity { get; }

Property Value

float

minOpacity

The currently set minimum opacity.

public float minOpacity { get; }

Property Value

float

onFadeIn

An event which invokes listeners once fading in has completed entirely.

public UnityEvent onFadeIn { get; }

Property Value

UnityEvent

onFadeOut

An event which invokes listeners once fading out has completed entirely.

public UnityEvent onFadeOut { get; }

Property Value

UnityEvent

opacity

The opacity the canvas groups are currently at.

public float opacity { get; }

Property Value

float

Methods

Add(CanvasGroup)

Adds a CanvasGroup which should have its alpha controlled by this behaviour.

public void Add(CanvasGroup group)

Parameters

group CanvasGroup

FadeIn(bool)

Fades the CanvasGroups in.

public void FadeIn(bool force = false)

Parameters

force bool

Whether to force fading in instantly

FadeOut(bool)

Fades the CanvasGroups out.

public void FadeOut(bool force = false)

Parameters

force bool

Whether to force fading out instantly

SetFadeTime(float)

Sets how long it should take to fade in/out the alpha of the CanvasGroups.

public void SetFadeTime(float time)

Parameters

time float

The length of time the fade should last

SetOpacities(float, float)

Sets the minimum and maximum opacities to fade between.

Both min and max must be between 0-1 inclusive.

If you enter a min > max they will be swapped around.

public void SetOpacities(float min = 0, float max = 1)

Parameters

min float

The minimum opacity

max float

The maximum opacity