Eye of the Nile Docs
Everything you need to know to get started!
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
FMODUnity.StudioEventEmitter Class Reference

Public Member Functions

void Play ()
 
void Stop ()
 
void SetParameter (string name, float value, bool ignoreseekspeed=false)
 
void SetParameter (FMOD.Studio.PARAMETER_ID id, float value, bool ignoreseekspeed=false)
 
bool IsPlaying ()
 
- Public Member Functions inherited from FMODUnity.EventHandler
void OnPointerEnter (PointerEventData eventData)
 
void OnPointerExit (PointerEventData eventData)
 
void OnPointerDown (PointerEventData eventData)
 
void OnPointerUp (PointerEventData eventData)
 

Static Public Member Functions

static void UpdateActiveEmitters ()
 

Public Attributes

EventReference EventReference
 
string Event = ""
 
EmitterGameEvent EventPlayTrigger = EmitterGameEvent.None
 
EmitterGameEvent EventStopTrigger = EmitterGameEvent.None
 
bool AllowFadeout = true
 
bool TriggerOnce = false
 
bool Preload = false
 
bool NonRigidbodyVelocity = false
 
ParamRef[] Params = new ParamRef[0]
 
bool OverrideAttenuation = false
 
float OverrideMinDistance = -1.0f
 
float OverrideMaxDistance = -1.0f
 
- Public Attributes inherited from FMODUnity.EventHandler
string CollisionTag = ""
 

Protected Member Functions

override void Start ()
 
override void OnDestroy ()
 
override void HandleGameEvent (EmitterGameEvent gameEvent)
 
- Protected Member Functions inherited from FMODUnity.EventHandler
void HandleGameEvent (EmitterGameEvent gameEvent)
 

Protected Attributes

FMOD.Studio.EventDescription eventDescription
 
FMOD.Studio.EventInstance instance
 

Properties

EmitterGameEvent PlayEvent [get, set]
 
EmitterGameEvent StopEvent [get, set]
 
FMOD.Studio.EventDescription EventDescription [get]
 
FMOD.Studio.EventInstance EventInstance [get]
 
bool IsActive [get, private set]
 
float MaxDistance [get]
 

Private Member Functions

void UpdatePlayingStatus (bool force=false)
 
void OnApplicationQuit ()
 
void Lookup ()
 
void PlayInstance ()
 
void StopInstance ()
 

Static Private Member Functions

static void RegisterActiveEmitter (StudioEventEmitter emitter)
 
static void DeregisterActiveEmitter (StudioEventEmitter emitter)
 

Private Attributes

bool hasTriggered = false
 
bool isQuitting = false
 
bool isOneshot = false
 
List< ParamRef > cachedParams = new List<ParamRef>()
 

Static Private Attributes

static List< StudioEventEmitter > activeEmitters = new List<StudioEventEmitter>()
 
const string SnapshotString = "snapshot"
 

Member Function Documentation

◆ DeregisterActiveEmitter()

static void FMODUnity.StudioEventEmitter.DeregisterActiveEmitter ( StudioEventEmitter emitter)
staticprivate

◆ HandleGameEvent()

override void FMODUnity.StudioEventEmitter.HandleGameEvent ( EmitterGameEvent gameEvent)
protected

◆ IsPlaying()

bool FMODUnity.StudioEventEmitter.IsPlaying ( )

◆ Lookup()

void FMODUnity.StudioEventEmitter.Lookup ( )
private

◆ OnApplicationQuit()

void FMODUnity.StudioEventEmitter.OnApplicationQuit ( )
private

◆ OnDestroy()

override void FMODUnity.StudioEventEmitter.OnDestroy ( )
protectedvirtual

Reimplemented from FMODUnity.EventHandler.

◆ Play()

void FMODUnity.StudioEventEmitter.Play ( )

◆ PlayInstance()

void FMODUnity.StudioEventEmitter.PlayInstance ( )
private

◆ RegisterActiveEmitter()

static void FMODUnity.StudioEventEmitter.RegisterActiveEmitter ( StudioEventEmitter emitter)
staticprivate

◆ SetParameter() [1/2]

void FMODUnity.StudioEventEmitter.SetParameter ( FMOD.Studio.PARAMETER_ID id,
float value,
bool ignoreseekspeed = false )

◆ SetParameter() [2/2]

void FMODUnity.StudioEventEmitter.SetParameter ( string name,
float value,
bool ignoreseekspeed = false )

◆ Start()

override void FMODUnity.StudioEventEmitter.Start ( )
protectedvirtual

Reimplemented from FMODUnity.EventHandler.

◆ Stop()

void FMODUnity.StudioEventEmitter.Stop ( )

◆ StopInstance()

void FMODUnity.StudioEventEmitter.StopInstance ( )
private

◆ UpdateActiveEmitters()

static void FMODUnity.StudioEventEmitter.UpdateActiveEmitters ( )
static

◆ UpdatePlayingStatus()

void FMODUnity.StudioEventEmitter.UpdatePlayingStatus ( bool force = false)
private

Member Data Documentation

◆ activeEmitters

List<StudioEventEmitter> FMODUnity.StudioEventEmitter.activeEmitters = new List<StudioEventEmitter>()
staticprivate

◆ AllowFadeout

bool FMODUnity.StudioEventEmitter.AllowFadeout = true

◆ cachedParams

List<ParamRef> FMODUnity.StudioEventEmitter.cachedParams = new List<ParamRef>()
private

◆ Event

string FMODUnity.StudioEventEmitter.Event = ""

◆ eventDescription

FMOD.Studio.EventDescription FMODUnity.StudioEventEmitter.eventDescription
protected

◆ EventPlayTrigger

EmitterGameEvent FMODUnity.StudioEventEmitter.EventPlayTrigger = EmitterGameEvent.None

◆ EventReference

EventReference FMODUnity.StudioEventEmitter.EventReference

◆ EventStopTrigger

EmitterGameEvent FMODUnity.StudioEventEmitter.EventStopTrigger = EmitterGameEvent.None

◆ hasTriggered

bool FMODUnity.StudioEventEmitter.hasTriggered = false
private

◆ instance

FMOD.Studio.EventInstance FMODUnity.StudioEventEmitter.instance
protected

◆ isOneshot

bool FMODUnity.StudioEventEmitter.isOneshot = false
private

◆ isQuitting

bool FMODUnity.StudioEventEmitter.isQuitting = false
private

◆ NonRigidbodyVelocity

bool FMODUnity.StudioEventEmitter.NonRigidbodyVelocity = false

◆ OverrideAttenuation

bool FMODUnity.StudioEventEmitter.OverrideAttenuation = false

◆ OverrideMaxDistance

float FMODUnity.StudioEventEmitter.OverrideMaxDistance = -1.0f

◆ OverrideMinDistance

float FMODUnity.StudioEventEmitter.OverrideMinDistance = -1.0f

◆ Params

ParamRef [] FMODUnity.StudioEventEmitter.Params = new ParamRef[0]

◆ Preload

bool FMODUnity.StudioEventEmitter.Preload = false

◆ SnapshotString

const string FMODUnity.StudioEventEmitter.SnapshotString = "snapshot"
staticprivate

◆ TriggerOnce

bool FMODUnity.StudioEventEmitter.TriggerOnce = false

Property Documentation

◆ EventDescription

FMOD.Studio.EventDescription FMODUnity.StudioEventEmitter.EventDescription
get

◆ EventInstance

FMOD.Studio.EventInstance FMODUnity.StudioEventEmitter.EventInstance
get

◆ IsActive

bool FMODUnity.StudioEventEmitter.IsActive
getprivate set

◆ MaxDistance

float FMODUnity.StudioEventEmitter.MaxDistance
getprivate

◆ PlayEvent

EmitterGameEvent FMODUnity.StudioEventEmitter.PlayEvent
getset

◆ StopEvent

EmitterGameEvent FMODUnity.StudioEventEmitter.StopEvent
getset
The documentation for this class was generated from the following file: