This feedback will animate the scale of the target object over time when played More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_Scale:

Public Types
enum	Modes { Absolute , Additive , ToDestination }
	the possible modes this feedback can operate on More...

enum	TimeScales { Scaled , Unscaled }
	the possible timescales for the animation of the scale More...

Public Attributes
Modes	Mode = Modes.Absolute
	sets the inspector color for this feedback More...

Transform	AnimateScaleTarget
	the object to animate More...

float	AnimateScaleDuration = 0.2f
	the duration of the animation More...

float	RemapCurveZero = 1f
	the value to remap the curve's 0 value to More...

float	RemapCurveOne = 2f
	the value to remap the curve's 1 value to More...

float	Offset = 0f
	how much should be added to the curve More...

bool	AnimateX = true
	if this is true, should animate the X scale value More...

AnimationCurve	AnimateScaleX = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1.5f), new Keyframe(1, 0))
	the x scale animation definition More...

bool	AnimateY = true
	if this is true, should animate the Y scale value More...

AnimationCurve	AnimateScaleY = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1.5f), new Keyframe(1, 0))
	the y scale animation definition More...

bool	AnimateZ = true
	if this is true, should animate the z scale value More...

AnimationCurve	AnimateScaleZ = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1.5f), new Keyframe(1, 0))
	the z scale animation definition More...

bool	AllowAdditivePlays = false
	if this is true, calling that feedback will trigger it, even if it's in progress. If it's false, it'll prevent any new Play until the current one is over More...

bool	DetermineScaleOnPlay = false
	if this is true, initial and destination scales will be recomputed on every play More...

Vector3	DestinationScale = new Vector3(0.5f, 0.5f, 0.5f)
	the scale to reach when in ToDestination mode More...

Public Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
bool	Active = true
	whether or not this feedback is active More...

int	UniqueID

string	Label = "MMFeedback"
	the name of this feedback to display in the inspector More...

int	Channel = 0
	the ID of the channel on which this feedback will communicate More...

float	Chance = 100f
	the chance of this feedback happening (in percent : 100 : happens all the time, 0 : never happens, 50 : happens once every two calls, etc) More...

Color	DisplayColor = Color.black
	use this color to customize the background color of the feedback in the MMF_Player's list More...

MMFeedbackTiming	Timing
	a number of timing-related values (delay, repeat, etc) More...

MMF_Player	Owner
	the Owner of the feedback, as defined when calling the Initialization method More...

bool	DebugActive = false
	whether or not this feedback is in debug mode 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	CustomInitialization (MMF_Player owner)
	On init we store our initial scale More...

virtual void	GetInitialScale ()
	Stores initial scale for future use More...

override void	CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	On Play, triggers the scale animation More...

virtual IEnumerator	ScaleToDestination ()
	An internal coroutine used to scale the target to its destination scale More...

virtual IEnumerator	AnimateScale (Transform targetTransform, Vector3 vector, float duration, AnimationCurve curveX, AnimationCurve curveY, AnimationCurve curveZ, float remapCurveZero=0f, float remapCurveOne=1f)
	An internal coroutine used to animate the scale over time More...

override void	CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	On stop, we interrupt movement if it was active More...

virtual void	OnDisable ()
	On disable we reset our coroutine More...

Protected Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual IEnumerator	PlayCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	An internal coroutine delaying the initial play of the feedback More...

virtual void	RegularPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Triggers delaying coroutines if needed More...

virtual IEnumerator	InfinitePlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play without end More...

virtual IEnumerator	RepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play More...

virtual IEnumerator	SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	A coroutine used to play this feedback on a sequence More...

virtual float	ApplyTimeMultiplier (float duration)
	Applies the host MMFeedbacks' time multiplier to this feedback More...

virtual float	ApplyDirection (float normalizedTime)
	Returns a new value of the normalized time based on the current play direction of this feedback More...

virtual void	CustomSkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets skipped to the end More...

virtual void	CustomReset ()
	This method describes what happens when the feedback gets reset More...

Protected Attributes
Vector3	_initialScale

Vector3	_newScale

Coroutine	_coroutine

Protected Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
float	_lastPlayTimestamp = -1f

int	_playsLeft

bool	_initialized = false

Coroutine	_playCoroutine

Coroutine	_infinitePlayCoroutine

Coroutine	_sequenceCoroutine

Coroutine	_repeatedPlayCoroutine

bool	_requiresSetup = false

string	_requiredTarget = ""

int	_sequenceTrackID = 0

float	_beatInterval

bool	BeatThisFrame = false

int	LastBeatIndex = 0

int	CurrentSequenceIndex = 0

float	LastBeatTimestamp = 0f

Properties
override float	FeedbackDuration `[getset]`
	the duration of this feedback is the duration of the scale animation More...

Properties inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual IEnumerator	Pause `[get]`
	set this to true if your feedback should pause the execution of the feedback sequence More...

virtual bool	HoldingPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run More...

virtual bool	LooperPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	ScriptDrivenPause `[getset]`
	if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution More...

virtual float	ScriptDrivenPauseAutoResume `[getset]`
	if this is a positive value, the feedback will auto resume after that duration if it hasn't been resumed via script already More...

virtual bool	LooperStart `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	HasChannel `[get]`
	if this is true, the Channel property will be displayed, otherwise it'll be hidden More...

virtual bool	HasCustomInspectors `[get]`

virtual bool	InCooldown `[get]`
	returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise More...

virtual bool	IsPlaying `[getset]`
	if this is true, this feedback is currently playing More...

virtual float	FeedbackTime `[get]`
	the time (or unscaled time) based on the selected Timing settings More...

virtual float	FeedbackDeltaTime `[get]`
	the delta time (or unscaled delta time) based on the selected Timing settings More...

virtual float	TotalDuration `[get]`
	The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats) More...

bool	RequiresSetup `[get]`
	A flag used to determine if a feedback has all it needs, or if it requires some extra setup. This flag will be used to display a warning icon in the inspector if the feedback is not ready to be played. More...

string	RequiredTarget `[get]`

virtual bool	DrawGroupInspectors `[get]`

virtual string	RequiresSetupText `[get]`

virtual string	RequiredTargetText `[get]`

virtual float?	FeedbackStartedAt `[get]`

virtual float	FeedbackDuration `[getset]`

virtual bool	FeedbackPlaying `[get]`
	whether or not this feedback is playing right now More...

virtual float?	FinalNormalizedTime `[get]`
	Returns the t value at which to evaluate a curve at the end of this feedback's play time More...

virtual bool	NormalPlayDirection `[get]`
	Returns true if this feedback should play normally, or false if it should play in rewind More...

virtual bool	ShouldPlayInThisSequenceDirection `[get]`
	Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting More...

Additional Inherited Members
Public Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual void	CacheRequiresSetup ()

virtual bool	EvaluateRequiresSetup ()
	Override this method to determine if a feedback requires setup More...

virtual void	Initialization (MMF_Player owner)
	Initializes the feedback and its timing related variables More...

virtual void	Play (Vector3 position, float feedbacksIntensity=1.0f)
	Plays the feedback More...

virtual void	SetSequence (MMSequence newSequence)
	Use this method to change this feedback's sequence at runtime More...

virtual void	Stop (Vector3 position, float feedbacksIntensity=1.0f)
	Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations More...

virtual void	SkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	Called when skipping to the end of MMF_Player, calls custom Skip on all feedbacks More...

virtual void	ResetFeedback ()
	Calls this feedback's custom reset More...

virtual void	SetDelayBetweenRepeats (float delay)
	Use this method to specify a new delay between repeats at runtime More...

virtual void	SetInitialDelay (float delay)
	Use this method to specify a new initial delay at runtime More...

virtual void	InitializeCustomAttributes ()
	Use this method to initialize any custom attributes you may have More...

virtual void	OnValidate ()
	Triggered when a change happens in the inspector More...

virtual void	OnDestroy ()
	Triggered when that feedback gets destroyed More...

Detailed Description

This feedback will animate the scale of the target object over time when played

Member Enumeration Documentation

◆ Modes

enum MoreMountains.Feedbacks.MMF_Scale.Modes

the possible modes this feedback can operate on

Enumerator
Absolute
Additive
ToDestination

◆ TimeScales

enum MoreMountains.Feedbacks.MMF_Scale.TimeScales

the possible timescales for the animation of the scale

Enumerator
Scaled
Unscaled

Member Function Documentation

◆ AnimateScale()

virtual IEnumerator MoreMountains.Feedbacks.MMF_Scale.AnimateScale	(	Transform	targetTransform,
		Vector3	vector,
		float	duration,
		AnimationCurve	curveX,
		AnimationCurve	curveY,
		AnimationCurve	curveZ,
		float	remapCurveZero = `0f`,
		float	remapCurveOne = `1f`
	)

protectedvirtual

An internal coroutine used to animate the scale over time

Parameters

targetTransform
vector
duration
curveX
curveY
curveZ
multiplier

Returns

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_Scale.CustomInitialization ( MMF_Player owner )

protectedvirtual

On init we store our initial scale

Parameters

owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

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

protectedvirtual

On Play, triggers the scale animation

Parameters

position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_Scale.CustomStopFeedback	(	Vector3	position,
		float	feedbacksIntensity = `1.0f`
	)

protectedvirtual

On stop, we interrupt movement if it was active

Parameters

position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ GetInitialScale()

virtual void MoreMountains.Feedbacks.MMF_Scale.GetInitialScale ( )

protectedvirtual

Stores initial scale for future use

◆ OnDisable()

virtual void MoreMountains.Feedbacks.MMF_Scale.OnDisable ( )

protectedvirtual

On disable we reset our coroutine

◆ ScaleToDestination()

virtual IEnumerator MoreMountains.Feedbacks.MMF_Scale.ScaleToDestination ( )

protectedvirtual

An internal coroutine used to scale the target to its destination scale

Returns

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMF_Scale._coroutine

protected

◆ _initialScale

Vector3 MoreMountains.Feedbacks.MMF_Scale._initialScale

protected

◆ _newScale

Vector3 MoreMountains.Feedbacks.MMF_Scale._newScale

protected

◆ AllowAdditivePlays

bool MoreMountains.Feedbacks.MMF_Scale.AllowAdditivePlays = false

if this is true, calling that feedback will trigger it, even if it's in progress. If it's false, it'll prevent any new Play until the current one is over

◆ AnimateScaleDuration

float MoreMountains.Feedbacks.MMF_Scale.AnimateScaleDuration = 0.2f

the duration of the animation

◆ AnimateScaleTarget

Transform MoreMountains.Feedbacks.MMF_Scale.AnimateScaleTarget

the object to animate

◆ AnimateScaleX

AnimationCurve MoreMountains.Feedbacks.MMF_Scale.AnimateScaleX = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1.5f), new Keyframe(1, 0))

the x scale animation definition

◆ AnimateScaleY

AnimationCurve MoreMountains.Feedbacks.MMF_Scale.AnimateScaleY = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1.5f), new Keyframe(1, 0))

the y scale animation definition

◆ AnimateScaleZ

AnimationCurve MoreMountains.Feedbacks.MMF_Scale.AnimateScaleZ = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1.5f), new Keyframe(1, 0))

the z scale animation definition

◆ AnimateX

bool MoreMountains.Feedbacks.MMF_Scale.AnimateX = true

if this is true, should animate the X scale value

◆ AnimateY

bool MoreMountains.Feedbacks.MMF_Scale.AnimateY = true

if this is true, should animate the Y scale value

◆ AnimateZ

bool MoreMountains.Feedbacks.MMF_Scale.AnimateZ = true

if this is true, should animate the z scale value

◆ DestinationScale

Vector3 MoreMountains.Feedbacks.MMF_Scale.DestinationScale = new Vector3(0.5f, 0.5f, 0.5f)

the scale to reach when in ToDestination mode

◆ DetermineScaleOnPlay

bool MoreMountains.Feedbacks.MMF_Scale.DetermineScaleOnPlay = false

if this is true, initial and destination scales will be recomputed on every play

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Scale.FeedbackTypeAuthorized = true

static

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

◆ Mode

Modes MoreMountains.Feedbacks.MMF_Scale.Mode = Modes.Absolute

sets the inspector color for this feedback

the mode this feedback should operate on Absolute : follows the curve Additive : adds to the current scale of the target ToDestination : sets the scale to the destination target, whatever the current scale is

◆ Offset

float MoreMountains.Feedbacks.MMF_Scale.Offset = 0f

how much should be added to the curve

◆ RemapCurveOne

float MoreMountains.Feedbacks.MMF_Scale.RemapCurveOne = 2f

the value to remap the curve's 1 value to

◆ RemapCurveZero

float MoreMountains.Feedbacks.MMF_Scale.RemapCurveZero = 1f

the value to remap the curve's 0 value to

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_Scale.FeedbackDuration

getset

the duration of this feedback is the duration of the scale animation

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

Assets/InfiniteRunnerEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Feedbacks/MMF_Scale.cs

Public Types

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Modes

◆ TimeScales

Member Function Documentation

◆ AnimateScale()

◆ CustomInitialization()

◆ CustomPlayFeedback()

◆ CustomStopFeedback()

◆ GetInitialScale()

◆ OnDisable()

◆ ScaleToDestination()

Member Data Documentation

◆ _coroutine

◆ _initialScale

◆ _newScale

◆ AllowAdditivePlays

◆ AnimateScaleDuration

◆ AnimateScaleTarget

◆ AnimateScaleX

◆ AnimateScaleY

◆ AnimateScaleZ

◆ AnimateX

◆ AnimateY

◆ AnimateZ

◆ DestinationScale

◆ DetermineScaleOnPlay

◆ FeedbackTypeAuthorized

◆ Mode

◆ Offset

◆ RemapCurveOne

◆ RemapCurveZero

Property Documentation

◆ FeedbackDuration