Feel 5.9.1
The best way to improve your game's feel and make it extra juicy
Loading...
Searching...
No Matches
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 { 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
 the animator whose parameters you want to update
List< Animator > ExtraBoundAnimators
 the list of extra animators whose parameters you want to update
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.
bool UpdateTrigger = false
 if this is true, will update the specified trigger parameter
TriggerModes TriggerMode = TriggerModes.SetTrigger
 the selected mode to interact with this trigger
string TriggerParameterName
 the trigger animator parameter to, well, trigger when the feedback is played
bool UpdateRandomTrigger = false
 if this is true, will update a random trigger parameter, picked from the list below
TriggerModes RandomTriggerMode = TriggerModes.SetTrigger
 the selected mode to interact with this trigger
List< string > RandomTriggerParameterNames
 the trigger animator parameters to trigger at random when the feedback is played
bool UpdateBool = false
 if this is true, will update the specified bool parameter
string BoolParameterName
 the bool parameter to turn true when the feedback gets played
bool BoolParameterValue = true
 when in bool mode, whether to set the bool parameter to true or false
bool UpdateRandomBool = false
 if this is true, will update a random bool parameter picked from the list below
bool RandomBoolParameterValue = true
 when in bool mode, whether to set the bool parameter to true or false
List< string > RandomBoolParameterNames
 the bool parameter to turn true when the feedback gets played
ValueModes IntValueMode = ValueModes.None
 the int parameter to turn true when the feedback gets played
string IntParameterName
 the int parameter to turn true when the feedback gets played
int IntValue
 the value to set to that int parameter
int IntValueMin
 the min value (inclusive) to set at random to that int parameter
int IntValueMax = 5
 the max value (exclusive) to set at random to that int parameter
int IntIncrement = 1
 the value to increment that int parameter by
ValueModes FloatValueMode = ValueModes.None
 the Float parameter to turn true when the feedback gets played
string FloatParameterName
 the float parameter to turn true when the feedback gets played
float FloatValue
 the value to set to that float parameter
float FloatValueMin
 the min value (inclusive) to set at random to that float parameter
float FloatValueMax = 5
 the max value (exclusive) to set at random to that float parameter
float FloatIncrement = 1
 the value to increment that float parameter by
bool SetLayerWeight = false
 whether or not to set layer weights on the specified layer when playing this feedback
int TargetLayerIndex = 1
 the index of the layer to target when changing layer weights
string LayerName = ""
 the name of the Animator layer you want the layer weight change to occur on. This is optional. If left empty, the layer ID above will be used, if not empty, the Layer id specified above will be ignored.
float NewWeight = 0.5f
 the new weight to set on the target animator layer

Static Public Attributes

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

Protected Member Functions

override void AutomateTargetAcquisition ()
 A method meant to be implemented per feedback letting you specify what happens (usually setting a target)
override void CustomInitialization (MMF_Player owner)
 Custom Init.
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play, checks if an animator is bound and triggers parameters.
virtual void ApplyValue (Animator targetAnimator, float intensityMultiplier)
 Applies values on the target Animator.
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On stop, turns the bool parameter to false.

Protected Attributes

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

Properties

override float FeedbackDuration [get, set]
 sets the inspector color for this feedback
override bool HasRandomness [get]
override bool HasAutomatedTargetAcquisition [get]

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 )
protected

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

Parameters
position
feedbacksIntensity

◆ 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

◆ _layerID

int MoreMountains.Feedbacks.MMF_Animation._layerID
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

◆ 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

◆ LayerName

string MoreMountains.Feedbacks.MMF_Animation.LayerName = ""

the name of the Animator layer you want the layer weight change to occur on. This is optional. If left empty, the layer ID above will be used, if not empty, the Layer id specified above will be ignored.

◆ NewWeight

float MoreMountains.Feedbacks.MMF_Animation.NewWeight = 0.5f

the new weight to set on the target animator layer

◆ 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

◆ SetLayerWeight

bool MoreMountains.Feedbacks.MMF_Animation.SetLayerWeight = false

whether or not to set layer weights on the specified layer when playing this feedback

◆ TargetLayerIndex

int MoreMountains.Feedbacks.MMF_Animation.TargetLayerIndex = 1

the index of the layer to target when changing layer weights

◆ 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

◆ HasAutomatedTargetAcquisition

override bool MoreMountains.Feedbacks.MMF_Animation.HasAutomatedTargetAcquisition
get

◆ HasRandomness

override bool MoreMountains.Feedbacks.MMF_Animation.HasRandomness
get

The documentation for this class was generated from the following file:
  • H:/Code/MoreMountains/feel/Assets/Feel/MMFeedbacks/MMFeedbacks/Feedbacks/MMF_Animation.cs