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

A feedback used to pilot float springs More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_SpringFloat:
MoreMountains.Feedbacks.MMF_Feedback

Public Attributes

override bool HasChannel => true
 
override bool CanForceInitialValue => true
 
MMSpringComponentBase TargetSpring
 the spring we want to pilot using this feedback. If you set one, only that spring will be targeted. If you don't, an event will be sent out to all springs matching the channel data info More...
 
float DeclaredDuration = 0f
 the duration for the player to consider. This won't impact your particle system, but is a way to communicate to the MMF Player the duration of this feedback. Usually you'll want it to match your actual particle system, and setting it can be useful to have this feedback work with holding pauses. More...
 
SpringCommands Command = SpringCommands.Bump
 the command to use on that spring More...
 
float MoveToValue = 2f
 the new value this spring should move towards More...
 
float BumpAmount = 75f
 the amount to add to the spring's current velocity to disturb it and make it bump More...
 
Vector2 MoveToRandomValue = new Vector2(-2f, 2f)
 a min and max values to pick a random value from to move the spring to when MoveToRandom is called More...
 
Vector2 BumpAmountRandomValue = new Vector2(-50f, 50f)
 a min and max values to pick a random value from to add to the spring's velocity when BumpRandom is called More...
 
bool OverrideDamping = false
 whether or not to override the current Damping value of the target spring(s) with the one specified below (NewDamping) More...
 
float NewDamping = 0.8f
 the new damping value to apply to the target spring(s) if OverrideDamping is true More...
 
bool OverrideFrequency = false
 whether or not to override the current Frequency value of the target spring(s) with the one specified below (NewFrequency) More...
 
float NewFrequency = 5f
 the new frequency value to apply to the target spring(s) if OverrideFrequency is true 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 CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play, triggers a spring event with the selected settings More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 On stop, triggers a spring stop event More...
 
override void CustomRestoreInitialValues ()
 On restore, triggers a spring RestoreInitialValue event More...
 

Protected Attributes

MMChannelData _eventChannelData
 

Properties

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

Additional Inherited Members

Detailed Description

A feedback used to pilot float springs

Member Function Documentation

◆ CustomPlayFeedback()

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

On Play, triggers a spring event with the selected settings

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

override void MoreMountains.Feedbacks.MMF_SpringFloat.CustomRestoreInitialValues ( )
protectedvirtual

On restore, triggers a spring RestoreInitialValue event

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_SpringFloat.CustomStopFeedback ( Vector3  position,
float  feedbacksIntensity = 1 
)
protectedvirtual

On stop, triggers a spring stop event

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ _eventChannelData

MMChannelData MoreMountains.Feedbacks.MMF_SpringFloat._eventChannelData
protected

◆ BumpAmount

float MoreMountains.Feedbacks.MMF_SpringFloat.BumpAmount = 75f

the amount to add to the spring's current velocity to disturb it and make it bump

◆ BumpAmountRandomValue

Vector2 MoreMountains.Feedbacks.MMF_SpringFloat.BumpAmountRandomValue = new Vector2(-50f, 50f)

a min and max values to pick a random value from to add to the spring's velocity when BumpRandom is called

◆ CanForceInitialValue

override bool MoreMountains.Feedbacks.MMF_SpringFloat.CanForceInitialValue => true

◆ Command

SpringCommands MoreMountains.Feedbacks.MMF_SpringFloat.Command = SpringCommands.Bump

the command to use on that spring

◆ DeclaredDuration

float MoreMountains.Feedbacks.MMF_SpringFloat.DeclaredDuration = 0f

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

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_SpringFloat.FeedbackTypeAuthorized = true
static

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

◆ HasChannel

override bool MoreMountains.Feedbacks.MMF_SpringFloat.HasChannel => true

◆ MoveToRandomValue

Vector2 MoreMountains.Feedbacks.MMF_SpringFloat.MoveToRandomValue = new Vector2(-2f, 2f)

a min and max values to pick a random value from to move the spring to when MoveToRandom is called

◆ MoveToValue

float MoreMountains.Feedbacks.MMF_SpringFloat.MoveToValue = 2f

the new value this spring should move towards

◆ NewDamping

float MoreMountains.Feedbacks.MMF_SpringFloat.NewDamping = 0.8f

the new damping value to apply to the target spring(s) if OverrideDamping is true

◆ NewFrequency

float MoreMountains.Feedbacks.MMF_SpringFloat.NewFrequency = 5f

the new frequency value to apply to the target spring(s) if OverrideFrequency is true

◆ OverrideDamping

bool MoreMountains.Feedbacks.MMF_SpringFloat.OverrideDamping = false

whether or not to override the current Damping value of the target spring(s) with the one specified below (NewDamping)

◆ OverrideFrequency

bool MoreMountains.Feedbacks.MMF_SpringFloat.OverrideFrequency = false

whether or not to override the current Frequency value of the target spring(s) with the one specified below (NewFrequency)

◆ TargetSpring

MMSpringComponentBase MoreMountains.Feedbacks.MMF_SpringFloat.TargetSpring

the spring we want to pilot using this feedback. If you set one, only that spring will be targeted. If you don't, an event will be sent out to all springs matching the channel data info

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_SpringFloat.FeedbackDuration
getset

sets the inspector color for this feedback

the duration of this feedback is the duration of the zoom


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