TopDown Engine  v3.6
MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker Class Reference

Add this component to your Cinemachine Virtual Camera to have it shake when calling its ShakeCamera methods. More...

Inheritance diagram for MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker:

Public Attributes

MMChannelModes ChannelMode = MMChannelModes.Int
 
int Channel = 0
 the channel to listen to - has to match the one on the feedback More...
 
MMChannel MMChannelDefinition = null
 
float DefaultShakeAmplitude = .5f
 The default amplitude that will be applied to your shakes if you don't specify one. More...
 
float DefaultShakeFrequency = 10f
 The default frequency that will be applied to your shakes if you don't specify one. More...
 
float IdleAmplitude
 the amplitude of the camera's noise when it's idle More...
 
float IdleFrequency = 1f
 the frequency of the camera's noise when it's idle More...
 
float LerpSpeed = 5f
 the speed at which to interpolate the shake More...
 
float TestDuration = 0.3f
 a duration (in seconds) to apply when testing this shake via the TestShake button More...
 
float TestAmplitude = 2f
 the amplitude to apply when testing this shake via the TestShake button More...
 
float TestFrequency = 20f
 the frequency to apply when testing this shake via the TestShake button More...
 
bool TestShakeButton
 

Detailed Description

Add this component to your Cinemachine Virtual Camera to have it shake when calling its ShakeCamera methods.

Member Data Documentation

◆ Channel

int MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.Channel = 0

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

◆ ChannelMode

MMChannelModes MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.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

◆ DefaultShakeAmplitude

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.DefaultShakeAmplitude = .5f

The default amplitude that will be applied to your shakes if you don't specify one.

◆ DefaultShakeFrequency

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.DefaultShakeFrequency = 10f

The default frequency that will be applied to your shakes if you don't specify one.

◆ IdleAmplitude

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.IdleAmplitude

the amplitude of the camera's noise when it's idle

◆ IdleFrequency

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.IdleFrequency = 1f

the frequency of the camera's noise when it's idle

◆ LerpSpeed

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.LerpSpeed = 5f

the speed at which to interpolate the shake

◆ MMChannelDefinition

MMChannel MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.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

◆ TestAmplitude

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.TestAmplitude = 2f

the amplitude to apply when testing this shake via the TestShake button

◆ TestDuration

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.TestDuration = 0.3f

a duration (in seconds) to apply when testing this shake via the TestShake button

◆ TestFrequency

float MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.TestFrequency = 20f

the frequency to apply when testing this shake via the TestShake button

◆ TestShakeButton

bool MoreMountains.FeedbacksForThirdParty.MMCinemachineCameraShaker.TestShakeButton

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