Class StopAudioSourceEffector

Inheritance
object
AFunction
AEffector
AUnityEffector
StopAudioSourceEffector
Inherited Members
Namespace: Xareus.Scenarios.Unity
Assembly: Xareus.Unity.Libraries.dll
Syntax
[Renamed("FIVE.Utils.Effectors.StopAudioSourceEffector", "Assembly-CSharp")]
[Renamed("SEVEN.Unity.StopAudioSourceEffector", "Assembly-CSharp")]
[Renamed("Xareus.Scenarios.Unity.StopAudioSourceEffector", "Xareus.Unity.Librairies")]
public class StopAudioSourceEffector : AUnityEffector

Constructors

StopAudioSourceEffector(Event, Dictionary<string, Parameter>, IContext, IContext, IContext, IContext)

Constructor

Declaration
public StopAudioSourceEffector(Event @event, Dictionary<string, Parameter> parameters, IContext externalContext, IContext scenarioContext, IContext sequenceContext, IContext eventContext)
Parameters
Type Name Description
Event event
Dictionary<string, Parameter> parameters
IContext externalContext
IContext scenarioContext
IContext sequenceContext
IContext eventContext

Fields

audioClip

Which audio clip is being played ?

Declaration
protected AudioClip audioClip
Field Value
Type Description
AudioClip

audioSource

Declaration
[ConfigurationParameter("Audio Source", Necessity.Required)]
protected AudioSource audioSource
Field Value
Type Description
AudioSource

finishClip

Declaration
[ConfigurationParameter("Finish Current Clip", "Finish the current clip, meaning disabling the loop if it's on.\nNote this does not prevent from enabling back the loop later and canceling the stop", Necessity.Required)]
protected bool finishClip
Field Value
Type Description
bool

finished

Declaration
protected bool finished
Field Value
Type Description
bool

waitForEnd

Declaration
[ConfigurationParameter("Wait For End", "Wait for the current clip to be stopped (instantly or at the end of a loop depending on other parameters) before passing the transition", Necessity.Required)]
protected bool waitForEnd
Field Value
Type Description
bool

Properties

Finished

Override to have a non-ponctual effector

Declaration
public override bool Finished { get; }
Property Value
Type Description
bool
Overrides

Methods

CheckAudioState()

Check every frame if the audiosource is still playing or if the audio clip has changed

Declaration
protected virtual IEnumerator CheckAudioState()
Returns
Type Description
IEnumerator

SafeEffectorUpdate()

Actual effector code. Note that this code will be executed in unity's thread

Declaration
public override void SafeEffectorUpdate()
Overrides