Corgi Engine
v8.8
|
Public Types | |
enum | Modes { Modes.Play, Modes.Pause, Modes.UnPause, Modes.Stop } |
sets the inspector color for this feedback More... | |
Public Member Functions | |
override void | Stop (Vector3 position, float feedbacksIntensity=1.0f) |
Stops the audiosource from playing More... | |
Public Member Functions inherited from MoreMountains.Feedbacks.MMFeedback | |
virtual MMChannelData | ChannelData (int channel) |
virtual void | Initialization (GameObject owner) |
Initializes the feedback and its timing related variables More... | |
virtual void | Play (Vector3 position, float feedbacksIntensity=1.0f) |
Plays the feedback More... | |
virtual void | ResetFeedback () |
Calls this feedback's custom reset More... | |
virtual void | SetSequence (MMSequence newSequence) |
Use this method to change this feedback's sequence at runtime More... | |
virtual void | SetDelayBetweenRepeats (float delay) |
Use this method to specify a new delay between repeats at runtime More... | |
virtual void | SetInitialDelay (float delay) |
Use this method to specify a new initial delay at runtime More... | |
Public Attributes | |
AudioSource | TargetAudioSource |
the target audio source to play More... | |
Modes | Mode = Modes.Play |
whether we should play the audio source or stop it or pause it More... | |
AudioClip[] | RandomSfx |
an array to pick a random sfx from More... | |
float | MinVolume = 1f |
the minimum volume to play the sound at More... | |
float | MaxVolume = 1f |
the maximum volume to play the sound at More... | |
float | MinPitch = 1f |
the minimum pitch to play the sound at More... | |
float | MaxPitch = 1f |
the maximum pitch to play the sound at More... | |
AudioMixerGroup | SfxAudioMixerGroup |
the audiomixer to play the sound with (optional) More... | |
Public Attributes inherited from MoreMountains.Feedbacks.MMFeedback | |
bool | Active = true |
whether or not this feedback is active More... | |
string | Label = "MMFeedback" |
the name of this feedback to display in the inspector More... | |
float | Chance = 100f |
the chance of this feedback happening (in percent : 100 : happens all the time, 0 : never happens, 50 : happens once every two calls, etc) More... | |
MMFeedbackTiming | Timing |
a number of timing-related values (delay, repeat, etc) More... | |
bool | DebugActive = false |
whether or not this feedback is in debug mode More... | |
Static Public Attributes | |
static bool | FeedbackTypeAuthorized = true |
a static bool used to disable all feedbacks of this type at once More... | |
Protected Member Functions | |
override void | CustomInitialization (GameObject owner) |
Custom init to cache the audiosource if required More... | |
override void | CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f) |
Plays either a random sound or the specified sfx More... | |
virtual void | PlayAudioSource (AudioSource audioSource, float volume, float pitch) |
Plays the audiosource at the selected volume and pitch More... | |
Protected Member Functions inherited from MoreMountains.Feedbacks.MMFeedback | |
virtual void | OnEnable () |
virtual IEnumerator | PlayCoroutine (Vector3 position, float feedbacksIntensity=1.0f) |
An internal coroutine delaying the initial play of the feedback More... | |
virtual void | RegularPlay (Vector3 position, float feedbacksIntensity=1.0f) |
Triggers delaying coroutines if needed More... | |
virtual IEnumerator | InfinitePlay (Vector3 position, float feedbacksIntensity=1.0f) |
Internal coroutine used for repeated play without end More... | |
virtual IEnumerator | RepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f) |
Internal coroutine used for repeated play More... | |
virtual IEnumerator | SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f) |
A coroutine used to play this feedback on a sequence More... | |
virtual float | ApplyDirection (float normalizedTime) |
Returns a new value of the normalized time based on the current play direction of this feedback More... | |
virtual float | ApplyTimeMultiplier (float duration) |
Applies the host MMFeedbacks' time multiplier to this feedback More... | |
virtual void | CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f) |
This method describes what happens when the feedback gets stopped More... | |
virtual void | CustomReset () |
This method describes what happens when the feedback gets reset More... | |
Protected Attributes | |
AudioClip | _randomClip |
float | _duration |
Protected Attributes inherited from MoreMountains.Feedbacks.MMFeedback | |
float | _lastPlayTimestamp = -1f |
int | _playsLeft |
bool | _initialized = false |
Coroutine | _playCoroutine |
Coroutine | _infinitePlayCoroutine |
Coroutine | _sequenceCoroutine |
Coroutine | _repeatedPlayCoroutine |
int | _sequenceTrackID = 0 |
MMFeedbacks | _hostMMFeedbacks |
float | _beatInterval |
bool | BeatThisFrame = false |
int | LastBeatIndex = 0 |
int | CurrentSequenceIndex = 0 |
float | LastBeatTimestamp = 0f |
bool | _isHostMMFeedbacksNotNull |
MMChannelData | _channelData |
Properties | |
override float | FeedbackDuration [get, set] |
the duration of this feedback is the duration of the clip being played More... | |
Properties inherited from MoreMountains.Feedbacks.MMFeedback | |
GameObject | Owner [get, set] |
the Owner of the feedback, as defined when calling the Initialization method More... | |
virtual IEnumerator | Pause [get] |
set this to true if your feedback should pause the execution of the feedback sequence More... | |
virtual bool | HoldingPause [get] |
if this is true, this feedback will wait until all previous feedbacks have run More... | |
virtual bool | LooperPause [get] |
if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More... | |
virtual bool | ScriptDrivenPause [get, set] |
if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution More... | |
virtual float | ScriptDrivenPauseAutoResume [get, set] |
if this is a positive value, the feedback will auto resume after that duration if it hasn't been resumed via script already More... | |
virtual bool | LooperStart [get] |
if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More... | |
virtual bool | InCooldown [get] |
returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise More... | |
virtual bool | IsPlaying [get, set] |
if this is true, this feedback is currently playing More... | |
float | FeedbackTime [get] |
the time (or unscaled time) based on the selected Timing settings More... | |
float | FeedbackDeltaTime [get] |
the delta time (or unscaled delta time) based on the selected Timing settings More... | |
float | TotalDuration [get] |
The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats) More... | |
virtual float | FeedbackStartedAt [get] |
virtual float | FeedbackDuration [get, set] |
virtual bool | FeedbackPlaying [get] |
whether or not this feedback is playing right now More... | |
virtual bool | NormalPlayDirection [get] |
Returns true if this feedback should play normally, or false if it should play in rewind More... | |
virtual bool | ShouldPlayInThisSequenceDirection [get] |
Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting More... | |
virtual float? | FinalNormalizedTime [get] |
Returns the t value at which to evaluate a curve at the end of this feedback's play time More... | |
|
protectedvirtual |
Custom init to cache the audiosource if required
owner |
Reimplemented from MoreMountains.Feedbacks.MMFeedback.
|
protectedvirtual |
Plays either a random sound or the specified sfx
position | |
feedbacksIntensity |
Implements MoreMountains.Feedbacks.MMFeedback.
|
protectedvirtual |
Plays the audiosource at the selected volume and pitch
audioSource | |
volume | |
pitch |
|
virtual |
Stops the audiosource from playing
position | |
feedbacksIntensity |
Reimplemented from MoreMountains.Feedbacks.MMFeedback.
|
protected |
|
protected |
|
static |
a static bool used to disable all feedbacks of this type at once
float MoreMountains.Feedbacks.MMFeedbackAudioSource.MaxPitch = 1f |
the maximum pitch to play the sound at
float MoreMountains.Feedbacks.MMFeedbackAudioSource.MaxVolume = 1f |
the maximum volume to play the sound at
float MoreMountains.Feedbacks.MMFeedbackAudioSource.MinPitch = 1f |
the minimum pitch to play the sound at
float MoreMountains.Feedbacks.MMFeedbackAudioSource.MinVolume = 1f |
the minimum volume to play the sound at
Modes MoreMountains.Feedbacks.MMFeedbackAudioSource.Mode = Modes.Play |
whether we should play the audio source or stop it or pause it
AudioClip [] MoreMountains.Feedbacks.MMFeedbackAudioSource.RandomSfx |
an array to pick a random sfx from
AudioMixerGroup MoreMountains.Feedbacks.MMFeedbackAudioSource.SfxAudioMixerGroup |
the audiomixer to play the sound with (optional)
AudioSource MoreMountains.Feedbacks.MMFeedbackAudioSource.TargetAudioSource |
the target audio source to play
|
getset |
the duration of this feedback is the duration of the clip being played