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	SetGlobalOcclusionSignals ()
	Sets all occlusion signals.
void	SetEnvironmentalSignals (SoundWorld soundWorld, vector pos)
	Sets environmental signals based on SoundMap.
bool	Play ()
void	SetTransformation (vector mat[4])
void	UpdateTransformation ()
void	Terminate ()
void	SCR_AudioSource (IEntity owner, SCR_AudioSourceConfiguration audioSourceConfiguration, float distance)

Public Attributes
AudioHandle	m_AudioHandle = AudioHandle.Invalid
	Stores valid Audio handle.
IEntity	m_Owner
	Paren entity audio source is linked to.
ref SCR_AudioSourceConfiguration	m_AudioSourceConfiguration
	Audio source configuration.
ref SCR_InteriorRequestCallback	m_InteriorRequestCallback
	Interior callback.
bool	m_bTerminated = false
	Sound is terminated.

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]
	Transformation where sound was triggered.
ref array< string >	m_aSignalName
	Signal names.
ref array< float >	m_aSignalValue
	Signal values.

Constructor & Destructor Documentation

SCR_AudioSource()

void SCR_AudioSource.SCR_AudioSource	(	IEntity	owner,
		SCR_AudioSourceConfiguration	audioSourceConfiguration,
		float	distance
	)

Member Function Documentation

Play()

bool SCR_AudioSource.Play

(

)

SetEnvironmentalSignals()

void SCR_AudioSource.SetEnvironmentalSignals	(	SoundWorld	soundWorld,
		vector	pos
	)

Sets environmental signals based on SoundMap.

SetGlobalOcclusionSignals()

void SCR_AudioSource.SetGlobalOcclusionSignals

(

)

Sets all occlusion signals.

SetSignalValue()

void SCR_AudioSource.SetSignalValue	(	string	name,
		float	value
	)

SetTransformation()

void SCR_AudioSource.SetTransformation

(

vector

mat[4]

)

Terminate()

void SCR_AudioSource.Terminate

(

)

UpdateTransformation()

void SCR_AudioSource.UpdateTransformation

(

)

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

Transformation where sound was triggered.

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_AudioSourceConfiguration

ref SCR_AudioSourceConfiguration SCR_AudioSource.m_AudioSourceConfiguration

Audio source configuration.

m_bTerminated

bool SCR_AudioSource.m_bTerminated = false

Sound is terminated.

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.

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/Entities/SoundManager/SCR_AudioSource.c