Class PlaySoundEffector

Inheritance

object

AFunction

AEffector

AUnityEffector

PlaySoundEffector

Inherited Members

AUnityEffector.Reset()

AUnityEffector.Init()

AUnityEffector.SafeReset()

AUnityEffector.EffectorUpdate()

AUnityEffector.FillParameters()

AUnityEffector.UnityThreadFillParameters()

AEffector.externalContext

AEffector.scenarioContext

AEffector.sequenceContext

AEffector.eventContext

AEffector.SetContexts(IContext, IContext)

AEffector.Event

AFunction.Parameters

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Xareus.Scenarios.Unity

Assembly: Xareus.Unity.Librairies.dll

Syntax

[Renamed("SEVEN.Unity.PlaySoundEffector", "Assembly-CSharp")]
public class PlaySoundEffector : AUnityEffector

Constructors

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

Constructor

Declaration

public PlaySoundEffector(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

Declaration

[ConfigurationParameter("Audio Clip", Necessity.Required)]
protected AudioClip audioClip

Field Value

Type	Description
AudioClip

audioSource

Declaration

[ConfigurationParameter("Audio Source", Necessity.Required)]
protected AudioSource audioSource

Field Value

Type	Description
AudioSource

finished

Declaration

protected bool finished

Field Value

Type	Description
bool

loop

Declaration

[ConfigurationParameter("Loop", Necessity.Required)]
protected bool loop

Field Value

Type	Description
bool

volume

Declaration

[ConfigurationParameter("Volume", Necessity.Optional)]
protected float volume

Field Value

Type	Description
float

waitForEnd

Declaration

[ConfigurationParameter("Wait For End", "Wait for the clip to finish once 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

AEffector.Finished

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

AUnityEffector.SafeEffectorUpdate()