MoreMountains.Feedbacks.MMF_Feedback Class Reference

Inheritance diagram for MoreMountains.Feedbacks.MMF_Feedback:

Public Member Functions
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...

Public Attributes
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...

Protected Member Functions
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	CustomInitialization (MMF_Player owner)
	This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method More...
abstract void	CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets played More...
virtual void	CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets stopped 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
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
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...

Member Function Documentation

ApplyDirection()

virtual float MoreMountains.Feedbacks.MMF_Feedback.ApplyDirection ( float  normalizedTime )

protectedvirtual

Returns a new value of the normalized time based on the current play direction of this feedback

Parameters

normalizedTime

Returns

ApplyTimeMultiplier()

virtual float MoreMountains.Feedbacks.MMF_Feedback.ApplyTimeMultiplier ( float  duration )

protectedvirtual

Applies the host MMFeedbacks' time multiplier to this feedback

Parameters

duration

Returns

CacheRequiresSetup()

virtual void MoreMountains.Feedbacks.MMF_Feedback.CacheRequiresSetup ( )

virtual

CustomInitialization()

virtual void MoreMountains.Feedbacks.MMF_Feedback.CustomInitialization ( MMF_Player  owner )

protectedvirtual

This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method

Parameters

owner

Reimplemented in MoreMountains.Feedbacks.MMF_Animation, MoreMountains.Feedbacks.MMF_Enable, MoreMountains.Feedbacks.MMF_Events, MoreMountains.Feedbacks.MMF_Feedbacks, MoreMountains.Feedbacks.MMF_Flicker, MoreMountains.Feedbacks.MMF_Graphic, MoreMountains.Feedbacks.MMF_Image, MoreMountains.Feedbacks.MMF_InstantiateObject, MoreMountains.Feedbacks.MMF_Light, MoreMountains.Feedbacks.MMF_Looper, MoreMountains.Feedbacks.MMF_Material, MoreMountains.Feedbacks.MMF_Particles, MoreMountains.Feedbacks.MMF_ParticlesInstantiation, MoreMountains.Feedbacks.MMF_Pause, MoreMountains.Feedbacks.MMF_Position, MoreMountains.Feedbacks.MMF_Rotation, MoreMountains.Feedbacks.MMF_Scale, MoreMountains.Feedbacks.MMF_SetActive, MoreMountains.Feedbacks.MMF_SpriteRenderer, MoreMountains.Feedbacks.MMF_SquashAndStretch, MoreMountains.Feedbacks.MMF_TextColor, MoreMountains.Feedbacks.MMF_TextureOffset, MoreMountains.Feedbacks.MMF_TextureScale, MoreMountains.Feedbacks.MMF_Broadcast, MoreMountains.Feedbacks.MMF_FloatController, MoreMountains.Feedbacks.MMF_Property, MoreMountains.Feedbacks.MMF_ShaderController, MoreMountains.Feedbacks.MMF_Sound, MoreMountains.Feedbacks.MMF_FeedbackBase, MoreMountains.Feedbacks.MMF_TMPAlpha, MoreMountains.Feedbacks.MMF_TMPColor, MoreMountains.Feedbacks.MMF_TMPDilate, MoreMountains.Feedbacks.MMF_TMPOutlineColor, and MoreMountains.Feedbacks.MMF_TMPSoftness.

CustomPlayFeedback()

abstract void MoreMountains.Feedbacks.MMF_Feedback.CustomPlayFeedback ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedpure virtual

This method describes what happens when the feedback gets played

Parameters

position
feedbacksIntensity

Implemented in MoreMountains.FeedbacksForThirdParty.MMF_Bloom_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_Bloom_URP, MoreMountains.Feedbacks.MMF_Animation, MoreMountains.Feedbacks.MMF_AudioFilterDistortion, MoreMountains.Feedbacks.MMF_AudioFilterEcho, MoreMountains.Feedbacks.MMF_AudioFilterHighPass, MoreMountains.Feedbacks.MMF_AudioFilterLowPass, MoreMountains.Feedbacks.MMF_AudioFilterReverb, MoreMountains.Feedbacks.MMF_AudioMixerSnapshotTransition, MoreMountains.Feedbacks.MMF_AudioSource, MoreMountains.Feedbacks.MMF_AudioSourcePitch, MoreMountains.Feedbacks.MMF_AudioSourceStereoPan, MoreMountains.Feedbacks.MMF_AudioSourceVolume, MoreMountains.Feedbacks.MMF_CameraClippingPlanes, MoreMountains.Feedbacks.MMF_CameraFieldOfView, MoreMountains.Feedbacks.MMF_CameraOrthographicSize, MoreMountains.Feedbacks.MMF_CameraShake, MoreMountains.Feedbacks.MMF_CameraZoom, MoreMountains.Feedbacks.MMF_CanvasGroupBlocksRaycasts, MoreMountains.Feedbacks.MMF_Collider, MoreMountains.Feedbacks.MMF_Collider2D, MoreMountains.Feedbacks.MMF_DestinationTransform, MoreMountains.Feedbacks.MMF_Destroy, MoreMountains.Feedbacks.MMF_Enable, MoreMountains.Feedbacks.MMF_Events, MoreMountains.Feedbacks.MMF_Feedbacks, MoreMountains.Feedbacks.MMF_Flash, MoreMountains.Feedbacks.MMF_Flicker, MoreMountains.Feedbacks.MMF_FreezeFrame, MoreMountains.Feedbacks.MMF_Graphic, MoreMountains.Feedbacks.MMF_GraphicCrossFade, MoreMountains.Feedbacks.MMF_HoldingPause, MoreMountains.Feedbacks.MMF_Image, MoreMountains.Feedbacks.MMF_ImageRaycastTarget, MoreMountains.Feedbacks.MMF_InstantiateObject, MoreMountains.Feedbacks.MMF_Light, MoreMountains.Feedbacks.MMF_Looper, MoreMountains.Feedbacks.MMF_LooperStart, MoreMountains.Feedbacks.MMF_Material, MoreMountains.Feedbacks.MMF_Particles, MoreMountains.Feedbacks.MMF_ParticlesInstantiation, MoreMountains.Feedbacks.MMF_Pause, MoreMountains.Feedbacks.MMF_Position, MoreMountains.Feedbacks.MMF_Rigidbody, MoreMountains.Feedbacks.MMF_Rigidbody2D, MoreMountains.Feedbacks.MMF_Rotation, MoreMountains.Feedbacks.MMF_Scale, MoreMountains.Feedbacks.MMF_SetActive, MoreMountains.Feedbacks.MMF_ShaderGlobal, MoreMountains.Feedbacks.MMF_Skybox, MoreMountains.Feedbacks.MMF_SpriteRenderer, MoreMountains.Feedbacks.MMF_SquashAndStretch, MoreMountains.Feedbacks.MMF_Text, MoreMountains.Feedbacks.MMF_TextColor, MoreMountains.Feedbacks.MMF_TextureOffset, MoreMountains.Feedbacks.MMF_TextureScale, MoreMountains.Feedbacks.MMF_TimescaleModifier, MoreMountains.Feedbacks.MMF_UnloadScene, MoreMountains.Feedbacks.MMF_VideoPlayer, MoreMountains.Feedbacks.MMF_Wiggle, MoreMountains.FeedbacksForThirdParty.MMF_CinemachineImpulse, MoreMountains.FeedbacksForThirdParty.MMF_CinemachineImpulseClear, MoreMountains.FeedbacksForThirdParty.MMF_CinemachineImpulseSource, MoreMountains.FeedbacksForThirdParty.MMF_CinemachineTransition, MoreMountains.FeedbacksForThirdParty.MMF_ChannelMixer_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_ChromaticAberration_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_ColorAdjustments_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_Exposure_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_FilmGrain_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_LensDistortion_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_MotionBlur_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_PaniniProjection_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_Vignette_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_WhiteBalance_HDRP, MoreMountains.Feedbacks.MMF_Blink, MoreMountains.Feedbacks.MMF_DebugComment, MoreMountains.Feedbacks.MMF_DebugLog, MoreMountains.Feedbacks.MMF_Fade, MoreMountains.Feedbacks.MMF_FloatController, MoreMountains.Feedbacks.MMF_FloatingText, MoreMountains.Feedbacks.MMF_Fog, MoreMountains.Feedbacks.MMF_ImageAlpha, MoreMountains.Feedbacks.MMF_LoadScene, MoreMountains.Feedbacks.MMF_MMGameEvent, MoreMountains.Feedbacks.MMF_MMSoundManagerAllSoundsControl, MoreMountains.Feedbacks.MMF_MMSoundManagerSaveLoad, MoreMountains.Feedbacks.MMF_MMSoundManagerSound, MoreMountains.Feedbacks.MMF_MMSoundManagerSoundControl, MoreMountains.Feedbacks.MMF_MMSoundManagerSoundFade, MoreMountains.Feedbacks.MMF_MMSoundManagerTrackControl, MoreMountains.Feedbacks.MMF_MMSoundManagerTrackFade, MoreMountains.Feedbacks.MMF_Playlist, MoreMountains.Feedbacks.MMF_PPMovingFilter, MoreMountains.Feedbacks.MMF_Property, MoreMountains.Feedbacks.MMF_RadioSignal, MoreMountains.Feedbacks.MMF_ShaderController, MoreMountains.Feedbacks.MMF_Sound, MoreMountains.Feedbacks.MMF_FeedbackBase, MoreMountains.FeedbacksForThirdParty.MMF_Haptics, MoreMountains.FeedbacksForThirdParty.MMF_NVClip, MoreMountains.FeedbacksForThirdParty.MMF_NVContinuous, MoreMountains.FeedbacksForThirdParty.MMF_NVControl, MoreMountains.FeedbacksForThirdParty.MMF_NVEmphasis, MoreMountains.FeedbacksForThirdParty.MMF_NVPreset, MoreMountains.FeedbacksForThirdParty.MMF_Bloom, MoreMountains.FeedbacksForThirdParty.MMF_ChromaticAberration, MoreMountains.FeedbacksForThirdParty.MMF_ColorGrading, MoreMountains.FeedbacksForThirdParty.MMF_DepthOfField, MoreMountains.FeedbacksForThirdParty.MMF_GlobalPPVolumeAutoBlend, MoreMountains.FeedbacksForThirdParty.MMF_LensDistortion, MoreMountains.FeedbacksForThirdParty.MMF_Vignette, MoreMountains.Feedbacks.MMF_TMPAlpha, MoreMountains.Feedbacks.MMF_TMPColor, MoreMountains.Feedbacks.MMF_TMPCountTo, MoreMountains.Feedbacks.MMF_TMPDilate, MoreMountains.Feedbacks.MMF_TMPOutlineColor, MoreMountains.Feedbacks.MMF_TMPSoftness, MoreMountains.Feedbacks.MMF_TMPText, MoreMountains.Feedbacks.MMF_TMPTextReveal, MoreMountains.FeedbacksForThirdParty.MMF_ChannelMixer_URP, MoreMountains.FeedbacksForThirdParty.MMF_ChromaticAberration_URP, MoreMountains.FeedbacksForThirdParty.MMF_ColorAdjustments_URP, MoreMountains.FeedbacksForThirdParty.MMF_DepthOfField_URP, MoreMountains.FeedbacksForThirdParty.MMF_FilmGrain_URP, MoreMountains.FeedbacksForThirdParty.MMF_GlobalPPVolumeAutoBlend_URP, MoreMountains.FeedbacksForThirdParty.MMF_LensDistortion_URP, MoreMountains.FeedbacksForThirdParty.MMF_MotionBlur_URP, MoreMountains.FeedbacksForThirdParty.MMF_PaniniProjection_URP, MoreMountains.FeedbacksForThirdParty.MMF_Vignette_URP, and MoreMountains.FeedbacksForThirdParty.MMF_WhiteBalance_URP.

CustomReset()

virtual void MoreMountains.Feedbacks.MMF_Feedback.CustomReset ( )

protectedvirtual

This method describes what happens when the feedback gets reset

Reimplemented in MoreMountains.Feedbacks.MMF_Enable, MoreMountains.Feedbacks.MMF_Events, MoreMountains.Feedbacks.MMF_Flicker, MoreMountains.Feedbacks.MMF_Looper, MoreMountains.Feedbacks.MMF_Particles, MoreMountains.Feedbacks.MMF_ParticlesInstantiation, MoreMountains.Feedbacks.MMF_SetActive, MoreMountains.Feedbacks.MMF_FloatController, and MoreMountains.Feedbacks.MMF_ShaderController.

CustomSkipToTheEnd()

virtual void MoreMountains.Feedbacks.MMF_Feedback.CustomSkipToTheEnd ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedvirtual

This method describes what happens when the feedback gets skipped to the end

Parameters

position
feedbacksIntensity

CustomStopFeedback()

virtual void MoreMountains.Feedbacks.MMF_Feedback.CustomStopFeedback ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedvirtual

This method describes what happens when the feedback gets stopped

Parameters

position
feedbacksIntensity

Reimplemented in MoreMountains.Feedbacks.MMF_AudioFilterDistortion, MoreMountains.Feedbacks.MMF_AudioFilterEcho, MoreMountains.Feedbacks.MMF_AudioFilterHighPass, MoreMountains.Feedbacks.MMF_AudioFilterLowPass, MoreMountains.Feedbacks.MMF_AudioFilterReverb, MoreMountains.Feedbacks.MMF_AudioSourcePitch, MoreMountains.Feedbacks.MMF_AudioSourceStereoPan, MoreMountains.Feedbacks.MMF_AudioSourceVolume, MoreMountains.Feedbacks.MMF_CameraClippingPlanes, MoreMountains.Feedbacks.MMF_CameraFieldOfView, MoreMountains.Feedbacks.MMF_CameraOrthographicSize, MoreMountains.Feedbacks.MMF_CameraShake, MoreMountains.Feedbacks.MMF_CameraZoom, MoreMountains.Feedbacks.MMF_DestinationTransform, MoreMountains.Feedbacks.MMF_Enable, MoreMountains.Feedbacks.MMF_Flash, MoreMountains.Feedbacks.MMF_Flicker, MoreMountains.Feedbacks.MMF_Graphic, MoreMountains.Feedbacks.MMF_GraphicCrossFade, MoreMountains.Feedbacks.MMF_Image, MoreMountains.Feedbacks.MMF_Light, MoreMountains.Feedbacks.MMF_Looper, MoreMountains.Feedbacks.MMF_Material, MoreMountains.Feedbacks.MMF_SetActive, MoreMountains.Feedbacks.MMF_SpriteRenderer, MoreMountains.Feedbacks.MMF_TextColor, MoreMountains.Feedbacks.MMF_TextureOffset, MoreMountains.Feedbacks.MMF_TextureScale, MoreMountains.Feedbacks.MMF_Wiggle, MoreMountains.FeedbacksForThirdParty.MMF_CinemachineImpulse, MoreMountains.FeedbacksForThirdParty.MMF_CinemachineImpulseSource, MoreMountains.FeedbacksForThirdParty.MMF_Bloom_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_ChannelMixer_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_ChromaticAberration_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_ColorAdjustments_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_Exposure_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_FilmGrain_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_LensDistortion_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_MotionBlur_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_PaniniProjection_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_Vignette_HDRP, MoreMountains.FeedbacksForThirdParty.MMF_WhiteBalance_HDRP, MoreMountains.Feedbacks.MMF_Fade, MoreMountains.Feedbacks.MMF_Fog, MoreMountains.Feedbacks.MMF_ImageAlpha, MoreMountains.Feedbacks.MMF_MMSoundManagerSound, MoreMountains.Feedbacks.MMF_PPMovingFilter, MoreMountains.Feedbacks.MMF_Property, MoreMountains.Feedbacks.MMF_RadioSignal, MoreMountains.Feedbacks.MMF_ShaderController, MoreMountains.Feedbacks.MMF_FeedbackBase, MoreMountains.FeedbacksForThirdParty.MMF_Bloom, MoreMountains.FeedbacksForThirdParty.MMF_ChromaticAberration, MoreMountains.FeedbacksForThirdParty.MMF_ColorGrading, MoreMountains.FeedbacksForThirdParty.MMF_DepthOfField, MoreMountains.FeedbacksForThirdParty.MMF_GlobalPPVolumeAutoBlend, MoreMountains.FeedbacksForThirdParty.MMF_LensDistortion, MoreMountains.FeedbacksForThirdParty.MMF_Vignette, MoreMountains.Feedbacks.MMF_TMPAlpha, MoreMountains.Feedbacks.MMF_TMPColor, MoreMountains.Feedbacks.MMF_TMPOutlineColor, MoreMountains.Feedbacks.MMF_TMPTextReveal, MoreMountains.FeedbacksForThirdParty.MMF_Bloom_URP, MoreMountains.FeedbacksForThirdParty.MMF_ChannelMixer_URP, MoreMountains.FeedbacksForThirdParty.MMF_ChromaticAberration_URP, MoreMountains.FeedbacksForThirdParty.MMF_ColorAdjustments_URP, MoreMountains.FeedbacksForThirdParty.MMF_DepthOfField_URP, MoreMountains.FeedbacksForThirdParty.MMF_FilmGrain_URP, MoreMountains.FeedbacksForThirdParty.MMF_GlobalPPVolumeAutoBlend_URP, MoreMountains.FeedbacksForThirdParty.MMF_LensDistortion_URP, MoreMountains.FeedbacksForThirdParty.MMF_MotionBlur_URP, MoreMountains.FeedbacksForThirdParty.MMF_PaniniProjection_URP, MoreMountains.FeedbacksForThirdParty.MMF_Vignette_URP, MoreMountains.FeedbacksForThirdParty.MMF_WhiteBalance_URP, MoreMountains.Feedbacks.MMF_Animation, MoreMountains.Feedbacks.MMF_Events, MoreMountains.Feedbacks.MMF_Particles, MoreMountains.Feedbacks.MMF_ParticlesInstantiation, MoreMountains.Feedbacks.MMF_Position, MoreMountains.Feedbacks.MMF_Rotation, MoreMountains.Feedbacks.MMF_Scale, MoreMountains.Feedbacks.MMF_SquashAndStretch, MoreMountains.Feedbacks.MMF_TimescaleModifier, and MoreMountains.Feedbacks.MMF_FloatController.

EvaluateRequiresSetup()

virtual bool MoreMountains.Feedbacks.MMF_Feedback.EvaluateRequiresSetup ( )

virtual

Override this method to determine if a feedback requires setup

Returns

InfinitePlay()

virtual IEnumerator MoreMountains.Feedbacks.MMF_Feedback.InfinitePlay ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedvirtual

Internal coroutine used for repeated play without end

Parameters

position
feedbacksIntensity

Returns

Initialization()

virtual void MoreMountains.Feedbacks.MMF_Feedback.Initialization ( MMF_Player  owner )

virtual

Initializes the feedback and its timing related variables

Parameters

owner

InitializeCustomAttributes()

virtual void MoreMountains.Feedbacks.MMF_Feedback.InitializeCustomAttributes ( )

virtual

Use this method to initialize any custom attributes you may have

Reimplemented in MoreMountains.Feedbacks.MMF_MMSoundManagerSound, and MoreMountains.Feedbacks.MMF_Sound.

OnDestroy()

virtual void MoreMountains.Feedbacks.MMF_Feedback.OnDestroy ( )

virtual

Triggered when that feedback gets destroyed

OnValidate()

virtual void MoreMountains.Feedbacks.MMF_Feedback.OnValidate ( )

virtual

Triggered when a change happens in the inspector

Reimplemented in MoreMountains.Feedbacks.MMF_FeedbackBase.

Play()

virtual void MoreMountains.Feedbacks.MMF_Feedback.Play ( Vector3  position, float  feedbacksIntensity = 1.0f  )

virtual

Plays the feedback

Parameters

position
feedbacksIntensity

PlayCoroutine()

virtual IEnumerator MoreMountains.Feedbacks.MMF_Feedback.PlayCoroutine ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedvirtual

An internal coroutine delaying the initial play of the feedback

Parameters

position
feedbacksIntensity

Returns

RegularPlay()

virtual void MoreMountains.Feedbacks.MMF_Feedback.RegularPlay ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedvirtual

Triggers delaying coroutines if needed

Parameters

position
feedbacksIntensity

RepeatedPlay()

virtual IEnumerator MoreMountains.Feedbacks.MMF_Feedback.RepeatedPlay ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedvirtual

Internal coroutine used for repeated play

Parameters

position
feedbacksIntensity

Returns

ResetFeedback()

virtual void MoreMountains.Feedbacks.MMF_Feedback.ResetFeedback ( )

virtual

Calls this feedback's custom reset

SequenceCoroutine()

virtual IEnumerator MoreMountains.Feedbacks.MMF_Feedback.SequenceCoroutine ( Vector3  position, float  feedbacksIntensity = 1.0f  )

protectedvirtual

A coroutine used to play this feedback on a sequence

Parameters

position
feedbacksIntensity

Returns

SetDelayBetweenRepeats()

virtual void MoreMountains.Feedbacks.MMF_Feedback.SetDelayBetweenRepeats ( float  delay )

virtual

Use this method to specify a new delay between repeats at runtime

Parameters

delay

SetInitialDelay()

virtual void MoreMountains.Feedbacks.MMF_Feedback.SetInitialDelay ( float  delay )

virtual

Use this method to specify a new initial delay at runtime

Parameters

delay

SetSequence()

virtual void MoreMountains.Feedbacks.MMF_Feedback.SetSequence ( MMSequence  newSequence )

virtual

Use this method to change this feedback's sequence at runtime

Parameters

newSequence

SkipToTheEnd()

virtual void MoreMountains.Feedbacks.MMF_Feedback.SkipToTheEnd ( Vector3  position, float  feedbacksIntensity = 1.0f  )

virtual

Called when skipping to the end of MMF_Player, calls custom Skip on all feedbacks

Parameters

position
feedbacksIntensity

Stop()

virtual void MoreMountains.Feedbacks.MMF_Feedback.Stop ( Vector3  position, float  feedbacksIntensity = 1.0f  )

virtual

Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations

Parameters

position
feedbacksIntensity

Reimplemented in MoreMountains.Feedbacks.MMF_AudioSource.

Member Data Documentation

_beatInterval

float MoreMountains.Feedbacks.MMF_Feedback._beatInterval

protected

_infinitePlayCoroutine

Coroutine MoreMountains.Feedbacks.MMF_Feedback._infinitePlayCoroutine

protected

_initialized

bool MoreMountains.Feedbacks.MMF_Feedback._initialized = false

protected

_lastPlayTimestamp

float MoreMountains.Feedbacks.MMF_Feedback._lastPlayTimestamp = -1f

protected

_playCoroutine

Coroutine MoreMountains.Feedbacks.MMF_Feedback._playCoroutine

protected

_playsLeft

int MoreMountains.Feedbacks.MMF_Feedback._playsLeft

protected

_repeatedPlayCoroutine

Coroutine MoreMountains.Feedbacks.MMF_Feedback._repeatedPlayCoroutine

protected

_requiredTarget

string MoreMountains.Feedbacks.MMF_Feedback._requiredTarget = ""

protected

_requiresSetup

bool MoreMountains.Feedbacks.MMF_Feedback._requiresSetup = false

protected

_sequenceCoroutine

Coroutine MoreMountains.Feedbacks.MMF_Feedback._sequenceCoroutine

protected

_sequenceTrackID

int MoreMountains.Feedbacks.MMF_Feedback._sequenceTrackID = 0

protected

Active

bool MoreMountains.Feedbacks.MMF_Feedback.Active = true

whether or not this feedback is active

BeatThisFrame

bool MoreMountains.Feedbacks.MMF_Feedback.BeatThisFrame = false

protected

Chance

float MoreMountains.Feedbacks.MMF_Feedback.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)

Channel

int MoreMountains.Feedbacks.MMF_Feedback.Channel = 0

the ID of the channel on which this feedback will communicate

CurrentSequenceIndex

int MoreMountains.Feedbacks.MMF_Feedback.CurrentSequenceIndex = 0

protected

DebugActive

bool MoreMountains.Feedbacks.MMF_Feedback.DebugActive = false

whether or not this feedback is in debug mode

DisplayColor

Color MoreMountains.Feedbacks.MMF_Feedback.DisplayColor = Color.black

use this color to customize the background color of the feedback in the MMF_Player's list

Label

string MoreMountains.Feedbacks.MMF_Feedback.Label = "MMFeedback"

the name of this feedback to display in the inspector

LastBeatIndex

int MoreMountains.Feedbacks.MMF_Feedback.LastBeatIndex = 0

protected

LastBeatTimestamp

float MoreMountains.Feedbacks.MMF_Feedback.LastBeatTimestamp = 0f

protected

Owner

MMF_Player MoreMountains.Feedbacks.MMF_Feedback.Owner

the Owner of the feedback, as defined when calling the Initialization method

Timing

MMFeedbackTiming MoreMountains.Feedbacks.MMF_Feedback.Timing

a number of timing-related values (delay, repeat, etc)

UniqueID

int MoreMountains.Feedbacks.MMF_Feedback.UniqueID

Property Documentation

DrawGroupInspectors

virtual bool MoreMountains.Feedbacks.MMF_Feedback.DrawGroupInspectors

get

FeedbackDeltaTime

virtual float MoreMountains.Feedbacks.MMF_Feedback.FeedbackDeltaTime

get

the delta time (or unscaled delta time) based on the selected Timing settings

FeedbackDuration

virtual float MoreMountains.Feedbacks.MMF_Feedback.FeedbackDuration

getset

FeedbackPlaying

virtual bool MoreMountains.Feedbacks.MMF_Feedback.FeedbackPlaying

get

whether or not this feedback is playing right now

FeedbackStartedAt

virtual float? MoreMountains.Feedbacks.MMF_Feedback.FeedbackStartedAt

get

FeedbackTime

virtual float MoreMountains.Feedbacks.MMF_Feedback.FeedbackTime

get

the time (or unscaled time) based on the selected Timing settings

FinalNormalizedTime

virtual float? MoreMountains.Feedbacks.MMF_Feedback.FinalNormalizedTime

getprotected

Returns the t value at which to evaluate a curve at the end of this feedback's play time

HasChannel

virtual bool MoreMountains.Feedbacks.MMF_Feedback.HasChannel

get

if this is true, the Channel property will be displayed, otherwise it'll be hidden

HasCustomInspectors

virtual bool MoreMountains.Feedbacks.MMF_Feedback.HasCustomInspectors

get

HoldingPause

virtual bool MoreMountains.Feedbacks.MMF_Feedback.HoldingPause

get

if this is true, this feedback will wait until all previous feedbacks have run

InCooldown

virtual bool MoreMountains.Feedbacks.MMF_Feedback.InCooldown

get

returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise

an overridable color for your feedback, that can be redefined per feedback. White is the only reserved color, and the feedback will revert to normal (light or dark skin) when left to White

IsPlaying

virtual bool MoreMountains.Feedbacks.MMF_Feedback.IsPlaying

getset

if this is true, this feedback is currently playing

LooperPause

virtual bool MoreMountains.Feedbacks.MMF_Feedback.LooperPause

get

if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again

LooperStart

virtual bool MoreMountains.Feedbacks.MMF_Feedback.LooperStart

get

if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again

NormalPlayDirection

virtual bool MoreMountains.Feedbacks.MMF_Feedback.NormalPlayDirection

get

Returns true if this feedback should play normally, or false if it should play in rewind

Pause

virtual IEnumerator MoreMountains.Feedbacks.MMF_Feedback.Pause

get

set this to true if your feedback should pause the execution of the feedback sequence

RequiredTarget

string MoreMountains.Feedbacks.MMF_Feedback.RequiredTarget

get

RequiredTargetText

virtual string MoreMountains.Feedbacks.MMF_Feedback.RequiredTargetText

get

RequiresSetup

bool MoreMountains.Feedbacks.MMF_Feedback.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.

RequiresSetupText

virtual string MoreMountains.Feedbacks.MMF_Feedback.RequiresSetupText

get

ScriptDrivenPause

virtual bool MoreMountains.Feedbacks.MMF_Feedback.ScriptDrivenPause

getset

if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution

ScriptDrivenPauseAutoResume

virtual float MoreMountains.Feedbacks.MMF_Feedback.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

ShouldPlayInThisSequenceDirection

virtual bool MoreMountains.Feedbacks.MMF_Feedback.ShouldPlayInThisSequenceDirection

get

Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting

TotalDuration

virtual float MoreMountains.Feedbacks.MMF_Feedback.TotalDuration

get

The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats)

---

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

• Assets/InfiniteRunnerEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Core/MMF_Player/MMF_Feedback.cs