Class UiScreenShakeChannel

Feedback channel that shakes the UI (menus, HUD) via a decaying jitter coroutine. Handles UiScreenShakeEffect. The screen-space counterpart to ScreenShakeChannel, which shakes the camera. Drives every active UnityUiShakeReceiver through the UiShakeRegistry, and auto-attaches a receiver to each live root Canvas (throttled) so the shake follows the UI across scene/mode changes with no manual setup. Uses unscaled time so it survives a hit-stop.

Inheritance

object

UiScreenShakeChannel

Implements

IFeedbackChannel

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.Channels

Assembly: Serenity.UnityFeedback.Infrastructure.dll

Syntax

public class UiScreenShakeChannel : IFeedbackChannel

Constructors

UiScreenShakeChannel(IFeedbackRuntime)

Initializes a new UiScreenShakeChannel.

Declaration

public UiScreenShakeChannel(IFeedbackRuntime runtime)

Parameters

Type	Name	Description
IFeedbackRuntime	runtime	Coroutine host used to run and cancel the shake decay routine.

Properties

ChannelId

Declaration

public string ChannelId { get; }

Property Value

Type	Description
string

Methods

CanPlay(IFeedbackEffect)

Declaration

public bool CanPlay(IFeedbackEffect effect)

Parameters

Type	Name	Description
IFeedbackEffect	effect

Returns

Type	Description
bool

Play(FeedbackTarget, IFeedbackEffect)

Declaration

public void Play(FeedbackTarget target, IFeedbackEffect effect)

Parameters

Type	Name	Description
FeedbackTarget	target
IFeedbackEffect	effect

Stop(FeedbackTarget)

Declaration

public void Stop(FeedbackTarget target)

Parameters

Type	Name	Description
FeedbackTarget	target

StopAll()

Declaration

public void StopAll()

Implements

IFeedbackChannel