MoreMountains.Feedbacks.MMSpringVector2Component< T > Class Template Reference

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

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

Public Member Functions
virtual void	MoveTo (Vector2 newValue)
virtual void	MoveToAdditive (Vector2 newValue)
virtual void	MoveToSubtractive (Vector2 newValue)
virtual void	MoveToRandom ()
virtual void	MoveToInstant (Vector2 newValue)
virtual void	MoveToRandom (Vector2 min, Vector2 max)
virtual void	Bump (Vector2 bumpAmount)
virtual void	BumpRandom ()
virtual void	BumpRandom (Vector2 min, Vector2 max)
override void	Stop ()
	Stops all value movement on this spring.
override void	RestoreInitialValue ()
	Restores this spring's initial value.
override void	ResetInitialValue ()
	Sets the current value of this spring as its new initial value, overriding the previous one.
override void	Finish ()
	Moves this spring to its destination and disables it.
void	OnMMEvent (MMSpringVector2Event 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.
Public Member Functions inherited from MoreMountains.Tools.MMEventListener< T >
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)
MMChannelModes	ChannelMode = MMChannelModes.Int
int	Channel = 0
	the channel to listen to - has to match the one on the feedback
MMChannel	MMChannelDefinition = null
MMSpringVector2	SpringVector2 = new MMSpringVector2()
Vector2	MoveToRandomValueMin = new Vector2(-2f, -2f)
	the minimum vector from which to pick a random value when calling MoveToRandom()
Vector2	MoveToRandomValueMax = new Vector2(2f, 2f)
	the maximum vector from which to pick a random value when calling MoveToRandom()
Vector2	BumpAmountRandomValueMin = new Vector2(-20f, -20f)
	the minimum vector from which to pick a random value when calling BumpRandom()
Vector2	BumpAmountRandomValueMax = new Vector2(20f, 20f)
	the maximum vector from which to pick a random value when calling BumpRandom()
Vector2	TestMoveToValue = new Vector2(2f, 2f)
	the value to move this spring to when interacting with any of the MoveTo debug buttons in its inspector
bool	MoveToToolbar
Vector2	TestBumpAmount = new Vector2(75f, 100f)
	the amount by which to bump this spring when interacting with the Bump debug button in its inspector
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.
override void	Initialization ()
	Performs initialization for this spring.
virtual void	ApplyValue (Vector2 newValue)
override void	GrabCurrentValue ()
	Grabs the current value on the spring's target.
override void	Awake ()
	On awake we self disable.
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.
virtual void	Activate ()
	Activates this component.
virtual void	SelfDisable ()
	Disables this component.

Properties
override bool	LowVelocity [get]
float	DeltaTime [get]
virtual Vector2	TargetVector2 [get, set]
Properties inherited from MoreMountains.Feedbacks.MMSpringComponentBase
virtual bool	LowVelocity [get]
	whether or not this spring has reached a low enough velocity to self disable

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 Vector2 values on a target.

Type Constraints

T

:

Component

Member Function Documentation

ApplyValue()

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.ApplyValue ( Vector2 newValue )

protectedvirtual

Awake()

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

protectedvirtual

On awake we self disable.

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

Bump()

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.Bump ( Vector2 bumpAmount )

virtual

BumpRandom() [1/2]

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

virtual

BumpRandom() [2/2]

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.BumpRandom ( Vector2 min, Vector2 max )

virtual

Finish()

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

virtual

Moves this spring to its destination and disables it.

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

GrabCurrentValue()

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

protectedvirtual

Grabs the current value on the spring's target.

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

Initialization()

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

protectedvirtual

Performs initialization for this spring.

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

MoveTo()

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveTo ( Vector2 newValue )

virtual

MoveToAdditive()

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveToAdditive ( Vector2 newValue )

virtual

MoveToInstant()

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveToInstant ( Vector2 newValue )

virtual

MoveToRandom() [1/2]

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

virtual

MoveToRandom() [2/2]

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveToRandom ( Vector2 min, Vector2 max )

virtual

MoveToSubtractive()

virtual void MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveToSubtractive ( Vector2 newValue )

virtual

OnDestroy()

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

protected

OnMMEvent()

void MoreMountains.Feedbacks.MMSpringVector2Component< T >.OnMMEvent

(

MMSpringVector2Event

springEvent

)

ResetInitialValue()

override void MoreMountains.Feedbacks.MMSpringVector2Component< 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.MMSpringVector2Component< T >.RestoreInitialValue ( )

virtual

Restores this spring's initial value.

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

Stop()

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

virtual

Stops all value movement on this spring.

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

TestBump()

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

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

TestBumpRandom()

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

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

TestMoveTo()

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

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

TestMoveToAdditive()

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

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

TestMoveToInstant()

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

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

TestMoveToRandom()

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

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

TestMoveToSubtractive()

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

protectedvirtual

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

UpdateSpringValue()

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

protectedvirtual

Updates the spring's target value.

Reimplemented from MoreMountains.Feedbacks.MMSpringComponentBase.

Member Data Documentation

BumpAmountRandomValueMax

Vector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.BumpAmountRandomValueMax = new Vector2(20f, 20f)

the maximum vector from which to pick a random value when calling BumpRandom()

BumpAmountRandomValueMin

Vector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.BumpAmountRandomValueMin = new Vector2(-20f, -20f)

the minimum vector from which to pick a random value when calling BumpRandom()

BumpToToolbar

bool MoreMountains.Feedbacks.MMSpringVector2Component< T >.BumpToToolbar

Channel

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

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

ChannelMode

MMChannelModes MoreMountains.Feedbacks.MMSpringVector2Component< 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

MMChannelDefinition

MMChannel MoreMountains.Feedbacks.MMSpringVector2Component< 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

MoveToRandomValueMax

Vector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveToRandomValueMax = new Vector2(2f, 2f)

the maximum vector from which to pick a random value when calling MoveToRandom()

MoveToRandomValueMin

Vector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveToRandomValueMin = new Vector2(-2f, -2f)

the minimum vector from which to pick a random value when calling MoveToRandom()

MoveToToolbar

bool MoreMountains.Feedbacks.MMSpringVector2Component< T >.MoveToToolbar

OtherControlsToToolbar

bool MoreMountains.Feedbacks.MMSpringVector2Component< T >.OtherControlsToToolbar

SpringVector2

MMSpringVector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.SpringVector2 = new MMSpringVector2()

Target

T MoreMountains.Feedbacks.MMSpringVector2Component< T >.Target

TestBumpAmount

Vector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.TestBumpAmount = new Vector2(75f, 100f)

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

TestMoveToValue

Vector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.TestMoveToValue = new Vector2(2f, 2f)

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

TimeScaleMode

TimeScaleModes MoreMountains.Feedbacks.MMSpringVector2Component< 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.MMSpringVector2Component< T >.DeltaTime

get

LowVelocity

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

get

TargetVector2

virtual Vector2 MoreMountains.Feedbacks.MMSpringVector2Component< T >.TargetVector2

getset

---

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

• H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Springs/Core/Components/MMSpringVector2Component.cs