A feedback used to trigger an animation (bool or trigger) on the associated animator More...

Inheritance diagram for MoreMountains.Feedbacks.MMFeedbackAnimation:

Public Types
enum	TriggerModes { TriggerModes.SetTrigger, TriggerModes.ResetTrigger }
	the possible modes that pilot triggers More...

Public Attributes
Animator	BoundAnimator
	sets the inspector color for this feedback More...

bool	UpdateTrigger = false
	if this is true, will update the specified trigger parameter More...

TriggerModes	TriggerMode = TriggerModes.SetTrigger
	the selected mode to interact with this trigger More...

string	TriggerParameterName
	the trigger animator parameter to, well, trigger when the feedback is played More...

bool	UpdateBool = false
	if this is true, will update the specified bool parameter More...

string	BoolParameterName
	the bool parameter to turn true when the feedback gets played 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)
	Custom Init More...

override void	CustomPlayFeedback (Vector3 position, float attenuation=1.0f)
	On Play, checks if an animator is bound and triggers parameters More...

override void	CustomStopFeedback (Vector3 position, float attenuation=1.0f)
	On stop, turns the bool parameter to false More...

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	CustomReset ()
	This method describes what happens when the feedback gets reset More...

Protected Attributes
int	_triggerParameter

int	_boolParameter

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

Additional Inherited Members
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...

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

A feedback used to trigger an animation (bool or trigger) on the associated animator

Member Enumeration Documentation

◆ TriggerModes

enum MoreMountains.Feedbacks.MMFeedbackAnimation.TriggerModes

strong

the possible modes that pilot triggers

Enumerator
SetTrigger
ResetTrigger

Member Function Documentation

◆ CustomInitialization()

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

protectedvirtual

Custom Init

Parameters

owner

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ CustomPlayFeedback()

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

protectedvirtual

On Play, checks if an animator is bound and triggers parameters

Parameters

position
attenuation

Implements MoreMountains.Feedbacks.MMFeedback.

◆ CustomStopFeedback()

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

protectedvirtual

On stop, turns the bool parameter to false

Parameters

position
attenuation

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

Member Data Documentation

◆ _boolParameter

int MoreMountains.Feedbacks.MMFeedbackAnimation._boolParameter

protected

◆ _triggerParameter

int MoreMountains.Feedbacks.MMFeedbackAnimation._triggerParameter

protected

◆ BoolParameterName

string MoreMountains.Feedbacks.MMFeedbackAnimation.BoolParameterName

the bool parameter to turn true when the feedback gets played

◆ BoundAnimator

Animator MoreMountains.Feedbacks.MMFeedbackAnimation.BoundAnimator

sets the inspector color for this feedback

the animator whose parameters you want to update

◆ TriggerMode

TriggerModes MoreMountains.Feedbacks.MMFeedbackAnimation.TriggerMode = TriggerModes.SetTrigger

the selected mode to interact with this trigger

◆ TriggerParameterName

string MoreMountains.Feedbacks.MMFeedbackAnimation.TriggerParameterName

the trigger animator parameter to, well, trigger when the feedback is played

◆ UpdateBool

bool MoreMountains.Feedbacks.MMFeedbackAnimation.UpdateBool = false

if this is true, will update the specified bool parameter

◆ UpdateTrigger

bool MoreMountains.Feedbacks.MMFeedbackAnimation.UpdateTrigger = false

if this is true, will update the specified trigger parameter

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

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

Public Types

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TriggerModes

Member Function Documentation

◆ CustomInitialization()

◆ CustomPlayFeedback()

◆ CustomStopFeedback()

Member Data Documentation

◆ _boolParameter

◆ _triggerParameter

◆ BoolParameterName

◆ BoundAnimator

◆ TriggerMode

◆ TriggerParameterName

◆ UpdateBool

◆ UpdateTrigger