SCR_AudioSource Interface Reference

Public Member Functions
Signal name
Sets value for given signal name \value Signal value
void	SetSignalValue (string name, float value)
void	SetEnvironmentalSignals (SoundWorld soundWorld)
	Sets environmental signals based on SoundMap.
bool	Play ()
void	UpdateSoundTransformation ()
void	CalculateInteriror (SoundWorld soundWorld)
void	Terminate (bool fadeOut=true)
void	SCR_AudioSource (SCR_AudioSourceConfiguration audioSourceConfiguration, vector mat[4])

Public Attributes
AudioHandle	m_AudioHandle = AudioHandle.Invalid
	Stores valid Audio handle.
IEntity	m_Owner
	Paren entity audio source is linked to.
vector	m_vOffset
	Playback position offset.
ResourceName	m_sSoundProject
	Audio project resource name.
string	m_sSoundEventName
	Sound event name.
ref SCR_InteriorRequestCallback	m_InteriorRequestCallback
	Interior callback.
EAudioSourceFlag	m_eFlags
	Flags describing runtime AudioSource state or behaviour.

Static Public Attributes
static const string	INTERIOR_SIGNAL_NAME = "Interior"
	Local signal names.
static const string	SURFACE_SIGNAL_NAME = "Surface"
static const string	ENTITY_SIZE_SIGNAL_NAME = "EntitySize"
static const string	PHASES_TO_DESTROYED_PHASE_SIGNAL_NAME = "PhasesToDestroyed"
static const string	COLLISION_D_V_SIGNAL_NAME = "CollisionDV"
static const string	DISTANCE_SINAL_NAME = "Distance"
static const string	ROOM_SIZE_SIGNAL_NAME = "RoomSize"
static const string	FOREST_SIGNAL_NAME = "Forest"
static const string	HOUSES_SIGNAL_NAME = "Houses"
static const string	MEADOWS_SIGNAL_NAME = "Meadows"
static const string	SEA_SIGNAL_NAME = "Sea"

Protected Attributes
vector	m_aMat [4]
	AudioSource position.
ref array< string >	m_aSignalName
	Signal names.
ref array< float >	m_aSignalValue
	Signal values.

Constructor & Destructor Documentation

SCR_AudioSource()

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

Member Function Documentation

CalculateInteriror()

void SCR_AudioSource.CalculateInteriror

(

SoundWorld

soundWorld

)

Play()

bool SCR_AudioSource.Play

(

)

SetEnvironmentalSignals()

void SCR_AudioSource.SetEnvironmentalSignals

(

SoundWorld

soundWorld

)

Sets environmental signals based on SoundMap.

SetSignalValue()

void SCR_AudioSource.SetSignalValue	(	string	name,
		float	value )

Terminate()

void SCR_AudioSource.Terminate

(

bool

fadeOut = true

)

UpdateSoundTransformation()

void SCR_AudioSource.UpdateSoundTransformation

(

)

Member Data Documentation

COLLISION_D_V_SIGNAL_NAME

const string SCR_AudioSource.COLLISION_D_V_SIGNAL_NAME = "CollisionDV"

static

DISTANCE_SINAL_NAME

const string SCR_AudioSource.DISTANCE_SINAL_NAME = "Distance"

static

ENTITY_SIZE_SIGNAL_NAME

const string SCR_AudioSource.ENTITY_SIZE_SIGNAL_NAME = "EntitySize"

static

FOREST_SIGNAL_NAME

const string SCR_AudioSource.FOREST_SIGNAL_NAME = "Forest"

static

HOUSES_SIGNAL_NAME

const string SCR_AudioSource.HOUSES_SIGNAL_NAME = "Houses"

static

INTERIOR_SIGNAL_NAME

const string SCR_AudioSource.INTERIOR_SIGNAL_NAME = "Interior"

static

Local signal names.

m_aMat

vector SCR_AudioSource.m_aMat[4]

protected

AudioSource position.

m_aSignalName

ref array<string> SCR_AudioSource.m_aSignalName

protected

Signal names.

m_aSignalValue

ref array<float> SCR_AudioSource.m_aSignalValue

protected

Signal values.

m_AudioHandle

AudioHandle SCR_AudioSource.m_AudioHandle = AudioHandle.Invalid

Stores valid Audio handle.

m_eFlags

EAudioSourceFlag SCR_AudioSource.m_eFlags

Flags describing runtime AudioSource state or behaviour.

m_InteriorRequestCallback

ref SCR_InteriorRequestCallback SCR_AudioSource.m_InteriorRequestCallback

Interior callback.

m_Owner

IEntity SCR_AudioSource.m_Owner

Paren entity audio source is linked to.

m_sSoundEventName

string SCR_AudioSource.m_sSoundEventName

Sound event name.

m_sSoundProject

ResourceName SCR_AudioSource.m_sSoundProject

Audio project resource name.

m_vOffset

vector SCR_AudioSource.m_vOffset

Playback position offset.

MEADOWS_SIGNAL_NAME

const string SCR_AudioSource.MEADOWS_SIGNAL_NAME = "Meadows"

static

PHASES_TO_DESTROYED_PHASE_SIGNAL_NAME

const string SCR_AudioSource.PHASES_TO_DESTROYED_PHASE_SIGNAL_NAME = "PhasesToDestroyed"

static

ROOM_SIZE_SIGNAL_NAME

const string SCR_AudioSource.ROOM_SIZE_SIGNAL_NAME = "RoomSize"

static

SEA_SIGNAL_NAME

const string SCR_AudioSource.SEA_SIGNAL_NAME = "Sea"

static

SURFACE_SIGNAL_NAME

const string SCR_AudioSource.SURFACE_SIGNAL_NAME = "Surface"

static

---

The documentation for this interface was generated from the following file:

• Game/Systems/Sound/SCR_AudioSource.c