Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Feedbacks.MMF_Animation Class Reference

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:
MoreMountains.Feedbacks.MMF_Feedback

Public Types

enum  TriggerModes { TriggerModes.SetTrigger, TriggerModes.ResetTrigger }
 the possible modes that pilot triggers
More...
 
enum  ValueModes { ValueModes.None, ValueModes.Constant, ValueModes.Random, ValueModes.Incremental }
 the possible ways to set a value More...
 

Public Attributes

override bool HasRandomness => true
 
override bool HasAutomatedTargetAcquisition => true
 
Animator BoundAnimator
 the animator whose parameters you want to update More...
 
List< Animator > ExtraBoundAnimators
 the list of extra animators whose parameters you want to update More...
 
float DeclaredDuration = 0f
 the duration for the player to consider. This won't impact your animation, but is a way to communicate to the MMF Player the duration of this feedback. Usually you'll want it to match your actual animation, and setting it can be useful to have this feedback work with holding pauses. 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...
 

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 AutomateTargetAcquisition ()
 A method meant to be implemented per feedback letting you specify what happens (usually setting a target) More...
 
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...
 
virtual void ApplyValue (Animator targetAnimator, float intensityMultiplier)
 Applies values on the target Animator More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On stop, turns the bool parameter to false More...
 

Protected Attributes

int _triggerParameter
 
int _boolParameter
 
int _intParameter
 
int _floatParameter
 
List< int > _randomTriggerParameters
 
List< int > _randomBoolParameters
 

Properties

override float FeedbackDuration [get, set]
 sets the inspector color for this feedback More...
 

Additional Inherited Members

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

the possible modes that pilot triggers

Enumerator
SetTrigger 
ResetTrigger 

◆ ValueModes

the possible ways to set a value

Enumerator
None 
Constant 
Random 
Incremental 

Member Function Documentation

◆ ApplyValue()

virtual void MoreMountains.Feedbacks.MMF_Animation.ApplyValue ( Animator  targetAnimator,
float  intensityMultiplier 
)
protectedvirtual

Applies values on the target Animator

Parameters
targetAnimator
intensityMultiplier

◆ AutomateTargetAcquisition()

override void MoreMountains.Feedbacks.MMF_Animation.AutomateTargetAcquisition ( )
protectedvirtual

A method meant to be implemented per feedback letting you specify what happens (usually setting a target)

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ 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

the animator whose parameters you want to update

◆ DeclaredDuration

float MoreMountains.Feedbacks.MMF_Animation.DeclaredDuration = 0f

the duration for the player to consider. This won't impact your animation, but is a way to communicate to the MMF Player the duration of this feedback. Usually you'll want it to match your actual animation, and setting it can be useful to have this feedback work with holding pauses.

◆ ExtraBoundAnimators

List<Animator> MoreMountains.Feedbacks.MMF_Animation.ExtraBoundAnimators

the list of extra animators 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

◆ HasAutomatedTargetAcquisition

override bool MoreMountains.Feedbacks.MMF_Animation.HasAutomatedTargetAcquisition => true

◆ HasRandomness

override bool MoreMountains.Feedbacks.MMF_Animation.HasRandomness => true

◆ 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

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_Animation.FeedbackDuration
getset

sets the inspector color for this feedback

the duration of this feedback is the declared duration


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