|
| override void | InitializeCustomAttributes () |
| | Initializes the debug buttons.
|
| virtual void | RandomizeTimes () |
| | Randomizes playback time and playback duration.
|
| override void | OnDrawGizmosSelectedHandler () |
| | Triggered when the host MMF Player gets selected, can be used to draw gizmos.
|
| override void | AutomaticShakerSetup () |
| | Automatically tries to add a MMSoundManager to the scene if none are present.
|
| virtual async void | TestPlaySound () |
| | A test method that creates an audiosource, plays it, and destroys itself after play.
|
| virtual void | ResetSequentialIndex () |
| | Forces a reset of the sequential index to 0.
|
| virtual void | SetSequentialIndex (int newIndex) |
| | Forces a reset of the sequential index to the value specified in parameters.
|
| override void | OnValidate () |
| | On validate we randomize our times.
|
| virtual string | GetLabel () |
| | you can override this when creating a custom feedback to have it behave differently and display a different label
|
| virtual float | ComputeIntensity (float intensity, Vector3 position) |
| | Computes the new intensity, taking into account constant intensity and potential randomness.
|
| virtual void | CacheRequiresSetup () |
| virtual bool | EvaluateRequiresSetup () |
| | Override this method to determine if a feedback requires setup.
|
| virtual void | SetFeedbackDuration (float newDuration) |
| | Use this method to change the duration of this feedback.
|
| virtual void | PreInitialization (MMF_Player owner, int index) |
| | Runs at Awake, lets you preinitialize your custom feedback before Initialization.
|
| virtual void | Initialization (MMF_Player owner, int index) |
| | Typically runs on Start, Initializes the feedback and its timing related variables.
|
| virtual void | SetIndexInFeedbacksList (int index) |
| | Lets you specify at what index this feedback is in the list - use carefully (or don't use at all)
|
| virtual void | ForceAutomateTargetAcquisition () |
| | Lets you force target acquisition, outside of initialization where it usually occurs.
|
| virtual void | Play (Vector3 position, float feedbacksIntensity=1.0f) |
| | Plays the feedback.
|
| virtual void | SetSequence (MMSequence newSequence) |
| | Use this method to change this feedback's sequence at runtime.
|
| virtual void | Stop (Vector3 position, float feedbacksIntensity=1.0f) |
| | Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations.
|
| virtual void | SkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f) |
| | Called when skipping to the end of MMF_Player, calls custom Skip on all feedbacks.
|
| virtual void | ForceInitialValue (Vector3 position, float feedbacksIntensity=1.0f) |
| | Forces the feedback to set its initial value (behavior will change from feedback to feedback, but for example, a Position feedback that moves a Transform from point A to B would automatically move the Transform to point A when ForceInitialState is called.
|
| virtual void | RestoreInitialValues () |
| | Called when restoring the initial state of a player, calls custom Restore on all feedbacks.
|
| virtual void | ResetFeedback () |
| | Calls this feedback's custom reset.
|
| virtual void | ResetCooldown () |
| | Resets the cooldown for this feedback, allowing it to be played again instantly.
|
| virtual void | PlayerComplete () |
| | This gets called by the MMF Player when all feedbacks have completed playing.
|
| virtual void | SetDelayBetweenRepeats (float delay) |
| | Use this method to specify a new delay between repeats at runtime.
|
| virtual void | SetInitialDelay (float delay) |
| | Use this method to specify a new initial delay at runtime.
|
| virtual void | ComputeNewRandomDurationMultiplier () |
| | Computes a new random duration multiplier.
|
| virtual void | ResetPlayCount () |
| | Resets the play count of this feedback.
|
| virtual void | ComputeTotalDuration () |
| | Computes the total duration of this feedback.
|
| virtual void | OnAddFeedback () |
| | Triggered when the feedback gets added to the player.
|
| virtual void | OnDestroy () |
| | Triggered when that feedback gets destroyed.
|
| virtual void | OnDisable () |
| | Triggered when the host MMF Player gets disabled.
|
|
| Sources | Source = Sources.AudioClip |
| | whether this feedback should play an audio clip or an AudioResource
|
| AudioClip | Sfx |
| | the sound clip to play
|
| AudioResource | AudioResourceToPlay |
| | alternatively, instead of an audio clip you can specify an AudioResource, in which case the Sfx above will be ignored, and the AudioResource will be used
|
| AudioClip[] | RandomSfx |
| | an array to pick a random sfx from
|
| bool | SequentialOrder = false |
| | if this is true, random sfx audio clips will be played in sequential order instead of at random
|
| bool | SequentialOrderHoldLast = false |
| | if we're in sequential order, determines whether or not to hold at the last index, until either a cooldown is met, or the ResetSequentialIndex method is called
|
| float | SequentialOrderHoldCooldownDuration = 2f |
| | if we're in sequential order hold last mode, index will reset to 0 automatically after this duration, unless it's 0, in which case it'll be ignored
|
| bool | RandomUnique = false |
| | if this is true, sfx will be picked at random until all have been played. once this happens, the list is shuffled again, and it starts over
|
| MMF_MMSoundManagerSoundData | SoundDataSO |
| | a scriptable object (created via the Create/MoreMountains/Audio/MMF_SoundData menu) to define settings that will override all other settings on this feedback
|
| float | MinVolume = 1f |
| | the minimum volume to play the sound at
|
| float | MaxVolume = 1f |
| | the maximum volume to play the sound at
|
| float | MinPitch = 1f |
| | the minimum pitch to play the sound at
|
| float | MaxPitch = 1f |
| | the maximum pitch to play the sound at
|
| MMSoundManager.MMSoundManagerTracks | MmSoundManagerTrack = MMSoundManager.MMSoundManagerTracks.Sfx |
| | the track on which to play the sound. Pick the one that matches the nature of your sound
|
| int | ID = 0 |
| | the ID of the sound. This is useful if you plan on using sound control feedbacks on it afterwards.
|
| AudioMixerGroup | AudioGroup = null |
| | the AudioGroup on which to play the sound. If you're already targeting a preset track, you can leave it blank, otherwise the group you specify here will override it.
|
| AudioSource | RecycleAudioSource = null |
| | if (for some reason) you've already got an audiosource and wouldn't like to use the built-in pool system, you can specify it here
|
| bool | Loop = false |
| | whether or not this sound should loop
|
| bool | Persistent = false |
| | whether or not this sound should continue playing when transitioning to another scene
|
| bool | DoNotPlayIfClipAlreadyPlaying = false |
| | whether or not this sound should play if the same sound clip is already playing
|
| int | MaximumConcurrentInstances = 3 |
| | the maximum amount of instances of this sound allowed to play at once. use -1 for unlimited concurrent plays
|
| bool | StopSoundOnFeedbackStop = false |
| | if this is true, this sound will stop playing when stopping the feedback
|
| bool | FadeIn = false |
| | whether or not to fade this sound in when playing it
|
| float | FadeInInitialVolume = 0f |
| | if fading, the volume at which to start the fade
|
| float | FadeInDuration = 1f |
| | if fading, the duration of the fade, in seconds
|
| MMTweenType | FadeInTween = new MMTweenType(MMTween.MMTweenCurve.EaseInOutQuartic, "FadeIn") |
| | if fading, the tween over which to fade the sound
|
| bool | FadeOutOnStop = false |
| | whether or not to fade this sound in when stopping the feedback
|
| float | FadeOutDuration = 1f |
| | if fading out, the duration of the fade, in seconds
|
| MMTweenType | FadeOutTween = new MMTweenType(MMTween.MMTweenCurve.EaseInOutQuartic, "FadeOutOnStop") |
| | if fading out, the tween over which to fade the sound
|
| bool | SoloSingleTrack = false |
| | whether or not this sound should play in solo mode over its destination track. If yes, all other sounds on that track will be muted when this sound starts playing
|
| bool | SoloAllTracks = false |
| | whether or not this sound should play in solo mode over all other tracks. If yes, all other tracks will be muted when this sound starts playing
|
| bool | AutoUnSoloOnEnd = false |
| | if in any of the above solo modes, AutoUnSoloOnEnd will unmute the track(s) automatically once that sound stops playing
|
| float | PanStereo |
| | Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo.
|
| float | SpatialBlend |
| | Sets how much this AudioSource is affected by 3D spatialisation calculations (attenuation, doppler etc). 0.0 makes the sound full 2D, 1.0 makes it full 3D.
|
| Transform | AttachToTransform |
| | a Transform this sound can 'attach' to and follow it along as it plays
|
| bool | BypassEffects = false |
| | Bypass effects (Applied from filter components or global listener filters).
|
| bool | BypassListenerEffects = false |
| | When set global effects on the AudioListener will not be applied to the audio signal generated by the AudioSource. Does not apply if the AudioSource is playing into a mixer group.
|
| bool | BypassReverbZones = false |
| | When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones.
|
| int | Priority = 128 |
| | Sets the priority of the AudioSource.
|
| float | ReverbZoneMix = 1f |
| | The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones.
|
| Vector2 | PlaybackTime = new Vector2(0f, 0f) |
| | a timestamp (in seconds, randomized between the defined min and max) at which the sound will start playing, equivalent to the Audiosource API's Time)
|
| Vector2 | PlaybackDuration = new Vector2(0f, 0f) |
| | a duration (in seconds, randomized between the defined min and max) for which the sound will play before stopping. Ignored if min and max are zero.
|
| float | DopplerLevel = 1f |
| | Sets the Doppler scale for this AudioSource.
|
| int | Spread = 0 |
| | Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space.
|
| AudioRolloffMode | RolloffMode = AudioRolloffMode.Logarithmic |
| | Sets/Gets how the AudioSource attenuates over distance.
|
| float | MinDistance = 1f |
| | Within the Min distance the AudioSource will cease to grow louder in volume.
|
| float | MaxDistance = 500f |
| | (Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at.
|
| bool | UseCustomRolloffCurve = false |
| | whether or not to use a custom curve for custom volume rolloff
|
| AnimationCurve | CustomRolloffCurve |
| | the curve to use for custom volume rolloff if UseCustomRolloffCurve is true
|
| bool | UseSpatialBlendCurve = false |
| | whether or not to use a custom curve for spatial blend
|
| AnimationCurve | SpatialBlendCurve |
| | the curve to use for custom spatial blend if UseSpatialBlendCurve is true
|
| bool | UseReverbZoneMixCurve = false |
| | whether or not to use a custom curve for reverb zone mix
|
| AnimationCurve | ReverbZoneMixCurve |
| | the curve to use for custom reverb zone mix if UseReverbZoneMixCurve is true
|
| bool | UseSpreadCurve = false |
| | whether or not to use a custom curve for spread
|
| AnimationCurve | SpreadCurve |
| | the curve to use for custom spread if UseSpreadCurve is true
|
| bool | DrawGizmos = false |
| | whether or not to draw sound falloff gizmos when this MMF Player is selected
|
| Transform | GizmosCenter |
| | an object to use as the center of the gizmos. If left empty, this MMF Player's position will be used.
|
| Color | MinDistanceColor = MMColors.CadetBlue |
| | the color to use to draw the min distance sphere of the sound falloff gizmos
|
| Color | MaxDistanceColor = MMColors.Orangered |
| | the color to use to draw the max distance sphere of the sound falloff gizmos
|
| MMF_Button | TestPlayButton |
| | a test button used to play the sound in inspector
|
| MMF_Button | TestStopButton |
| | a test button used to stop the sound in inspector
|
| MMF_Button | ResetSequentialIndexButton |
| | a test button used to stop the sound in inspector
|
| bool | Active = true |
| | whether or not this feedback is active
|
| int | UniqueID |
| string | Label = "MMFeedback" |
| | the name of this feedback to display in the inspector
|
| string | OriginalLabel = "" |
| | the original label of this feedback, used to display next to the custom label in case we set one
|
| MMChannelModes | ChannelMode = MMChannelModes.Int |
| int | Channel = 0 |
| | the ID of the channel on which this feedback will communicate
|
| MMChannel | MMChannelDefinition = null |
| 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)
|
| MMFeedbackTiming | Timing |
| | a number of timing-related values (delay, repeat, etc)
|
| MMFeedbackTargetAcquisition | AutomatedTargetAcquisition |
| | a set of settings letting you define automated target acquisition for this feedback, to (for example) automatically grab the target on this game object, or a parent, a child, or on a reference holder
|
| bool | RandomizeOutput = false |
| | if this is true, intensity will be multiplied by a random value on play, picked between RandomMultiplier.x and RandomMultiplier.y
|
| Vector2 | RandomMultiplier = new Vector2(0.8f, 1f) |
| | a random value (randomized between its x and y) by which to multiply the output of this feedback, if RandomizeOutput is true
|
| bool | RandomizeDuration = false |
| | if this is true, this feedback's duration will be multiplied by a random value on play, picked between RandomDurationMultiplier.x and RandomDurationMultiplier.y
|
| Vector2 | RandomDurationMultiplier = new Vector2(0.5f, 2f) |
| | a random value (randomized between its x and y) by which to multiply the duration of this feedback, if RandomizeDuration is true
|
| bool | UseRange = false |
| | if this is true, only shakers within the specified range will respond to this feedback
|
| float | RangeDistance = 5f |
| | when in UseRange mode, only shakers within that distance will respond to this feedback
|
| bool | UseRangeFalloff = false |
| | when in UseRange mode, whether or not to modify the shake intensity based on the RangeFallOff curve
|
| AnimationCurve | RangeFalloff = new AnimationCurve(new Keyframe(0f, 1f), new Keyframe(1f, 0f)) |
| | the animation curve to use to define falloff (on the x 0 represents the range center, 1 represents the max distance to it)
|
| Vector2 | RemapRangeFalloff = new Vector2(0f, 1f) |
| | the values to remap the falloff curve's y axis' 0 and 1
|
| MMF_Button | AutomaticShakerSetupButton |
| | a button used to attempt an auto shaker setup for this feedback, adding whatever shaker it requires to function to the scene
|
| MMF_Player | Owner |
| | the Owner of the feedback, as defined when calling the Initialization method
|
| bool | DebugActive = false |
| | whether or not this feedback is in debug mode
|
|
| override void | CustomInitialization (MMF_Player owner) |
| | This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method.
|
| override void | CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f) |
| | Plays either a random sound or the specified sfx.
|
| override void | CustomStopFeedback (Vector3 position, float feedbacksIntensity=1) |
| | On Stop, we stop our sound if needed.
|
| virtual IEnumerator | FadeOutCo () |
| virtual void | StopSound () |
| virtual void | HandleSO () |
| | If a scriptable object is specified, we grab its values.
|
| virtual void | PlaySound (AudioClip sfx, Vector3 position, float intensity, AudioResource audioResource=null) |
| | Triggers a play sound event.
|
| virtual IEnumerator | IsPlayingCoroutine () |
| | A coroutine used to determine if the sound is still playing or not.
|
| virtual float | GetDuration () |
| | Returns the duration of the sound, or of the longest of the random sounds.
|
| virtual float | ComputeDuration (AudioClip sfx, AudioClip[] randomSfx) |
| virtual void | TestStopSound () |
| | A test method that stops the test sound.
|
| virtual void | PlayAudioSource (AudioSource audioSource, AudioClip sfx, float volume, float pitch, float time, float playbackDuration, AudioResource audioResourceToPlay) |
| | Plays the audio source with the specified volume and pitch.
|
| virtual AudioClip | PickRandomClip () |
| | Determines the next index to play when dealing with random clips.
|
| virtual void | AutomateTargetAcquisitionInternal () |
| | Performs automated target acquisition, if needed.
|
| virtual void | AutomateTargetAcquisition () |
| | A method meant to be implemented per feedback letting you specify what happens (usually setting a target)
|
| virtual GameObject | FindAutomatedTargetGameObject () |
| virtual T | FindAutomatedTarget< T > () |
| virtual IEnumerator | PlayCoroutine (Vector3 position, float feedbacksIntensity=1.0f) |
| | An internal coroutine delaying the initial play of the feedback.
|
| virtual void | RegularPlay (Vector3 position, float feedbacksIntensity=1.0f) |
| | Triggers delaying coroutines if needed.
|
| virtual void | TriggerCustomPlay (Vector3 position, float intensity) |
| | Triggers a custom play.
|
| virtual IEnumerator | InfinitePlay (Vector3 position, float feedbacksIntensity=1.0f) |
| | Internal coroutine used for repeated play without end.
|
| virtual IEnumerator | RepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f) |
| | Internal coroutine used for repeated play.
|
| virtual IEnumerator | TriggerRepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f) |
| virtual IEnumerator | SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f) |
| | A coroutine used to play this feedback on a sequence.
|
| virtual IEnumerator | ForceInitialValueDelayedCo (Vector3 position, float feedbacksIntensity=1.0f) |
| | A coroutine used to delay the Stop when forcing initial values (used mostly with shaker based feedbacks)
|
| virtual float | ApplyTimeMultiplier (float duration) |
| | Applies the host MMFeedbacks' time multiplier to this feedback.
|
| virtual IEnumerator | WaitFor (float delay) |
| | Internal method used to wait for a duration, on scaled or unscaled time.
|
| virtual float | ApplyDirection (float normalizedTime) |
| | Returns a new value of the normalized time based on the current play direction of this feedback.
|
| void | CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f) |
| | This method describes what happens when the feedback gets played.
|
| virtual void | CustomSkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f) |
| | This method describes what happens when the feedback gets skipped to the end.
|
| virtual void | CustomRestoreInitialValues () |
| | This method describes what happens when the feedback gets restored.
|
| virtual void | CustomPlayerComplete () |
| | This method describes what happens when the player this feedback belongs to completes playing.
|
| virtual void | CustomReset () |
| | This method describes what happens when the feedback gets reset.
|
|
| override float | FeedbackDuration [get] |
| | sets the inspector color for this feedback
|
| override bool | HasRandomness [get] |
| virtual Color | DisplayColor [get] |
| | use this color to customize the background color of the feedback in the MMF_Player's list
|
| virtual IEnumerator | Pause [get] |
| | set this to true if your feedback should pause the execution of the feedback sequence
|
| virtual bool | HoldingPause [get] |
| | if this is true, this feedback will wait until all previous feedbacks have run
|
| virtual bool | LooperPause [get] |
| | if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again
|
| virtual bool | ScriptDrivenPause [get, set] |
| | if this is true, this feedback will pause and wait until ResumeFeedbacks() is called on its parent MMF_Player to resume execution
|
| 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
|
| virtual bool | LooperStart [get] |
| | if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again
|
| virtual bool | HasChannel [get] |
| | if this is true, the Channel property will be displayed, otherwise it'll be hidden
|
| virtual bool | HasAutomaticShakerSetup [get] |
| | if this is true, this feedback will display an automatic shaker setup button
|
| virtual bool | HasRandomness [get] |
| | if this is true, the Randomness group will be displayed, otherwise it'll be hidden
|
| virtual bool | CanForceInitialValue [get] |
| | if this is true, this feedback implements ForceInitialState, otherwise calling that method will have no effect
|
| virtual bool | ForceInitialValueDelayed [get] |
| | if this is true, force initial value will happen over two frames
|
| virtual bool | HasAutomatedTargetAcquisition [get] |
| | whether or not this feedback can automatically grab the target on this game object, or a parent, a child, or on a reference holder
|
| virtual MMF_ReferenceHolder | ForcedReferenceHolder [get, set] |
| | when in forced reference mode, this will contain the forced reference holder that will be used (usually set by itself)
|
| virtual bool | HasRange [get] |
| | if this is true, the Range group will be displayed, otherwise it'll be hidden
|
| virtual int | PlaysLeft [get] |
| | the total amount of plays this feedback has left
|
| virtual bool | HasCustomInspectors [get] |
| virtual bool | InCooldown [get] |
| | returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise
|
| virtual bool | IsPlaying [get, set] |
| | if this is true, this feedback is currently playing
|
| virtual float | ComputedRandomMultiplier [get] |
| | Returns the random multiplier to apply to this feedback's output.
|
| virtual TimescaleModes | ComputedTimescaleMode [get] |
| | Returns the timescale mode to use in logic, taking into account the one set at the feedback level and the player level.
|
| virtual bool | InScaledTimescaleMode [get] |
| | returns true if this feedback is in Scaled timescale mode, false otherwise
|
| virtual float | FeedbackTime [get] |
| | the time (or unscaled time) based on the selected Timing settings
|
| virtual float | FeedbackDeltaTime [get] |
| | the delta time (or unscaled delta time) based on the selected Timing settings
|
| virtual float | TotalDuration [get] |
| | The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats)
|
| virtual bool | IsExpanded [get, set] |
| virtual bool | RequiresSetup [get] |
| | A flag used to determine if a feedback has all it needs, or if it requires some extra setup. This flag will be used to display a warning icon in the inspector if the feedback is not ready to be played.
|
| virtual string | RequiredTarget [get] |
| virtual bool | DrawGroupInspectors [get] |
| | if this is true, group inspectors will be displayed within this feedback
|
| virtual bool | DisplayFullHeaderColor [get] |
| | if this is true, the feedback will be displayed in the MMF Player's list with a full color background, as opposed to just a small line on the left
|
| virtual string | RequiresSetupText [get] |
| | defines the setup text that will be displayed on the feedback, should setup be required
|
| virtual string | RequiredTargetText [get] |
| | the text used to describe the required target
|
| virtual string | RequiredTargetTextExtra [get] |
| | the text used to describe the required target, if more info is needed
|
| virtual string | RequiredChannelText [get] |
| virtual float | FeedbackStartedAt [get] |
| virtual float | FeedbackDuration [get, set] |
| virtual bool | FeedbackPlaying [get] |
| | whether or not this feedback is playing right now
|
| virtual MMChannelData | ChannelData [get] |
| | a ChannelData object, ready to pass to an event
|
| virtual bool | InInitialDelay [get, set] |
| virtual float | FinalNormalizedTime [get] |
| | Returns the t value at which to evaluate a curve at the end of this feedback's play time.
|
| virtual bool | NormalPlayDirection [get] |
| | Returns true if this feedback should play normally, or false if it should play in rewind.
|
| virtual bool | ShouldPlayInThisSequenceDirection [get] |
| | Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting.
|
1.14.0