Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Tools.MMRadioSignalAudioAnalyzer Class Reference

A class used to expose a beat level from a target MMAudioAnalyzer, to be broadcasted by a MMAudioBroadcaster More...

Inheritance diagram for MoreMountains.Tools.MMRadioSignalAudioAnalyzer:
MoreMountains.Tools.MMRadioSignal

Public Attributes

MMAudioAnalyzer TargetAnalyzer
 the MMAudioAnalyzer to read the value on More...
 
int BeatID
 the ID of the beat to listen to More...
 
- Public Attributes inherited from MoreMountains.Tools.MMRadioSignal
SignalModes SignalMode = SignalModes.Persistent
 the selected signal mode More...
 
TimeScales TimeScale = TimeScales.Unscaled
 the selected time scale More...
 
float Duration = 2f
 the duration of the shake, in seconds More...
 
float GlobalMultiplier = 1f
 a global multiplier to apply to the end result of the combination More...
 
float CurrentLevel = 0f
 the current level, not to be read from a broadcaster (it's best to use the property than the field, fields generate garbage) More...
 
bool Playing = false
 whether or not this shaker is shaking right now More...
 
float DriverTime
 the driver time, that can be controlled from another class if you're in Driven mode More...
 
bool PlayOnStart = true
 if this is true this shaker will play on awake More...
 
MMRadioSignalOnValueChange OnValueChange
 an event to trigger on value change More...
 
bool StartShakingButton
 a test button to start shaking More...
 

Protected Member Functions

override void Shake ()
 On Shake, we output our beat value More...
 
- Protected Member Functions inherited from MoreMountains.Tools.MMRadioSignal
virtual void Awake ()
 On Awake we grab our volume and profile More...
 
virtual void Initialization ()
 Override this method to initialize your shaker More...
 
virtual void ShakeStarts ()
 Describes what happens when a shake starts More...
 
virtual void Update ()
 On Update, we shake our values if needed, or reset if our shake has ended More...
 
virtual void ProcessDrivenMode ()
 A method to override to describe the behaviour in Driven mode More...
 
virtual void ProcessUpdate ()
 A method to override to describe what should happen at update More...
 
virtual void ShakeComplete ()
 Describes what happens when the shake is complete More...
 
virtual void OnEnable ()
 On enable we start shaking if needed More...
 
virtual void OnDestroy ()
 On destroy we stop listening for events More...
 
virtual void OnDisable ()
 On disable we complete our shake if it was in progress More...
 

Additional Inherited Members

- Public Types inherited from MoreMountains.Tools.MMRadioSignal
enum  SignalModes { SignalModes.OneTime, SignalModes.Persistent, SignalModes.Driven }
 
enum  TimeScales { TimeScales.Unscaled, TimeScales.Scaled }
 whether this signal operates on scaled or unscaled time More...
 
- Public Member Functions inherited from MoreMountains.Tools.MMRadioSignal
virtual void StartShaking ()
 Starts shaking the values More...
 
virtual void ApplyLevel (float level)
 
virtual float GraphValue (float time)
 
virtual void Play ()
 Starts this shaker More...
 
virtual void Stop ()
 Starts this shaker More...
 
virtual float ApplyBias (float t, float bias)
 Applies a bias to a time value More...
 
- Protected Attributes inherited from MoreMountains.Tools.MMRadioSignal
float _signalTime = 0f
 
float _shakeStartedTimestamp
 
float _levelLastFrame
 
- Properties inherited from MoreMountains.Tools.MMRadioSignal
virtual float Level [get]
 the level, to read from a MMRadioBroadcaster More...
 
virtual float? TimescaleTime [get]
 the time, unscaled or scaled More...
 
virtual float? TimescaleDeltaTime [get]
 the delta time, unscaled or not More...
 

Detailed Description

A class used to expose a beat level from a target MMAudioAnalyzer, to be broadcasted by a MMAudioBroadcaster

Member Function Documentation

◆ Shake()

override void MoreMountains.Tools.MMRadioSignalAudioAnalyzer.Shake ( )
protectedvirtual

On Shake, we output our beat value

Reimplemented from MoreMountains.Tools.MMRadioSignal.

Member Data Documentation

◆ BeatID

int MoreMountains.Tools.MMRadioSignalAudioAnalyzer.BeatID

the ID of the beat to listen to

◆ TargetAnalyzer

MMAudioAnalyzer MoreMountains.Tools.MMRadioSignalAudioAnalyzer.TargetAnalyzer

the MMAudioAnalyzer to read the value on


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