![]() |
Feel 5.9.1
The best way to improve your game's feel and make it extra juicy
|
Public Member Functions | |
| virtual float | GetTime () |
| virtual float | GetDeltaTime () |
| virtual void | ForceInitialization () |
| Call this externally if you need to force a new initialization. | |
| virtual void | StartShaking () |
| Starts shaking the values. | |
| virtual void | Play () |
| Starts this shaker. | |
| virtual void | Stop () |
| Stops this shaker. | |
| virtual void | StartListening () |
| Starts listening for events. | |
| virtual void | StopListening () |
| Stops listening for events. | |
| virtual float | ComputeRangeIntensity (bool useRange, float rangeDistance, bool useRangeFalloff, AnimationCurve rangeFalloff, Vector2 remapRangeFalloff, Vector3 rangePosition) |
Public Attributes | |
| MMChannelModes | ChannelMode = MMChannelModes.Int |
| int | Channel = 0 |
| the channel to listen to - has to match the one on the feedback | |
| MMChannel | MMChannelDefinition = null |
| float | ShakeDuration = 0.2f |
| the duration of the shake, in seconds | |
| bool | PlayOnAwake = false |
| if this is true this shaker will play on awake | |
| bool | PermanentShake = false |
| if this is true, the shaker will shake permanently as long as its game object is active | |
| bool | Interruptible = true |
| if this is true, a new shake can happen while shaking | |
| bool | AlwaysResetTargetValuesAfterShake = false |
| if this is true, this shaker will always reset target values, regardless of how it was called | |
| bool | OnlyUseShakerValues = false |
| if this is true, this shaker will ignore any value passed in an event that triggered it, and will instead use the values set on its inspector | |
| float | CooldownBetweenShakes = 0f |
| a cooldown, in seconds, after a shake, during which no other shake can start | |
| bool | Shaking = false |
| whether or not this shaker is shaking right now | |
| bool | ForwardDirection = true |
| TimescaleModes | TimescaleMode = TimescaleModes.Scaled |
Protected Member Functions | |
| virtual void | Awake () |
| On Awake we grab our volume and profile. | |
| virtual void | Initialization () |
| Override this method to initialize your shaker. | |
| virtual void | SetShakeStartedTimestamp () |
| Logs the start timestamp for this shaker. | |
| virtual void | ShakeStarts () |
| Describes what happens when a shake starts. | |
| virtual void | GrabInitialValues () |
| A method designed to collect initial values. | |
| virtual void | Update () |
| On Update, we shake our values if needed, or reset if our shake has ended. | |
| virtual void | Shake () |
| Override this method to implement shake over time. | |
| virtual float | ShakeFloat (AnimationCurve curve, float remapMin, float remapMax, bool relativeIntensity, float initialValue) |
| A method used to "shake" a flot over time along a curve. | |
| virtual Color | ShakeGradient (Gradient gradient) |
| virtual void | ResetTargetValues () |
| Resets the values on the target. | |
| virtual void | ResetShakerValues () |
| Resets the values on the shaker. | |
| virtual void | ShakeComplete () |
| Describes what happens when the shake is complete. | |
| virtual void | OnEnable () |
| On enable we start shaking if needed. | |
| virtual void | OnDestroy () |
| On destroy we stop listening for events. | |
| virtual void | OnDisable () |
| On disable we complete our shake if it was in progress. | |
| virtual bool | CheckEventAllowed (MMChannelData channelData, bool useRange=false, float range=0f, Vector3 eventOriginPosition=default(Vector3)) |
| Returns true if this shaker should listen to events, false otherwise. | |
Protected Attributes | |
| float | _shakeStartedTimestamp = -Single.MaxValue |
| float | _shakeStartedTimestampUnscaled = -Single.MaxValue |
| float | _remappedTimeSinceStart |
| bool | _resetShakerValuesAfterShake |
| bool | _resetTargetValuesAfterShake |
| float | _journey |
Properties | |
| virtual MMChannelData | ChannelData [get] |
| virtual bool | ListeningToEvents [get] |
| virtual bool | InCooldown [get] |
| Returns true if this shaker is currently in cooldown, false otherwise. | |
|
protectedvirtual |
On Awake we grab our volume and profile.
|
protectedvirtual |
Returns true if this shaker should listen to events, false otherwise.
| channel |
|
virtual |
|
virtual |
Call this externally if you need to force a new initialization.
|
virtual |
|
virtual |
|
protectedvirtual |
A method designed to collect initial values.
Reimplemented in MoreMountains.Feedbacks.MMAudioFilterDistortionShaker, MoreMountains.Feedbacks.MMAudioFilterEchoShaker, MoreMountains.Feedbacks.MMAudioFilterHighPassShaker, MoreMountains.Feedbacks.MMAudioFilterLowPassShaker, MoreMountains.Feedbacks.MMAudioFilterReverbShaker, MoreMountains.Feedbacks.MMAudioSourcePitchShaker, MoreMountains.Feedbacks.MMAudioSourceStereoPanShaker, MoreMountains.Feedbacks.MMAudioSourceVolumeShaker, MoreMountains.Feedbacks.MMCameraClippingPlanesShaker, MoreMountains.Feedbacks.MMCameraFieldOfViewShaker, MoreMountains.Feedbacks.MMCameraOrthographicSizeShaker, MoreMountains.Feedbacks.MMLightShaker, MoreMountains.Feedbacks.MMSpriteRendererShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineClippingPlanesShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineFieldOfViewShaker, and MoreMountains.FeedbacksForThirdParty.MMCinemachineOrthographicSizeShaker.
|
protectedvirtual |
Override this method to initialize your shaker.
Reimplemented in MoreMountains.Feedbacks.MMAudioFilterDistortionShaker, MoreMountains.Feedbacks.MMAudioFilterEchoShaker, MoreMountains.Feedbacks.MMAudioFilterHighPassShaker, MoreMountains.Feedbacks.MMAudioFilterLowPassShaker, MoreMountains.Feedbacks.MMAudioFilterReverbShaker, MoreMountains.Feedbacks.MMAudioSourcePitchShaker, MoreMountains.Feedbacks.MMAudioSourceStereoPanShaker, MoreMountains.Feedbacks.MMAudioSourceVolumeShaker, MoreMountains.Feedbacks.MMCameraClippingPlanesShaker, MoreMountains.Feedbacks.MMCameraFieldOfViewShaker, MoreMountains.Feedbacks.MMCameraOrthographicSizeShaker, MoreMountains.Feedbacks.MMFeedbacksShaker, MoreMountains.Feedbacks.MMLightShaker, MoreMountains.Feedbacks.MMLookAtShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, MoreMountains.Feedbacks.MMScaleShaker, MoreMountains.Feedbacks.MMSpriteRendererShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineClippingPlanesShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineFieldOfViewShaker, and MoreMountains.FeedbacksForThirdParty.MMCinemachineOrthographicSizeShaker.
|
protectedvirtual |
On destroy we stop listening for events.
|
protectedvirtual |
On disable we complete our shake if it was in progress.
|
protectedvirtual |
On enable we start shaking if needed.
|
virtual |
Starts this shaker.
|
protectedvirtual |
Resets the values on the shaker.
Reimplemented in MoreMountains.Feedbacks.MMAudioFilterDistortionShaker, MoreMountains.Feedbacks.MMAudioFilterEchoShaker, MoreMountains.Feedbacks.MMAudioFilterHighPassShaker, MoreMountains.Feedbacks.MMAudioFilterLowPassShaker, MoreMountains.Feedbacks.MMAudioFilterReverbShaker, MoreMountains.Feedbacks.MMAudioSourcePitchShaker, MoreMountains.Feedbacks.MMAudioSourceStereoPanShaker, MoreMountains.Feedbacks.MMAudioSourceVolumeShaker, MoreMountains.Feedbacks.MMCameraClippingPlanesShaker, MoreMountains.Feedbacks.MMCameraFieldOfViewShaker, MoreMountains.Feedbacks.MMCameraOrthographicSizeShaker, MoreMountains.Feedbacks.MMLightShaker, MoreMountains.Feedbacks.MMLookAtShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, MoreMountains.Feedbacks.MMScaleShaker, MoreMountains.Feedbacks.MMSpriteRendererShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineClippingPlanesShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineFieldOfViewShaker, and MoreMountains.FeedbacksForThirdParty.MMCinemachineOrthographicSizeShaker.
|
protectedvirtual |
Resets the values on the target.
Reimplemented in MoreMountains.Feedbacks.MMAudioFilterDistortionShaker, MoreMountains.Feedbacks.MMAudioFilterEchoShaker, MoreMountains.Feedbacks.MMAudioFilterHighPassShaker, MoreMountains.Feedbacks.MMAudioFilterLowPassShaker, MoreMountains.Feedbacks.MMAudioFilterReverbShaker, MoreMountains.Feedbacks.MMAudioSourcePitchShaker, MoreMountains.Feedbacks.MMAudioSourceStereoPanShaker, MoreMountains.Feedbacks.MMAudioSourceVolumeShaker, MoreMountains.Feedbacks.MMCameraClippingPlanesShaker, MoreMountains.Feedbacks.MMCameraFieldOfViewShaker, MoreMountains.Feedbacks.MMCameraOrthographicSizeShaker, MoreMountains.Feedbacks.MMLightShaker, MoreMountains.Feedbacks.MMLookAtShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, MoreMountains.Feedbacks.MMScaleShaker, MoreMountains.Feedbacks.MMSpriteRendererShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineClippingPlanesShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineFieldOfViewShaker, and MoreMountains.FeedbacksForThirdParty.MMCinemachineOrthographicSizeShaker.
|
protectedvirtual |
Logs the start timestamp for this shaker.
|
protectedvirtual |
Override this method to implement shake over time.
Reimplemented in MoreMountains.Feedbacks.MMAudioFilterDistortionShaker, MoreMountains.Feedbacks.MMAudioFilterEchoShaker, MoreMountains.Feedbacks.MMAudioFilterHighPassShaker, MoreMountains.Feedbacks.MMAudioFilterLowPassShaker, MoreMountains.Feedbacks.MMAudioFilterReverbShaker, MoreMountains.Feedbacks.MMAudioSourcePitchShaker, MoreMountains.Feedbacks.MMAudioSourceStereoPanShaker, MoreMountains.Feedbacks.MMAudioSourceVolumeShaker, MoreMountains.Feedbacks.MMCameraClippingPlanesShaker, MoreMountains.Feedbacks.MMCameraFieldOfViewShaker, MoreMountains.Feedbacks.MMCameraOrthographicSizeShaker, MoreMountains.Feedbacks.MMLightShaker, MoreMountains.Feedbacks.MMLookAtShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, MoreMountains.Feedbacks.MMScaleShaker, MoreMountains.Feedbacks.MMSpriteRendererShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineClippingPlanesShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineFieldOfViewShaker, and MoreMountains.FeedbacksForThirdParty.MMCinemachineOrthographicSizeShaker.
|
protectedvirtual |
Describes what happens when the shake is complete.
Reimplemented in MoreMountains.Feedbacks.MMLookAtShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, and MoreMountains.Feedbacks.MMScaleShaker.
|
protectedvirtual |
A method used to "shake" a flot over time along a curve.
| curve | |
| remapMin | |
| remapMax | |
| relativeIntensity | |
| initialValue |
|
protectedvirtual |
|
protectedvirtual |
Describes what happens when a shake starts.
Reimplemented in MoreMountains.Feedbacks.MMFeedbacksShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, and MoreMountains.Feedbacks.MMScaleShaker.
|
virtual |
Starts listening for events.
Reimplemented in MoreMountains.Feedbacks.MMAudioFilterDistortionShaker, MoreMountains.Feedbacks.MMAudioFilterEchoShaker, MoreMountains.Feedbacks.MMAudioFilterHighPassShaker, MoreMountains.Feedbacks.MMAudioFilterLowPassShaker, MoreMountains.Feedbacks.MMAudioFilterReverbShaker, MoreMountains.Feedbacks.MMAudioSourcePitchShaker, MoreMountains.Feedbacks.MMAudioSourceStereoPanShaker, MoreMountains.Feedbacks.MMAudioSourceVolumeShaker, MoreMountains.Feedbacks.MMCameraClippingPlanesShaker, MoreMountains.Feedbacks.MMCameraFieldOfViewShaker, MoreMountains.Feedbacks.MMCameraOrthographicSizeShaker, MoreMountains.Feedbacks.MMFeedbacksShaker, MoreMountains.Feedbacks.MMLightShaker, MoreMountains.Feedbacks.MMLookAtShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, MoreMountains.Feedbacks.MMScaleShaker, MoreMountains.Feedbacks.MMSpriteRendererShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineClippingPlanesShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineFieldOfViewShaker, and MoreMountains.FeedbacksForThirdParty.MMCinemachineOrthographicSizeShaker.
|
virtual |
Starts shaking the values.
|
virtual |
Stops this shaker.
|
virtual |
Stops listening for events.
Reimplemented in MoreMountains.Feedbacks.MMAudioFilterDistortionShaker, MoreMountains.Feedbacks.MMAudioFilterEchoShaker, MoreMountains.Feedbacks.MMAudioFilterHighPassShaker, MoreMountains.Feedbacks.MMAudioFilterLowPassShaker, MoreMountains.Feedbacks.MMAudioFilterReverbShaker, MoreMountains.Feedbacks.MMAudioSourcePitchShaker, MoreMountains.Feedbacks.MMAudioSourceStereoPanShaker, MoreMountains.Feedbacks.MMAudioSourceVolumeShaker, MoreMountains.Feedbacks.MMCameraClippingPlanesShaker, MoreMountains.Feedbacks.MMCameraFieldOfViewShaker, MoreMountains.Feedbacks.MMCameraOrthographicSizeShaker, MoreMountains.Feedbacks.MMFeedbacksShaker, MoreMountains.Feedbacks.MMLightShaker, MoreMountains.Feedbacks.MMLookAtShaker, MoreMountains.Feedbacks.MMPositionShaker, MoreMountains.Feedbacks.MMRotationShaker, MoreMountains.Feedbacks.MMScaleShaker, MoreMountains.Feedbacks.MMSpriteRendererShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineClippingPlanesShaker, MoreMountains.FeedbacksForThirdParty.MMCinemachineFieldOfViewShaker, and MoreMountains.FeedbacksForThirdParty.MMCinemachineOrthographicSizeShaker.
|
protectedvirtual |
On Update, we shake our values if needed, or reset if our shake has ended.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
| bool MoreMountains.Feedbacks.MMShaker.AlwaysResetTargetValuesAfterShake = false |
if this is true, this shaker will always reset target values, regardless of how it was called
| int MoreMountains.Feedbacks.MMShaker.Channel = 0 |
the channel to listen to - has to match the one on the feedback
| MMChannelModes MoreMountains.Feedbacks.MMShaker.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
| float MoreMountains.Feedbacks.MMShaker.CooldownBetweenShakes = 0f |
a cooldown, in seconds, after a shake, during which no other shake can start
| bool MoreMountains.Feedbacks.MMShaker.ForwardDirection = true |
| bool MoreMountains.Feedbacks.MMShaker.Interruptible = true |
if this is true, a new shake can happen while shaking
| MMChannel MoreMountains.Feedbacks.MMShaker.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
| bool MoreMountains.Feedbacks.MMShaker.OnlyUseShakerValues = false |
if this is true, this shaker will ignore any value passed in an event that triggered it, and will instead use the values set on its inspector
| bool MoreMountains.Feedbacks.MMShaker.PermanentShake = false |
if this is true, the shaker will shake permanently as long as its game object is active
| bool MoreMountains.Feedbacks.MMShaker.PlayOnAwake = false |
if this is true this shaker will play on awake
| float MoreMountains.Feedbacks.MMShaker.ShakeDuration = 0.2f |
the duration of the shake, in seconds
| bool MoreMountains.Feedbacks.MMShaker.Shaking = false |
whether or not this shaker is shaking right now
| TimescaleModes MoreMountains.Feedbacks.MMShaker.TimescaleMode = TimescaleModes.Scaled |
|
get |
|
get |
Returns true if this shaker is currently in cooldown, false otherwise.
|
get |