A feedback used to trigger an animation (bool, int, float or trigger) on the associated animator, with or without randomness More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_Animation:

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

enum	ValueModes { None , Constant , Random , Incremental }
	the possible ways to set a value 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	UpdateRandomTrigger = false
	if this is true, will update a random trigger parameter, picked from the list below More...

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

List< string >	RandomTriggerParameterNames
	the trigger animator parameters to trigger at random 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...

bool	BoolParameterValue = true
	when in bool mode, whether to set the bool parameter to true or false More...

bool	UpdateRandomBool = false
	if this is true, will update a random bool parameter picked from the list below More...

bool	RandomBoolParameterValue = true
	when in bool mode, whether to set the bool parameter to true or false More...

List< string >	RandomBoolParameterNames
	the bool parameter to turn true when the feedback gets played More...

ValueModes	IntValueMode = ValueModes.None
	the int parameter to turn true when the feedback gets played More...

string	IntParameterName
	the int parameter to turn true when the feedback gets played More...

int	IntValue
	the value to set to that int parameter More...

int	IntValueMin
	the min value (inclusive) to set at random to that int parameter More...

int	IntValueMax = 5
	the max value (exclusive) to set at random to that int parameter More...

int	IntIncrement = 1
	the value to increment that int parameter by More...

ValueModes	FloatValueMode = ValueModes.None
	the Float parameter to turn true when the feedback gets played More...

string	FloatParameterName
	the float parameter to turn true when the feedback gets played More...

float	FloatValue
	the value to set to that float parameter More...

float	FloatValueMin
	the min value (inclusive) to set at random to that float parameter More...

float	FloatValueMax = 5
	the max value (exclusive) to set at random to that float parameter More...

float	FloatIncrement = 1
	the value to increment that float parameter by More...

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

int	UniqueID

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

int	Channel = 0
	the ID of the channel on which this feedback will communicate 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...

Color	DisplayColor = Color.black
	use this color to customize the background color of the feedback in the MMF_Player's list More...

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

MMF_Player	Owner
	the Owner of the feedback, as defined when calling the Initialization method More...

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

Static Public Attributes
static bool	FeedbackTypeAuthorized = true
	a static bool used to disable all feedbacks of this type at once More...

Protected Member Functions
override void	CustomInitialization (MMF_Player owner)
	Custom Init More...

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

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

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

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

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

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

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

virtual float	ApplyTimeMultiplier (float duration)
	Applies the host MMFeedbacks' time multiplier to this feedback More...

virtual float	ApplyDirection (float normalizedTime)
	Returns a new value of the normalized time based on the current play direction of this feedback More...

virtual void	CustomSkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets skipped to the end More...

virtual void	CustomReset ()
	This method describes what happens when the feedback gets reset More...

Protected Attributes
int	_triggerParameter

int	_boolParameter

int	_intParameter

int	_floatParameter

List< int >	_randomTriggerParameters

List< int >	_randomBoolParameters

Protected Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
float	_lastPlayTimestamp = -1f

int	_playsLeft

bool	_initialized = false

Coroutine	_playCoroutine

Coroutine	_infinitePlayCoroutine

Coroutine	_sequenceCoroutine

Coroutine	_repeatedPlayCoroutine

bool	_requiresSetup = false

string	_requiredTarget = ""

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.MMF_Feedback
virtual void	CacheRequiresSetup ()

virtual bool	EvaluateRequiresSetup ()
	Override this method to determine if a feedback requires setup More...

virtual void	Initialization (MMF_Player owner)
	Initializes the feedback and its timing related variables More...

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

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

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

virtual void	SkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	Called when skipping to the end of MMF_Player, calls custom Skip on all feedbacks More...

virtual void	ResetFeedback ()
	Calls this feedback's custom reset 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...

virtual void	InitializeCustomAttributes ()
	Use this method to initialize any custom attributes you may have More...

virtual void	OnValidate ()
	Triggered when a change happens in the inspector More...

virtual void	OnDestroy ()
	Triggered when that feedback gets destroyed More...

Properties inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual IEnumerator	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	ScriptDrivenPause `[getset]`
	if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution More...

virtual float	ScriptDrivenPauseAutoResume `[getset]`
	if this is a positive value, the feedback will auto resume after that duration if it hasn't been resumed via script already 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	HasChannel `[get]`
	if this is true, the Channel property will be displayed, otherwise it'll be hidden More...

virtual bool	HasCustomInspectors `[get]`

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

virtual bool	IsPlaying `[getset]`
	if this is true, this feedback is currently playing More...

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

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

virtual float	TotalDuration `[get]`
	The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats) More...

bool	RequiresSetup `[get]`
	A flag used to determine if a feedback has all it needs, or if it requires some extra setup. This flag will be used to display a warning icon in the inspector if the feedback is not ready to be played. More...

string	RequiredTarget `[get]`

virtual bool	DrawGroupInspectors `[get]`

virtual string	RequiresSetupText `[get]`

virtual string	RequiredTargetText `[get]`

virtual float?	FeedbackStartedAt `[get]`

virtual float	FeedbackDuration `[getset]`

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

virtual float?	FinalNormalizedTime `[get]`
	Returns the t value at which to evaluate a curve at the end of this feedback's play time More...

virtual bool	NormalPlayDirection `[get]`
	Returns true if this feedback should play normally, or false if it should play in rewind More...

virtual bool	ShouldPlayInThisSequenceDirection `[get]`
	Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting More...

Detailed Description

A feedback used to trigger an animation (bool, int, float or trigger) on the associated animator, with or without randomness

Member Enumeration Documentation

◆ TriggerModes

enum MoreMountains.Feedbacks.MMF_Animation.TriggerModes

the possible modes that pilot triggers

Enumerator
SetTrigger
ResetTrigger

◆ ValueModes

enum MoreMountains.Feedbacks.MMF_Animation.ValueModes

the possible ways to set a value

Enumerator
None
Constant
Random
Incremental

Member Function Documentation

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_Animation.CustomInitialization ( MMF_Player owner )

protectedvirtual

Custom Init

Parameters

owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

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

protectedvirtual

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

Parameters

position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

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

protectedvirtual

On stop, turns the bool parameter to false

Parameters

position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ _boolParameter

int MoreMountains.Feedbacks.MMF_Animation._boolParameter

protected

◆ _floatParameter

int MoreMountains.Feedbacks.MMF_Animation._floatParameter

protected

◆ _intParameter

int MoreMountains.Feedbacks.MMF_Animation._intParameter

protected

◆ _randomBoolParameters

List<int> MoreMountains.Feedbacks.MMF_Animation._randomBoolParameters

protected

◆ _randomTriggerParameters

List<int> MoreMountains.Feedbacks.MMF_Animation._randomTriggerParameters

protected

◆ _triggerParameter

int MoreMountains.Feedbacks.MMF_Animation._triggerParameter

protected

◆ BoolParameterName

string MoreMountains.Feedbacks.MMF_Animation.BoolParameterName

the bool parameter to turn true when the feedback gets played

◆ BoolParameterValue

bool MoreMountains.Feedbacks.MMF_Animation.BoolParameterValue = true

when in bool mode, whether to set the bool parameter to true or false

◆ BoundAnimator

Animator MoreMountains.Feedbacks.MMF_Animation.BoundAnimator

sets the inspector color for this feedback

the animator whose parameters you want to update

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Animation.FeedbackTypeAuthorized = true

static

a static bool used to disable all feedbacks of this type at once

◆ FloatIncrement

float MoreMountains.Feedbacks.MMF_Animation.FloatIncrement = 1

the value to increment that float parameter by

◆ FloatParameterName

string MoreMountains.Feedbacks.MMF_Animation.FloatParameterName

the float parameter to turn true when the feedback gets played

◆ FloatValue

float MoreMountains.Feedbacks.MMF_Animation.FloatValue

the value to set to that float parameter

◆ FloatValueMax

float MoreMountains.Feedbacks.MMF_Animation.FloatValueMax = 5

the max value (exclusive) to set at random to that float parameter

◆ FloatValueMin

float MoreMountains.Feedbacks.MMF_Animation.FloatValueMin

the min value (inclusive) to set at random to that float parameter

◆ FloatValueMode

ValueModes MoreMountains.Feedbacks.MMF_Animation.FloatValueMode = ValueModes.None

the Float parameter to turn true when the feedback gets played

◆ IntIncrement

int MoreMountains.Feedbacks.MMF_Animation.IntIncrement = 1

the value to increment that int parameter by

◆ IntParameterName

string MoreMountains.Feedbacks.MMF_Animation.IntParameterName

the int parameter to turn true when the feedback gets played

◆ IntValue

int MoreMountains.Feedbacks.MMF_Animation.IntValue

the value to set to that int parameter

◆ IntValueMax

int MoreMountains.Feedbacks.MMF_Animation.IntValueMax = 5

the max value (exclusive) to set at random to that int parameter

◆ IntValueMin

int MoreMountains.Feedbacks.MMF_Animation.IntValueMin

the min value (inclusive) to set at random to that int parameter

◆ IntValueMode

ValueModes MoreMountains.Feedbacks.MMF_Animation.IntValueMode = ValueModes.None

the int parameter to turn true when the feedback gets played

◆ RandomBoolParameterNames

List<string> MoreMountains.Feedbacks.MMF_Animation.RandomBoolParameterNames

the bool parameter to turn true when the feedback gets played

◆ RandomBoolParameterValue

bool MoreMountains.Feedbacks.MMF_Animation.RandomBoolParameterValue = true

when in bool mode, whether to set the bool parameter to true or false

◆ RandomTriggerMode

TriggerModes MoreMountains.Feedbacks.MMF_Animation.RandomTriggerMode = TriggerModes.SetTrigger

the selected mode to interact with this trigger

◆ RandomTriggerParameterNames

List<string> MoreMountains.Feedbacks.MMF_Animation.RandomTriggerParameterNames

the trigger animator parameters to trigger at random when the feedback is played

◆ TriggerMode

TriggerModes MoreMountains.Feedbacks.MMF_Animation.TriggerMode = TriggerModes.SetTrigger

the selected mode to interact with this trigger

◆ TriggerParameterName

string MoreMountains.Feedbacks.MMF_Animation.TriggerParameterName

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

◆ UpdateBool

bool MoreMountains.Feedbacks.MMF_Animation.UpdateBool = false

if this is true, will update the specified bool parameter

◆ UpdateRandomBool

bool MoreMountains.Feedbacks.MMF_Animation.UpdateRandomBool = false

if this is true, will update a random bool parameter picked from the list below

◆ UpdateRandomTrigger

bool MoreMountains.Feedbacks.MMF_Animation.UpdateRandomTrigger = false

if this is true, will update a random trigger parameter, picked from the list below

◆ UpdateTrigger

bool MoreMountains.Feedbacks.MMF_Animation.UpdateTrigger = false

if this is true, will update the specified trigger parameter

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

Assets/InfiniteRunnerEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Feedbacks/MMF_Animation.cs

Public Types

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TriggerModes

◆ ValueModes

Member Function Documentation

◆ CustomInitialization()

◆ CustomPlayFeedback()

◆ CustomStopFeedback()

Member Data Documentation

◆ _boolParameter

◆ _floatParameter

◆ _intParameter

◆ _randomBoolParameters

◆ _randomTriggerParameters

◆ _triggerParameter

◆ BoolParameterName

◆ BoolParameterValue

◆ BoundAnimator

◆ FeedbackTypeAuthorized

◆ FloatIncrement

◆ FloatParameterName

◆ FloatValue

◆ FloatValueMax

◆ FloatValueMin

◆ FloatValueMode

◆ IntIncrement

◆ IntParameterName

◆ IntValue

◆ IntValueMax

◆ IntValueMin

◆ IntValueMode

◆ RandomBoolParameterNames

◆ RandomBoolParameterValue

◆ RandomTriggerMode

◆ RandomTriggerParameterNames

◆ TriggerMode

◆ TriggerParameterName

◆ UpdateBool

◆ UpdateRandomBool

◆ UpdateRandomTrigger

◆ UpdateTrigger