A spring component used to pilot float values on a target More...

Inheritance diagram for MoreMountains.Feedbacks.MMSpringFloatComponent< T >:

Public Member Functions
virtual void	MoveTo (float newValue)

virtual void	MoveToAdditive (float newValue)

virtual void	MoveToSubtractive (float newValue)

virtual void	MoveToRandom ()

virtual void	MoveToInstant (float newValue)

virtual void	MoveToRandom (float min, float max)

virtual void	Bump (float bumpAmount)

virtual void	BumpRandom ()

virtual void	BumpRandom (float min, float max)

override void	Stop ()
	Stops all value movement on this spring More...

override void	RestoreInitialValue ()
	Restores this spring's initial value More...

override void	ResetInitialValue ()
	Sets the current value of this spring as its new initial value, overriding the previous one More...

override void	Finish ()
	Moves this spring to its destination and disables it More...

void	OnMMEvent (MMSpringFloatEvent springEvent)

Public Member Functions inherited from MoreMountains.Feedbacks.MMSpringComponentBase
virtual void	SetVelocityLowThreshold (float threshold)
	Sets the threshold under which the spring will consider its velocity as too low and will self disable More...

Public Member Functions inherited from MoreMountains.Tools.MMEventListener< MMSpringFloatEvent >
void	OnMMEvent (T eventType)

Public Attributes
T	Target

TimeScaleModes	TimeScaleMode = TimeScaleModes.Scaled
	whether this spring should run on scaled time (and be impacted by time scale changes) or unscaled time (and not be impacted by time scale changes) More...

MMChannelModes	ChannelMode = MMChannelModes.Int

int	Channel = 0
	the channel to listen to - has to match the one on the feedback More...

MMChannel	MMChannelDefinition = null

MMSpringFloat	FloatSpring = new MMSpringFloat()

Vector2	MoveToRandomValue = new Vector2(-2f, 2f)
	the min (x) and max (y) values between which a random target value will be picked when calling MoveToRandom More...

Vector2	BumpAmountRandomValue = new Vector2(20f, 100f)
	the min (x) and max (y) values between which a random bump value will be picked when calling BumpRandom More...

float	TestMoveToValue = 2f
	the value to move this spring to when interacting with any of the MoveTo debug buttons in its inspector More...

bool	MoveToToolbar

float	TestBumpAmount = 75f
	the amount by which to bump this spring when interacting with the Bump debug button in its inspector More...

bool	BumpToToolbar

bool	OtherControlsToToolbar

Public Attributes inherited from MoreMountains.Feedbacks.MMSpringComponentBase
UnityEvent	OnEquilibriumReached

Protected Member Functions
override void	UpdateSpringValue ()
	Updates the spring's target value More...

override void	Initialization ()
	Performs initialization for this spring More...

virtual void	ApplyValue (float newValue)

override void	GrabCurrentValue ()
	Grabs the current value on the spring's target More...

override void	Awake ()
	On awake we self disable More...

void	OnDestroy ()

override void	TestMoveTo ()

override void	TestMoveToAdditive ()

override void	TestMoveToSubtractive ()

override void	TestMoveToRandom ()

override void	TestMoveToInstant ()

override void	TestBump ()

override void	TestBumpRandom ()

Protected Member Functions inherited from MoreMountains.Feedbacks.MMSpringComponentBase
virtual void	Update ()
	On update we update our spring value and self disable if needed More...

virtual void	Activate ()
	Activates this component More...

virtual void	SelfDisable ()
	Disables this component More...

Properties
override bool	LowVelocity `[get]`

float	DeltaTime `[get]`

virtual float	TargetFloat `[getset]`

Properties inherited from MoreMountains.Feedbacks.MMSpringComponentBase
virtual bool	LowVelocity `[get]`
	whether or not this spring has reached a low enough velocity to self disable More...

Additional Inherited Members
Public Types inherited from MoreMountains.Feedbacks.MMSpringComponentBase
enum	TimeScaleModes { Unscaled , Scaled }
	the different possible timescale modes for the spring More...

Protected Attributes inherited from MoreMountains.Feedbacks.MMSpringComponentBase
float	_velocityLowThreshold = 0.001f

Detailed Description

A spring component used to pilot float values on a target

Type Constraints

T

:

Component

Member Function Documentation

◆ ApplyValue()

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.ApplyValue ( float newValue )

protectedvirtual

Reimplemented in MoreMountains.Feedbacks.MMSpringSquashAndStretch.

◆ Awake()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.Awake ( )

protectedvirtual

On awake we self disable

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ Bump()

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.Bump ( float bumpAmount )

virtual

◆ BumpRandom() [1/2]

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.BumpRandom ( )

virtual

◆ BumpRandom() [2/2]

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.BumpRandom	(	float	min,
		float	max
	)

virtual

◆ Finish()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.Finish ( )

virtual

Moves this spring to its destination and disables it

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ GrabCurrentValue()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.GrabCurrentValue ( )

protectedvirtual

Grabs the current value on the spring's target

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ Initialization()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.Initialization ( )

protectedvirtual

Performs initialization for this spring

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ MoveTo()

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveTo ( float newValue )

virtual

◆ MoveToAdditive()

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveToAdditive ( float newValue )

virtual

◆ MoveToInstant()

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveToInstant ( float newValue )

virtual

◆ MoveToRandom() [1/2]

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveToRandom ( )

virtual

◆ MoveToRandom() [2/2]

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveToRandom	(	float	min,
		float	max
	)

virtual

◆ MoveToSubtractive()

virtual void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveToSubtractive ( float newValue )

virtual

◆ OnDestroy()

void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.OnDestroy ( )

protected

◆ OnMMEvent()

void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.OnMMEvent ( MMSpringFloatEvent springEvent )

◆ ResetInitialValue()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.ResetInitialValue ( )

virtual

Sets the current value of this spring as its new initial value, overriding the previous one

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ RestoreInitialValue()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.RestoreInitialValue ( )

virtual

Restores this spring's initial value

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ Stop()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.Stop ( )

virtual

Stops all value movement on this spring

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ TestBump()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestBump ( )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ TestBumpRandom()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestBumpRandom ( )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ TestMoveTo()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestMoveTo ( )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ TestMoveToAdditive()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestMoveToAdditive ( )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ TestMoveToInstant()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestMoveToInstant ( )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ TestMoveToRandom()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestMoveToRandom ( )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ TestMoveToSubtractive()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestMoveToSubtractive ( )

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

◆ UpdateSpringValue()

override void MoreMountains.Feedbacks.MMSpringFloatComponent< T >.UpdateSpringValue ( )

protectedvirtual

Updates the spring's target value

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

Member Data Documentation

◆ BumpAmountRandomValue

Vector2 MoreMountains.Feedbacks.MMSpringFloatComponent< T >.BumpAmountRandomValue = new Vector2(20f, 100f)

the min (x) and max (y) values between which a random bump value will be picked when calling BumpRandom

◆ BumpToToolbar

bool MoreMountains.Feedbacks.MMSpringFloatComponent< T >.BumpToToolbar

◆ Channel

int MoreMountains.Feedbacks.MMSpringFloatComponent< T >.Channel = 0

the channel to listen to - has to match the one on the feedback

◆ ChannelMode

MMChannelModes MoreMountains.Feedbacks.MMSpringFloatComponent< T >.ChannelMode = MMChannelModes.Int

whether to listen on a channel defined by an int or by a MMChannel scriptable object. Ints are simple to setup but can get messy and make it harder to remember what int corresponds to what. MMChannel scriptable objects require you to create them in advance, but come with a readable name and are more scalable

◆ FloatSpring

MMSpringFloat MoreMountains.Feedbacks.MMSpringFloatComponent< T >.FloatSpring = new MMSpringFloat()

◆ MMChannelDefinition

MMChannel MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MMChannelDefinition = null

the MMChannel definition asset to use to listen for events. The feedbacks targeting this shaker will have to reference that same MMChannel definition to receive events - to create a MMChannel, right click anywhere in your project (usually in a Data folder) and go MoreMountains > MMChannel, then name it with some unique name

◆ MoveToRandomValue

Vector2 MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveToRandomValue = new Vector2(-2f, 2f)

the min (x) and max (y) values between which a random target value will be picked when calling MoveToRandom

◆ MoveToToolbar

bool MoreMountains.Feedbacks.MMSpringFloatComponent< T >.MoveToToolbar

◆ OtherControlsToToolbar

bool MoreMountains.Feedbacks.MMSpringFloatComponent< T >.OtherControlsToToolbar

◆ Target

T MoreMountains.Feedbacks.MMSpringFloatComponent< T >.Target

◆ TestBumpAmount

float MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestBumpAmount = 75f

the amount by which to bump this spring when interacting with the Bump debug button in its inspector

◆ TestMoveToValue

float MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TestMoveToValue = 2f

the value to move this spring to when interacting with any of the MoveTo debug buttons in its inspector

◆ TimeScaleMode

TimeScaleModes MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TimeScaleMode = TimeScaleModes.Scaled

whether this spring should run on scaled time (and be impacted by time scale changes) or unscaled time (and not be impacted by time scale changes)

Property Documentation

◆ DeltaTime

float MoreMountains.Feedbacks.MMSpringFloatComponent< T >.DeltaTime

get

◆ LowVelocity

override bool MoreMountains.Feedbacks.MMSpringFloatComponent< T >.LowVelocity

get

◆ TargetFloat

virtual float MoreMountains.Feedbacks.MMSpringFloatComponent< T >.TargetFloat

getset

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

E:/Github/Store/TopDownEngine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Springs/Core/Components/MMSpringFloatComponent.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ApplyValue()

◆ Awake()

◆ Bump()

◆ BumpRandom() [1/2]

◆ BumpRandom() [2/2]

◆ Finish()

◆ GrabCurrentValue()

◆ Initialization()

◆ MoveTo()

◆ MoveToAdditive()

◆ MoveToInstant()

◆ MoveToRandom() [1/2]

◆ MoveToRandom() [2/2]

◆ MoveToSubtractive()

◆ OnDestroy()

◆ OnMMEvent()

◆ ResetInitialValue()

◆ RestoreInitialValue()

◆ Stop()

◆ TestBump()

◆ TestBumpRandom()

◆ TestMoveTo()

◆ TestMoveToAdditive()

◆ TestMoveToInstant()

◆ TestMoveToRandom()

◆ TestMoveToSubtractive()

◆ UpdateSpringValue()

Member Data Documentation

◆ BumpAmountRandomValue

◆ BumpToToolbar

◆ Channel

◆ ChannelMode

◆ FloatSpring

◆ MMChannelDefinition

◆ MoveToRandomValue

◆ MoveToToolbar

◆ OtherControlsToToolbar

◆ Target

◆ TestBumpAmount

◆ TestMoveToValue

◆ TimeScaleMode

Property Documentation

◆ DeltaTime

◆ LowVelocity

◆ TargetFloat