TopDown Engine v4.5
Loading...
Searching...
No Matches
MoreMountains.Feedbacks.MMF_FloatController Class Reference

This feedback will trigger a one time play on a target FloatController. More...

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

Public Types

enum  Modes { OneTime , ToDestination }
 the different possible modes More...

Public Attributes

Modes Mode = Modes.OneTime
 the mode this controller is in
FloatController TargetFloatController
 the float controller to trigger a one time play on
List< FloatControllerExtraTargetFloatControllers
 a list of extra and optional float controllers to trigger a one time play on
bool RevertToInitialValueAfterEnd = false
 whether this should revert to original at the end
float OneTimeDuration = 1f
 the duration of the One Time shake
float OneTimeAmplitude = 1f
 the amplitude of the One Time shake (this will be multiplied by the curve's height)
float OneTimeRemapMin = 0f
 the low value to remap the normalized curve value to
float OneTimeRemapMax = 1f
 the high value to remap the normalized curve value to
AnimationCurve OneTimeCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve to apply to the one time shake
float ToDestinationValue = 1f
 the value to move this float controller to
float ToDestinationDuration = 1f
 the duration over which to move the value
AnimationCurve ToDestinationCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve over which to move the value in ToDestination mode

Static Public Attributes

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

Protected Member Functions

override void AutomateTargetAcquisition ()
 A method meant to be implemented per feedback letting you specify what happens (usually setting a target)
override void CustomInitialization (MMF_Player owner)
 On init we grab our initial values on the target float controller.
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On play we trigger a one time or ToDestination play on our target float controller.
virtual void HandleFloatController (FloatController target, float intensityMultiplier)
 Applies values to and triggers the target float controller.
override void CustomReset ()
 On reset we reset our values on the target controller with the ones stored initially.
virtual void ResetFloatController (FloatController controller)
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On stop, we interrupt movement if it was active.
override void CustomRestoreInitialValues ()
 On restore, we restore our initial state.

Protected Attributes

float _oneTimeDurationStorage
float _oneTimeAmplitudeStorage
float _oneTimeRemapMinStorage
float _oneTimeRemapMaxStorage
AnimationCurve _oneTimeCurveStorage
float _toDestinationValueStorage
float _toDestinationDurationStorage
AnimationCurve _toDestinationCurveStorage
bool _revertToInitialValueAfterEndStorage

Properties

override bool HasRandomness [get]
 sets the inspector color for this feedback
override bool CanForceInitialValue [get]
override bool ForceInitialValueDelayed [get]
override bool HasAutomatedTargetAcquisition [get]
override float FeedbackDuration [get, set]
 the duration of this feedback is the duration of the one time hit

Additional Inherited Members

Detailed Description

This feedback will trigger a one time play on a target FloatController.

Member Enumeration Documentation

◆ Modes

the different possible modes

Enumerator
OneTime 
ToDestination 

Member Function Documentation

◆ AutomateTargetAcquisition()

override void MoreMountains.Feedbacks.MMF_FloatController.AutomateTargetAcquisition ( )
protectedvirtual

A method meant to be implemented per feedback letting you specify what happens (usually setting a target)

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_FloatController.CustomInitialization ( MMF_Player owner)
protectedvirtual

On init we grab our initial values on the target float controller.

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_FloatController.CustomPlayFeedback ( Vector3 position,
float feedbacksIntensity = 1::0f )
protected

On play we trigger a one time or ToDestination play on our target float controller.

Parameters
position
feedbacksIntensity

◆ CustomReset()

override void MoreMountains.Feedbacks.MMF_FloatController.CustomReset ( )
protectedvirtual

On reset we reset our values on the target controller with the ones stored initially.

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

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

On restore, we restore our initial state.

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_FloatController.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.

◆ HandleFloatController()

virtual void MoreMountains.Feedbacks.MMF_FloatController.HandleFloatController ( FloatController target,
float intensityMultiplier )
protectedvirtual

Applies values to and triggers the target float controller.

Parameters
target
intensityMultiplier

◆ ResetFloatController()

virtual void MoreMountains.Feedbacks.MMF_FloatController.ResetFloatController ( FloatController controller)
protectedvirtual

Member Data Documentation

◆ _oneTimeAmplitudeStorage

float MoreMountains.Feedbacks.MMF_FloatController._oneTimeAmplitudeStorage
protected

◆ _oneTimeCurveStorage

AnimationCurve MoreMountains.Feedbacks.MMF_FloatController._oneTimeCurveStorage
protected

◆ _oneTimeDurationStorage

float MoreMountains.Feedbacks.MMF_FloatController._oneTimeDurationStorage
protected

◆ _oneTimeRemapMaxStorage

float MoreMountains.Feedbacks.MMF_FloatController._oneTimeRemapMaxStorage
protected

◆ _oneTimeRemapMinStorage

float MoreMountains.Feedbacks.MMF_FloatController._oneTimeRemapMinStorage
protected

◆ _revertToInitialValueAfterEndStorage

bool MoreMountains.Feedbacks.MMF_FloatController._revertToInitialValueAfterEndStorage
protected

◆ _toDestinationCurveStorage

AnimationCurve MoreMountains.Feedbacks.MMF_FloatController._toDestinationCurveStorage
protected

◆ _toDestinationDurationStorage

float MoreMountains.Feedbacks.MMF_FloatController._toDestinationDurationStorage
protected

◆ _toDestinationValueStorage

float MoreMountains.Feedbacks.MMF_FloatController._toDestinationValueStorage
protected

◆ ExtraTargetFloatControllers

List<FloatController> MoreMountains.Feedbacks.MMF_FloatController.ExtraTargetFloatControllers

a list of extra and optional float controllers to trigger a one time play on

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_FloatController.FeedbackTypeAuthorized = true
static

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

◆ Mode

Modes MoreMountains.Feedbacks.MMF_FloatController.Mode = Modes.OneTime

the mode this controller is in

◆ OneTimeAmplitude

float MoreMountains.Feedbacks.MMF_FloatController.OneTimeAmplitude = 1f

the amplitude of the One Time shake (this will be multiplied by the curve's height)

◆ OneTimeCurve

AnimationCurve MoreMountains.Feedbacks.MMF_FloatController.OneTimeCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve to apply to the one time shake

◆ OneTimeDuration

float MoreMountains.Feedbacks.MMF_FloatController.OneTimeDuration = 1f

the duration of the One Time shake

◆ OneTimeRemapMax

float MoreMountains.Feedbacks.MMF_FloatController.OneTimeRemapMax = 1f

the high value to remap the normalized curve value to

◆ OneTimeRemapMin

float MoreMountains.Feedbacks.MMF_FloatController.OneTimeRemapMin = 0f

the low value to remap the normalized curve value to

◆ RevertToInitialValueAfterEnd

bool MoreMountains.Feedbacks.MMF_FloatController.RevertToInitialValueAfterEnd = false

whether this should revert to original at the end

◆ TargetFloatController

FloatController MoreMountains.Feedbacks.MMF_FloatController.TargetFloatController

the float controller to trigger a one time play on

◆ ToDestinationCurve

AnimationCurve MoreMountains.Feedbacks.MMF_FloatController.ToDestinationCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve over which to move the value in ToDestination mode

◆ ToDestinationDuration

float MoreMountains.Feedbacks.MMF_FloatController.ToDestinationDuration = 1f

the duration over which to move the value

◆ ToDestinationValue

float MoreMountains.Feedbacks.MMF_FloatController.ToDestinationValue = 1f

the value to move this float controller to

Property Documentation

◆ CanForceInitialValue

override bool MoreMountains.Feedbacks.MMF_FloatController.CanForceInitialValue
get

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_FloatController.FeedbackDuration
getset

the duration of this feedback is the duration of the one time hit

◆ ForceInitialValueDelayed

override bool MoreMountains.Feedbacks.MMF_FloatController.ForceInitialValueDelayed
get

◆ HasAutomatedTargetAcquisition

override bool MoreMountains.Feedbacks.MMF_FloatController.HasAutomatedTargetAcquisition
get

◆ HasRandomness

override bool MoreMountains.Feedbacks.MMF_FloatController.HasRandomness
get

sets the inspector color for this feedback


The documentation for this class was generated from the following file:
  • H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacksForThirdParty/MMTools/Feedbacks/MMF_FloatController.cs