SCR_AudioSource.c File Reference

Go to the source code of this file.

Enumerations
enum	EAudioSourceFlag {   Static = 1 << 0 , EnvironmentSignals = 1 << 1 , FinishWhenEntityDestroyed = 1 << 2 , BoundingVolume = 1 << 3 ,   ExteriorSource = 1 << 4 , Terminated = 1 << 5 , HasOffset = 1 << 6 }

Functions
Signal name
Sets value for given signal name \value Signal value
void	SetSignalValue (string name, float value)
void	SetEnvironmentalSignals (SoundWorld soundWorld)
bool	Play ()
	Start playing the animation. Call 'Prepare' first if you need to change the setup of a component!
void	UpdateSoundTransformation ()
void	CalculateInteriror (SoundWorld soundWorld)
void	Terminate (bool fadeOut=true)
void	SCR_AudioSource (SCR_AudioSourceConfiguration audioSourceConfiguration, vector mat[4])

Variables
enum EAudioSourceFlag	m_AudioHandle = AudioHandle.Invalid
	Stores valid Audio handle.
IEntity	m_Owner
	Paren entity audio source is linked to.
vector	m_aMat [4]
	AudioSource position.
vector	m_vOffset
	Playback position offset.
ResourceName	m_sSoundProject
	Audio project resource name.
string	m_sSoundEventName
	Sound event name.
ref array< string >	m_aSignalName
	Signal names.
ref array< float >	m_aSignalValue
	Signal values.
ref SCR_InteriorRequestCallback	m_InteriorRequestCallback
	Interior callback.
EAudioSourceFlag	m_eFlags
	Flags describing runtime AudioSource state or behaviour.

Enumeration Type Documentation

EAudioSourceFlag

enum EAudioSourceFlag

Enumerator
Static
EnvironmentSignals
FinishWhenEntityDestroyed
BoundingVolume
ExteriorSource
Terminated
HasOffset

Definition at line 1 of file SCR_AudioSource.c.

Function Documentation

CalculateInteriror()

void CalculateInteriror ( SoundWorld soundWorld )

protected

Definition at line 121 of file SCR_AudioSource.c.

SCR_AudioSource()

void SCR_AudioSource ( SCR_AudioSourceConfiguration audioSourceConfiguration, vector mat[4] )

protected

Definition at line 139 of file SCR_AudioSource.c.

SetEnvironmentalSignals()

void SetEnvironmentalSignals ( SoundWorld soundWorld )

protected

Sets environmental signals based on SoundMap

Definition at line 70 of file SCR_AudioSource.c.

SetSignalValue()

void SetSignalValue ( string name, float value )

protected

Definition at line 54 of file SCR_AudioSource.c.

Terminate()

void Terminate ( bool fadeOut = true )

protected

Definition at line 128 of file SCR_AudioSource.c.

UpdateSoundTransformation()

void UpdateSoundTransformation ( )

protected

Definition at line 107 of file SCR_AudioSource.c.

Variable Documentation

m_aMat

vector m_aMat[4]

protected

AudioSource position.

Definition at line 19 of file SCR_AudioSource.c.

m_aSignalName

ref array<string> m_aSignalName

protected

Signal names.

Definition at line 27 of file SCR_AudioSource.c.

m_aSignalValue

ref array<float> m_aSignalValue

protected

Signal values.

Definition at line 29 of file SCR_AudioSource.c.

m_AudioHandle

enum EAudioSourceFlag m_AudioHandle = AudioHandle.Invalid

Stores valid Audio handle.

m_eFlags

EAudioSourceFlag m_eFlags

protected

Flags describing runtime AudioSource state or behaviour.

Definition at line 33 of file SCR_AudioSource.c.

m_InteriorRequestCallback

ref SCR_InteriorRequestCallback m_InteriorRequestCallback

protected

Interior callback.

Definition at line 31 of file SCR_AudioSource.c.

m_Owner

IEntity m_Owner

Paren entity audio source is linked to.

Definition at line 17 of file SCR_AudioSource.c.

m_sSoundEventName

string m_sSoundEventName

protected

Sound event name.

Definition at line 25 of file SCR_AudioSource.c.

m_sSoundProject

ResourceName m_sSoundProject

protected

Audio project resource name.

Definition at line 23 of file SCR_AudioSource.c.

m_vOffset

vector m_vOffset

protected

Playback position offset.

Definition at line 21 of file SCR_AudioSource.c.