Class ScreenFlashChannel

Feedback channel that produces a full-screen color flash via a lazily-created overlay. Handles ScreenFlashEffect. Target-agnostic (one overlay drives all players). Runs on unscaled time so the flash is visible even during a hit-stop.

Inheritance

object

ScreenFlashChannel

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 ScreenFlashChannel : IFeedbackChannel

Constructors

ScreenFlashChannel(IFeedbackRuntime)

Initializes a new ScreenFlashChannel.

Declaration

public ScreenFlashChannel(IFeedbackRuntime runtime)

Parameters

Type	Name	Description
IFeedbackRuntime	runtime	Coroutine host used to run and cancel the fade 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