Class Fade

Namespace

UILib.Animations

Assembly

UILib.dll

A BaseEase behaviour which fades between two opacities.

public class Fade : BaseEase

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

BaseTimer

BaseEase

Fade

Inherited Members

BaseEase.minValue

BaseEase.maxValue

BaseEase.value

BaseEase.easingIn

BaseEase.easingOut

BaseEase.easeFunction

BaseEase._SetValues(float, float)

BaseEase.SetEaseFunction(Func<float, float>)

BaseEase.EaseIn(bool)

BaseEase.EaseOut(bool)

BaseEase.OnIter(float)

BaseEase.OnEnd()

BaseTimer.running

BaseTimer.time

BaseTimer.duration

BaseTimer.timeScale

BaseTimer.increasing

BaseTimer.ForceRun()

BaseTimer.StartTimer()

BaseTimer.RestartTimer()

BaseTimer.StopTimer()

BaseTimer.SetIncreasing(bool)

BaseTimer.Reverse()

BaseTimer.SetDuration(float)

BaseTimer.SetTimeScale(float)

BaseTimer.SetTime(float)

BaseTimer.SetToStart()

BaseTimer.SetToEnd()

BaseTimer.OnStart()

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

fadingIn

Whether this behaviour is currently fading in.

public bool fadingIn { get; }

Property Value

bool

fadingOut

Whether this behaviour is currently fading out.

public bool fadingOut { get; }

Property Value

bool

maxOpacity

The maximum opacity (0-1 inclusive).

public float maxOpacity { get; }

Property Value

float

minOpacity

The minimum opacity (0-1 inclusive).

public float minOpacity { get; }

Property Value

float

onFadeIn

Invokes listeners once fading in finishes.

public UnityEvent onFadeIn { get; }

Property Value

UnityEvent

onFadeOut

Invokes listeners once fading out finishes.

public UnityEvent onFadeOut { get; }

Property Value

UnityEvent

opacity

The current opacity the canvas groups are set to.

public float opacity { get; }

Property Value

float

Methods

Add(CanvasGroup)

Adds a canvas group to be managed by this behaviour.

Adding the group to this behaviour will also immediately update its alpha value.

public void Add(CanvasGroup group)

Parameters

group CanvasGroup

The canvas group to add

FadeIn(bool)

Fades the attached canvas groups in.

public void FadeIn(bool force = false)

Parameters

force bool

Whether to force fading in

FadeOut(bool)

Fades the attached canvas groups out.

public void FadeOut(bool force = false)

Parameters

force bool

Whether to force fading out

OnEaseIn()

Runs when easing in has finished.

protected override void OnEaseIn()

OnEaseOut()

Runs when easing out has finished.

protected override void OnEaseOut()

SetOpacities(float, float)

Sets the opacities to fade between. These opacities must be between 0-1.

public void SetOpacities(float minOpacity, float maxOpacity)

Parameters

minOpacity float

The minimum opacity

maxOpacity float

The maximum opacity

SetOpacity(float)

Updates the opacity of all canvas groups.

public void SetOpacity(float opacity)

Parameters

opacity float

The new opacity to use

_SetValue(float)

Internally updates canvas opacity on each iteration.

protected override void _SetValue(float opacity)

Parameters

opacity float

The opacity to set