This feedback will make the bound renderer flicker for the set duration when played (and restore its initial color when stopped) More...

Inheritance diagram for MoreMountains.Feedbacks.MMFeedbackFlicker:

Public Types
enum	Modes { Modes.Color, Modes.PropertyName }
	sets the inspector color for this feedback More...

Public Member Functions
virtual IEnumerator	Flicker (Renderer renderer, Color initialColor, Color flickerColor, float flickerSpeed, float flickerDuration)

Public Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual void	Initialization (GameObject owner)
	Initializes the feedback and its timing related variables More...

virtual void	Play (Vector3 position, float attenuation=1.0f)
	Plays the feedback More...

virtual void	Stop (Vector3 position, float attenuation=1.0f)
	Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations More...

virtual void	ResetFeedback ()
	Calls this feedback's custom reset More...

virtual void	SetSequence (MMSequence newSequence)
	Use this method to change this feedback's sequence at runtime More...

virtual void	SetDelayBetweenRepeats (float delay)
	Use this method to specify a new delay between repeats at runtime More...

virtual void	SetInitialDelay (float delay)
	Use this method to specify a new initial delay at runtime More...

Public Attributes
Renderer	BoundRenderer
	the renderer to flicker when played More...

Modes	Mode = Modes.Color
	the selected mode to flicker the renderer More...

string	PropertyName = "_Tint"
	the name of the property to target More...

float	FlickerDuration = 0.2f
	the duration of the flicker when getting damage More...

float	FlickerOctave = 0.04f
	the frequency at which to flicker More...

Color	FlickerColor = new Color32(255, 20, 20, 255)
	the color we should flicker the sprite to More...

Public Attributes inherited from MoreMountains.Feedbacks.MMFeedback
bool	Active = true
	whether or not this feedback is active More...

string	Label = "MMFeedback"
	the name of this feedback to display in the inspector More...

float	Chance = 100f
	the chance of this feedback happening (in percent : 100 : happens all the time, 0 : never happens, 50 : happens once every two calls, etc) More...

MMFeedbackTiming	Timing
	a number of timing-related values (delay, repeat, etc) More...

bool	DebugActive = false
	whether or not this feedback is in debug mode More...

Protected Member Functions
override void	CustomInitialization (GameObject owner)
	On init we grab our initial color and components More...

override void	CustomPlayFeedback (Vector3 position, float attenuation=1.0f)
	On play we make our renderer flicker More...

override void	CustomReset ()
	On reset we make our renderer stop flickering More...

virtual void	SetColor (Color color)

Protected Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual IEnumerator	PlayCoroutine (Vector3 position, float attenuation=1.0f)
	An internal coroutine delaying the initial play of the feedback More...

virtual void	RegularPlay (Vector3 position, float attenuation=1.0f)
	Triggers delaying coroutines if needed More...

virtual IEnumerator	InfinitePlay (Vector3 position, float attenuation=1.0f)
	Internal coroutine used for repeated play without end More...

virtual IEnumerator	RepeatedPlay (Vector3 position, float attenuation=1.0f)
	Internal coroutine used for repeated play More...

virtual IEnumerator	SequenceCoroutine (Vector3 position, float attenuation=1.0f)
	A coroutine used to play this feedback on a sequence More...

virtual void	CustomStopFeedback (Vector3 position, float attenuation=1.0f)
	This method describes what happens when the feedback gets stopped More...

Protected Attributes
Color	_initialFlickerColor

int	_propertyID = -1

bool	_propertyFound = false

Protected Attributes inherited from MoreMountains.Feedbacks.MMFeedback
WaitForSeconds	_initialDelayWaitForSeconds

WaitForSeconds	_betweenDelayWaitForSeconds

WaitForSeconds	_sequenceDelayWaitForSeconds

float	_lastPlayTimestamp = -1f

int	_playsLeft

bool	_initialized = false

Coroutine	_playCoroutine

Coroutine	_infinitePlayCoroutine

Coroutine	_sequenceCoroutine

Coroutine	_repeatedPlayCoroutine

int	_sequenceTrackID = 0

float	_beatInterval

bool	BeatThisFrame = false

int	LastBeatIndex = 0

int	CurrentSequenceIndex = 0

float	LastBeatTimestamp = 0f

Properties
override float	FeedbackDuration `[get]`
	the duration of this feedback is the duration of the flicker More...

Properties inherited from MoreMountains.Feedbacks.MMFeedback
GameObject	Owner `[get, set]`
	the Owner of the feedback, as defined when calling the Initialization method More...

virtual YieldInstruction	Pause `[get]`
	set this to true if your feedback should pause the execution of the feedback sequence More...

virtual bool	HoldingPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run More...

virtual bool	LooperPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	LooperStart `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	InCooldown `[get]`
	returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise More...

float	FeedbackTime `[get]`
	the time (or unscaled time) based on the selected Timing settings More...

float	FeedbackDeltaTime `[get]`
	the delta time (or unscaled delta time) based on the selected Timing settings More...

virtual float	FeedbackStartedAt `[get]`

virtual float	FeedbackDuration `[get]`

virtual bool	FeedbackPlaying `[get]`
	whether or not this feedback is playing right now More...

Detailed Description

This feedback will make the bound renderer flicker for the set duration when played (and restore its initial color when stopped)

Member Enumeration Documentation

◆ Modes

enum MoreMountains.Feedbacks.MMFeedbackFlicker.Modes

strong

sets the inspector color for this feedback

the possible modes Color : will control material.color PropertyName : will target a specific shader property by name

Enumerator
Color
PropertyName

Member Function Documentation

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMFeedbackFlicker.CustomInitialization ( GameObject owner )

protectedvirtual

On init we grab our initial color and components

Parameters

owner

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMFeedbackFlicker.CustomPlayFeedback	(	Vector3	position,
		float	attenuation = `1.0f`
	)

protectedvirtual

On play we make our renderer flicker

Parameters

position
attenuation

Implements MoreMountains.Feedbacks.MMFeedback.

◆ CustomReset()

override void MoreMountains.Feedbacks.MMFeedbackFlicker.CustomReset ( )

protectedvirtual

On reset we make our renderer stop flickering

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ Flicker()

virtual IEnumerator MoreMountains.Feedbacks.MMFeedbackFlicker.Flicker	(	Renderer	renderer,
		Color	initialColor,
		Color	flickerColor,
		float	flickerSpeed,
		float	flickerDuration
	)

virtual

◆ SetColor()

virtual void MoreMountains.Feedbacks.MMFeedbackFlicker.SetColor ( Color color )

protectedvirtual

Member Data Documentation

◆ _initialFlickerColor

Color MoreMountains.Feedbacks.MMFeedbackFlicker._initialFlickerColor

protected

◆ _propertyFound

bool MoreMountains.Feedbacks.MMFeedbackFlicker._propertyFound = false

protected

◆ _propertyID

int MoreMountains.Feedbacks.MMFeedbackFlicker._propertyID = -1

protected

◆ BoundRenderer

Renderer MoreMountains.Feedbacks.MMFeedbackFlicker.BoundRenderer

the renderer to flicker when played

◆ FlickerColor

Color MoreMountains.Feedbacks.MMFeedbackFlicker.FlickerColor = new Color32(255, 20, 20, 255)

the color we should flicker the sprite to

◆ FlickerDuration

float MoreMountains.Feedbacks.MMFeedbackFlicker.FlickerDuration = 0.2f

the duration of the flicker when getting damage

◆ FlickerOctave

float MoreMountains.Feedbacks.MMFeedbackFlicker.FlickerOctave = 0.04f

the frequency at which to flicker

◆ Mode

Modes MoreMountains.Feedbacks.MMFeedbackFlicker.Mode = Modes.Color

the selected mode to flicker the renderer

◆ PropertyName

string MoreMountains.Feedbacks.MMFeedbackFlicker.PropertyName = "_Tint"

the name of the property to target

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMFeedbackFlicker.FeedbackDuration

get

the duration of this feedback is the duration of the flicker

The documentation for this class was generated from the following file:

F:/Github/Store/MMFeedbacksStore/Assets/MMFeedbacks/MMFeedbacks/MMFeedbacks/Feedbacks/MMFeedbackFlicker.cs

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ Modes

Member Function Documentation

◆ CustomInitialization()

◆ CustomPlayFeedback()

◆ CustomReset()

◆ Flicker()

◆ SetColor()

Member Data Documentation

◆ _initialFlickerColor

◆ _propertyFound

◆ _propertyID

◆ BoundRenderer

◆ FlickerColor

◆ FlickerDuration

◆ FlickerOctave

◆ Mode

◆ PropertyName

Property Documentation

◆ FeedbackDuration