Feel 5.9.1
The best way to improve your game's feel and make it extra juicy
Loading...
Searching...
No Matches
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
int BeatID
 the ID of the beat to listen to
Public Attributes inherited from MoreMountains.Tools.MMRadioSignal
SignalModes SignalMode = SignalModes.Persistent
 the selected signal mode
TimeScales TimeScale = TimeScales.Unscaled
 the selected time scale
float Duration = 2f
 the duration of the shake, in seconds
float GlobalMultiplier = 1f
 a global multiplier to apply to the end result of the combination
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)
bool Playing = false
 whether or not this shaker is shaking right now
float DriverTime
 the driver time, that can be controlled from another class if you're in Driven mode
bool PlayOnStart = true
 if this is true this shaker will play on awake
MMRadioSignalOnValueChange OnValueChange
 an event to trigger on value change
bool StartShakingButton
 a test button to start shaking

Protected Member Functions

override void Shake ()
 On Shake, we output our beat value.
Protected Member Functions inherited from MoreMountains.Tools.MMRadioSignal
virtual void Awake ()
 On Awake we grab our volume and profile.
virtual void Initialization ()
 Override this method to initialize your shaker.
virtual void ShakeStarts ()
 Describes what happens when a shake starts.
virtual void Update ()
 On Update, we shake our values if needed, or reset if our shake has ended.
virtual void ProcessDrivenMode ()
 A method to override to describe the behaviour in Driven mode.
virtual void ProcessUpdate ()
 A method to override to describe what should happen at update.
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.

Additional Inherited Members

Public Types inherited from MoreMountains.Tools.MMRadioSignal
enum  SignalModes { OneTime , Persistent , Driven }
enum  TimeScales { Unscaled , 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.
virtual void ApplyLevel (float level)
virtual float GraphValue (float time)
virtual void Play ()
 Starts this shaker.
virtual void Stop ()
 Starts this shaker.
virtual float ApplyBias (float t, float bias)
 Applies a bias to a time value.
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
virtual float TimescaleTime [get]
 the time, unscaled or scaled
virtual float TimescaleDeltaTime [get]
 the delta time, unscaled or not

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: