Class UiShakeRegistry

Process-wide registry of active UnityUiShakeReceivers, read by the screen-shake channel.

Inheritance

object

UiShakeRegistry

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.Feedback.Infrastructure.Components

Assembly: Serenity.UnityFeedback.Infrastructure.dll

Syntax

public static class UiShakeRegistry

Properties

Active

Currently active receivers.

Declaration

public static IReadOnlyCollection<UnityUiShakeReceiver> Active { get; }

Property Value

Type	Description
IReadOnlyCollection<UnityUiShakeReceiver>

HasReceivers

True when at least one receiver is active.

Declaration

public static bool HasReceivers { get; }

Property Value

Type	Description
bool

Methods

ApplyShake(Vector2, float)

Applies a shake frame to every active receiver.

Declaration

public static void ApplyShake(Vector2 unitOffset, float amplitude)

Parameters

Type	Name	Description
Vector2	unitOffset
float	amplitude

Register(UnityUiShakeReceiver)

Registers a receiver (called from its OnEnable).

Declaration

public static void Register(UnityUiShakeReceiver receiver)

Parameters

Type	Name	Description
UnityUiShakeReceiver	receiver

ResetAll()

Resets every active receiver to its pre-shake position.

Declaration

public static void ResetAll()

Unregister(UnityUiShakeReceiver)

Unregisters a receiver (called from its OnDisable).

Declaration

public static void Unregister(UnityUiShakeReceiver receiver)

Parameters

Type	Name	Description
UnityUiShakeReceiver	receiver