410 lines
13 KiB
C#
410 lines
13 KiB
C#
|
using System;
|
|||
|
|
using System.Collections;
|
|||
|
|
using System.Collections.Generic;
|
|||
|
|
using UnityEngine;
|
|||
|
|
using UnityEngine.Serialization;
|
|||
|
|
|
|||
|
|
namespace FMODUnity
|
|||
|
|
{
|
|||
|
|
[AddComponentMenu("FMOD Studio/FMOD Studio Event Emitter")]
|
|||
|
|
public class StudioEventEmitter : EventHandler
|
|||
|
|
{
|
|||
|
|
public EventReference EventReference;
|
|||
|
|
|
|||
|
|
[Obsolete("Use the EventReference field instead.")]
|
|||
|
|
public string Event = "";
|
|||
|
|
|
|||
|
|
[FormerlySerializedAs("PlayEvent")]
|
|||
|
|
public EmitterGameEvent EventPlayTrigger = EmitterGameEvent.None;
|
|||
|
|
public EmitterGameEvent PlayEvent
|
|||
|
|
{
|
|||
|
|
get { return EventPlayTrigger; }
|
|||
|
|
set { EventPlayTrigger = value; }
|
|||
|
|
}
|
|||
|
|
[FormerlySerializedAs("StopEvent")]
|
|||
|
|
public EmitterGameEvent EventStopTrigger = EmitterGameEvent.None;
|
|||
|
|
public EmitterGameEvent StopEvent
|
|||
|
|
{
|
|||
|
|
get { return EventStopTrigger; }
|
|||
|
|
set { EventStopTrigger = value; }
|
|||
|
|
}
|
|||
|
|
public bool AllowFadeout = true;
|
|||
|
|
public bool TriggerOnce = false;
|
|||
|
|
public bool Preload = false;
|
|||
|
|
[FormerlySerializedAs("AllowNonRigidbodyDoppler")]
|
|||
|
|
public bool NonRigidbodyVelocity = false;
|
|||
|
|
public ParamRef[] Params = new ParamRef[0];
|
|||
|
|
public bool OverrideAttenuation = false;
|
|||
|
|
public float OverrideMinDistance = -1.0f;
|
|||
|
|
public float OverrideMaxDistance = -1.0f;
|
|||
|
|
|
|||
|
|
protected FMOD.Studio.EventDescription eventDescription;
|
|||
|
|
|
|||
|
|
protected FMOD.Studio.EventInstance instance;
|
|||
|
|
|
|||
|
|
private bool hasTriggered = false;
|
|||
|
|
private bool isQuitting = false;
|
|||
|
|
private bool isOneshot = false;
|
|||
|
|
private List<ParamRef> cachedParams = new List<ParamRef>();
|
|||
|
|
|
|||
|
|
private static List<StudioEventEmitter> activeEmitters = new List<StudioEventEmitter>();
|
|||
|
|
|
|||
|
|
private const string SnapshotString = "snapshot";
|
|||
|
|
|
|||
|
|
public FMOD.Studio.EventDescription EventDescription { get { return eventDescription; } }
|
|||
|
|
|
|||
|
|
public FMOD.Studio.EventInstance EventInstance { get { return instance; } }
|
|||
|
|
|
|||
|
|
public bool IsActive { get; private set; }
|
|||
|
|
|
|||
|
|
private float MaxDistance
|
|||
|
|
{
|
|||
|
|
get
|
|||
|
|
{
|
|||
|
|
if (OverrideAttenuation)
|
|||
|
|
{
|
|||
|
|
return OverrideMaxDistance;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (!eventDescription.isValid())
|
|||
|
|
{
|
|||
|
|
Lookup();
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
float minDistance, maxDistance;
|
|||
|
|
eventDescription.getMinMaxDistance(out minDistance, out maxDistance);
|
|||
|
|
return maxDistance;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public static void UpdateActiveEmitters()
|
|||
|
|
{
|
|||
|
|
foreach (StudioEventEmitter emitter in activeEmitters)
|
|||
|
|
{
|
|||
|
|
emitter.UpdatePlayingStatus();
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private static void RegisterActiveEmitter(StudioEventEmitter emitter)
|
|||
|
|
{
|
|||
|
|
if (!activeEmitters.Contains(emitter))
|
|||
|
|
{
|
|||
|
|
activeEmitters.Add(emitter);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private static void DeregisterActiveEmitter(StudioEventEmitter emitter)
|
|||
|
|
{
|
|||
|
|
activeEmitters.Remove(emitter);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private void UpdatePlayingStatus(bool force = false)
|
|||
|
|
{
|
|||
|
|
// If at least one listener is within the max distance, ensure an event instance is playing
|
|||
|
|
bool playInstance = StudioListener.DistanceSquaredToNearestListener(transform.position) <= (MaxDistance * MaxDistance);
|
|||
|
|
|
|||
|
|
if (force || playInstance != IsPlaying())
|
|||
|
|
{
|
|||
|
|
if (playInstance)
|
|||
|
|
{
|
|||
|
|
PlayInstance();
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
{
|
|||
|
|
StopInstance();
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
protected override void Start()
|
|||
|
|
{
|
|||
|
|
RuntimeUtils.EnforceLibraryOrder();
|
|||
|
|
if (Preload)
|
|||
|
|
{
|
|||
|
|
Lookup();
|
|||
|
|
eventDescription.loadSampleData();
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
HandleGameEvent(EmitterGameEvent.ObjectStart);
|
|||
|
|
|
|||
|
|
// If a Rigidbody or Rigidbody2D is present on this GameObject, turn off "NonRigidbodyVelocity"
|
|||
|
|
#if UNITY_PHYSICS_EXIST
|
|||
|
|
if (NonRigidbodyVelocity && GetComponent<Rigidbody>())
|
|||
|
|
{
|
|||
|
|
Debug.LogWarning(string.Format("[FMOD] Non-Rigidbody Velocity is enabled on Emitter attached to GameObject \"{0}\", which also has a Rigidbody component attached - this will be disabled in favor of velocity from Rigidbody component.", this.name));
|
|||
|
|
NonRigidbodyVelocity = false;
|
|||
|
|
}
|
|||
|
|
#endif
|
|||
|
|
#if UNITY_PHYSICS2D_EXIST
|
|||
|
|
if (NonRigidbodyVelocity && GetComponent<Rigidbody2D>())
|
|||
|
|
{
|
|||
|
|
Debug.LogWarning(string.Format("[FMOD] Non-Rigidbody Velocity is enabled on Emitter attached to GameObject \"{0}\", which also has a Rigidbody2D component attached - this will be disabled in favor of velocity from Rigidbody2D component.", this.name));
|
|||
|
|
NonRigidbodyVelocity = false;
|
|||
|
|
}
|
|||
|
|
#endif
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private void OnApplicationQuit()
|
|||
|
|
{
|
|||
|
|
isQuitting = true;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
protected override void OnDestroy()
|
|||
|
|
{
|
|||
|
|
if (!isQuitting)
|
|||
|
|
{
|
|||
|
|
HandleGameEvent(EmitterGameEvent.ObjectDestroy);
|
|||
|
|
|
|||
|
|
if (instance.isValid())
|
|||
|
|
{
|
|||
|
|
RuntimeManager.DetachInstanceFromGameObject(instance);
|
|||
|
|
if (eventDescription.isValid() && isOneshot)
|
|||
|
|
{
|
|||
|
|
instance.release();
|
|||
|
|
instance.clearHandle();
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
DeregisterActiveEmitter(this);
|
|||
|
|
|
|||
|
|
if (Preload)
|
|||
|
|
{
|
|||
|
|
eventDescription.unloadSampleData();
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
protected override void HandleGameEvent(EmitterGameEvent gameEvent)
|
|||
|
|
{
|
|||
|
|
if (EventPlayTrigger == gameEvent)
|
|||
|
|
{
|
|||
|
|
Play();
|
|||
|
|
}
|
|||
|
|
if (EventStopTrigger == gameEvent)
|
|||
|
|
{
|
|||
|
|
Stop();
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private void Lookup()
|
|||
|
|
{
|
|||
|
|
eventDescription = RuntimeManager.GetEventDescription(EventReference);
|
|||
|
|
|
|||
|
|
if (eventDescription.isValid())
|
|||
|
|
{
|
|||
|
|
for (int i = 0; i < Params.Length; i++)
|
|||
|
|
{
|
|||
|
|
FMOD.Studio.PARAMETER_DESCRIPTION param;
|
|||
|
|
eventDescription.getParameterDescriptionByName(Params[i].Name, out param);
|
|||
|
|
Params[i].ID = param.id;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public void Play()
|
|||
|
|
{
|
|||
|
|
if (TriggerOnce && hasTriggered)
|
|||
|
|
{
|
|||
|
|
return;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (EventReference.IsNull)
|
|||
|
|
{
|
|||
|
|
return;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
cachedParams.Clear();
|
|||
|
|
|
|||
|
|
if (!eventDescription.isValid())
|
|||
|
|
{
|
|||
|
|
Lookup();
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
bool isSnapshot;
|
|||
|
|
eventDescription.isSnapshot(out isSnapshot);
|
|||
|
|
|
|||
|
|
if (!isSnapshot)
|
|||
|
|
{
|
|||
|
|
eventDescription.isOneshot(out isOneshot);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
bool is3D;
|
|||
|
|
eventDescription.is3D(out is3D);
|
|||
|
|
|
|||
|
|
IsActive = true;
|
|||
|
|
|
|||
|
|
if (is3D && !isOneshot && Settings.Instance.StopEventsOutsideMaxDistance)
|
|||
|
|
{
|
|||
|
|
RegisterActiveEmitter(this);
|
|||
|
|
UpdatePlayingStatus(true);
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
{
|
|||
|
|
PlayInstance();
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private void PlayInstance()
|
|||
|
|
{
|
|||
|
|
if (!instance.isValid())
|
|||
|
|
{
|
|||
|
|
instance.clearHandle();
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
// Let previous oneshot instances play out
|
|||
|
|
if (isOneshot && instance.isValid())
|
|||
|
|
{
|
|||
|
|
instance.release();
|
|||
|
|
instance.clearHandle();
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
bool is3D;
|
|||
|
|
eventDescription.is3D(out is3D);
|
|||
|
|
|
|||
|
|
if (!instance.isValid())
|
|||
|
|
{
|
|||
|
|
eventDescription.createInstance(out instance);
|
|||
|
|
|
|||
|
|
// Only want to update if we need to set 3D attributes
|
|||
|
|
if (is3D)
|
|||
|
|
{
|
|||
|
|
var transform = GetComponent<Transform>();
|
|||
|
|
#if UNITY_PHYSICS_EXIST
|
|||
|
|
if (GetComponent<Rigidbody>())
|
|||
|
|
{
|
|||
|
|
Rigidbody rigidBody = GetComponent<Rigidbody>();
|
|||
|
|
instance.set3DAttributes(RuntimeUtils.To3DAttributes(gameObject, rigidBody));
|
|||
|
|
RuntimeManager.AttachInstanceToGameObject(instance, gameObject, rigidBody);
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
#endif
|
|||
|
|
#if UNITY_PHYSICS2D_EXIST
|
|||
|
|
if (GetComponent<Rigidbody2D>())
|
|||
|
|
{
|
|||
|
|
var rigidBody2D = GetComponent<Rigidbody2D>();
|
|||
|
|
instance.set3DAttributes(RuntimeUtils.To3DAttributes(gameObject, rigidBody2D));
|
|||
|
|
RuntimeManager.AttachInstanceToGameObject(instance, gameObject, rigidBody2D);
|
|||
|
|
}
|
|||
|
|
else
|
|||
|
|
#endif
|
|||
|
|
{
|
|||
|
|
instance.set3DAttributes(RuntimeUtils.To3DAttributes(gameObject));
|
|||
|
|
RuntimeManager.AttachInstanceToGameObject(instance, gameObject, NonRigidbodyVelocity);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
foreach (var param in Params)
|
|||
|
|
{
|
|||
|
|
instance.setParameterByID(param.ID, param.Value);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
foreach (var cachedParam in cachedParams)
|
|||
|
|
{
|
|||
|
|
instance.setParameterByID(cachedParam.ID, cachedParam.Value);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (is3D && OverrideAttenuation)
|
|||
|
|
{
|
|||
|
|
instance.setProperty(FMOD.Studio.EVENT_PROPERTY.MINIMUM_DISTANCE, OverrideMinDistance);
|
|||
|
|
instance.setProperty(FMOD.Studio.EVENT_PROPERTY.MAXIMUM_DISTANCE, OverrideMaxDistance);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
instance.start();
|
|||
|
|
|
|||
|
|
hasTriggered = true;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public void Stop()
|
|||
|
|
{
|
|||
|
|
DeregisterActiveEmitter(this);
|
|||
|
|
IsActive = false;
|
|||
|
|
cachedParams.Clear();
|
|||
|
|
StopInstance();
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private void StopInstance()
|
|||
|
|
{
|
|||
|
|
if (TriggerOnce && hasTriggered)
|
|||
|
|
{
|
|||
|
|
DeregisterActiveEmitter(this);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (instance.isValid())
|
|||
|
|
{
|
|||
|
|
instance.stop(AllowFadeout ? FMOD.Studio.STOP_MODE.ALLOWFADEOUT : FMOD.Studio.STOP_MODE.IMMEDIATE);
|
|||
|
|
instance.release();
|
|||
|
|
if (!AllowFadeout)
|
|||
|
|
{
|
|||
|
|
instance.clearHandle();
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public void SetParameter(string name, float value, bool ignoreseekspeed = false)
|
|||
|
|
{
|
|||
|
|
if (Settings.Instance.StopEventsOutsideMaxDistance && IsActive)
|
|||
|
|
{
|
|||
|
|
string findName = name;
|
|||
|
|
ParamRef cachedParam = cachedParams.Find(x => x.Name == findName);
|
|||
|
|
|
|||
|
|
if (cachedParam == null)
|
|||
|
|
{
|
|||
|
|
FMOD.Studio.PARAMETER_DESCRIPTION paramDesc;
|
|||
|
|
eventDescription.getParameterDescriptionByName(name, out paramDesc);
|
|||
|
|
|
|||
|
|
cachedParam = new ParamRef();
|
|||
|
|
cachedParam.ID = paramDesc.id;
|
|||
|
|
cachedParam.Name = paramDesc.name;
|
|||
|
|
cachedParams.Add(cachedParam);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
cachedParam.Value = value;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (instance.isValid())
|
|||
|
|
{
|
|||
|
|
instance.setParameterByName(name, value, ignoreseekspeed);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public void SetParameter(FMOD.Studio.PARAMETER_ID id, float value, bool ignoreseekspeed = false)
|
|||
|
|
{
|
|||
|
|
if (Settings.Instance.StopEventsOutsideMaxDistance && IsActive)
|
|||
|
|
{
|
|||
|
|
FMOD.Studio.PARAMETER_ID findId = id;
|
|||
|
|
ParamRef cachedParam = cachedParams.Find(x => x.ID.Equals(findId));
|
|||
|
|
|
|||
|
|
if (cachedParam == null)
|
|||
|
|
{
|
|||
|
|
FMOD.Studio.PARAMETER_DESCRIPTION paramDesc;
|
|||
|
|
eventDescription.getParameterDescriptionByID(id, out paramDesc);
|
|||
|
|
|
|||
|
|
cachedParam = new ParamRef();
|
|||
|
|
cachedParam.ID = paramDesc.id;
|
|||
|
|
cachedParam.Name = paramDesc.name;
|
|||
|
|
cachedParams.Add(cachedParam);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
cachedParam.Value = value;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (instance.isValid())
|
|||
|
|
{
|
|||
|
|
instance.setParameterByID(id, value, ignoreseekspeed);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public bool IsPlaying()
|
|||
|
|
{
|
|||
|
|
if (instance.isValid())
|
|||
|
|
{
|
|||
|
|
FMOD.Studio.PLAYBACK_STATE playbackState;
|
|||
|
|
instance.getPlaybackState(out playbackState);
|
|||
|
|
return (playbackState != FMOD.Studio.PLAYBACK_STATE.STOPPED);
|
|||
|
|
}
|
|||
|
|
return false;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|