DynamicAudioEventInfo Class Reference

#include <DynamicAudioEventInfo.h>

Inherits AudioEventInfo.

Public Member Functions
	DynamicAudioEventInfo ()
	DynamicAudioEventInfo (const AudioEventInfo &baseInfo)
virtual Bool	isLevelSpecific () const
virtual DynamicAudioEventInfo *	getDynamicAudioEventInfo ()
virtual const DynamicAudioEventInfo *	getDynamicAudioEventInfo () const
void	overrideAudioName (const AsciiString &newName)
void	overrideLoopFlag (Bool newLoopFlag)
void	overrideLoopCount (Int newLoopCount)
void	overrideVolume (Real newVolume)
void	overrideMinVolume (Real newMinVolume)
void	overrideMinRange (Real newMinRange)
void	overrideMaxRange (Real newMaxRange)
void	overridePriority (AudioPriority newPriority)
Bool	wasAudioNameOverriden () const
Bool	wasLoopFlagOverriden () const
Bool	wasLoopCountOverriden () const
Bool	wasVolumeOverriden () const
Bool	wasMinVolumeOverriden () const
Bool	wasMinRangeOverriden () const
Bool	wasMaxRangeOverriden () const
Bool	wasPriorityOverriden () const
const AsciiString &	getOriginalName () const
void	xferNoName (Xfer *xfer)
Public Member Functions inherited from AudioEventInfo
Bool	isPermanentSound () const
const FieldParse *	getFieldParse (void) const
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Additional Inherited Members
Public Attributes inherited from AudioEventInfo
AsciiString	m_audioName
AsciiString	m_filename
Real	m_volume
Real	m_volumeShift
Real	m_minVolume
Real	m_pitchShiftMin
Real	m_pitchShiftMax
Int	m_delayMin
Int	m_delayMax
Int	m_limit
Int	m_loopCount
AudioPriority	m_priority
UnsignedInt	m_type
UnsignedInt	m_control
std::vector< AsciiString >	m_soundsMorning
std::vector< AsciiString >	m_sounds
std::vector< AsciiString >	m_soundsNight
std::vector< AsciiString >	m_soundsEvening
std::vector< AsciiString >	m_attackSounds
std::vector< AsciiString >	m_decaySounds
Real	m_lowPassFreq
Real	m_minDistance
Real	m_maxDistance
AudioType	m_soundType
Static Public Attributes inherited from AudioEventInfo
static const FieldParse	m_audioEventInfo []
	the parse table for INI definition
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Detailed Description

Definition at line 44 of file DynamicAudioEventInfo.h.

Constructor & Destructor Documentation

DynamicAudioEventInfo() [1/2]

DynamicAudioEventInfo::DynamicAudioEventInfo

(

)

Default constructor

Definition at line 35 of file DynamicAudioEventInfo.cpp.

DynamicAudioEventInfo() [2/2]

DynamicAudioEventInfo::DynamicAudioEventInfo ( const AudioEventInfo & baseInfo )

explicit

Initialize AudioEventInfo portion of DynamicAudioEventInfo as copy; leave remainder uninitialized

Definition at line 40 of file DynamicAudioEventInfo.cpp.

Member Function Documentation

getDynamicAudioEventInfo() [1/2]

DynamicAudioEventInfo * DynamicAudioEventInfo::getDynamicAudioEventInfo ( )

virtual

Override; cheap dynamic casting

Reimplemented from AudioEventInfo.

Definition at line 56 of file DynamicAudioEventInfo.cpp.

getDynamicAudioEventInfo() [2/2]

const DynamicAudioEventInfo * DynamicAudioEventInfo::getDynamicAudioEventInfo ( ) const

virtual

Override; cheap dynamic casting

Reimplemented from AudioEventInfo.

Definition at line 62 of file DynamicAudioEventInfo.cpp.

getOriginalName()

const AsciiString & DynamicAudioEventInfo::getOriginalName

(

)

const

Get the name of the INI entry this event info was derived from

Definition at line 139 of file DynamicAudioEventInfo.cpp.

isLevelSpecific()

Bool DynamicAudioEventInfo::isLevelSpecific ( ) const

virtual

Override; dynamic audio events are used only for level-specific stuff at the moment

Reimplemented from AudioEventInfo.

Definition at line 50 of file DynamicAudioEventInfo.cpp.

overrideAudioName()

void DynamicAudioEventInfo::overrideAudioName

(

const AsciiString &

newName

)

Override; change the name of this audio event

Definition at line 69 of file DynamicAudioEventInfo.cpp.

overrideLoopCount()

void DynamicAudioEventInfo::overrideLoopCount

(

Int

newLoopCount

)

Override; change the looping properties of this audio event

Definition at line 91 of file DynamicAudioEventInfo.cpp.

overrideLoopFlag()

void DynamicAudioEventInfo::overrideLoopFlag

(

Bool

newLoopFlag

)

Override; change the looping property of this audio event

Definition at line 80 of file DynamicAudioEventInfo.cpp.

overrideMaxRange()

void DynamicAudioEventInfo::overrideMaxRange

(

Real

newMaxRange

)

Override; change the name of this audio event

Definition at line 123 of file DynamicAudioEventInfo.cpp.

overrideMinRange()

void DynamicAudioEventInfo::overrideMinRange

(

Real

newMinRange

)

Override; change the name of this audio event

Definition at line 115 of file DynamicAudioEventInfo.cpp.

overrideMinVolume()

void DynamicAudioEventInfo::overrideMinVolume

(

Real

newMinVolume

)

Override; change the minimum volume of this audio event

Definition at line 107 of file DynamicAudioEventInfo.cpp.

overridePriority()

void DynamicAudioEventInfo::overridePriority

(

AudioPriority

newPriority

)

Override; change the name of this audio event

Definition at line 131 of file DynamicAudioEventInfo.cpp.

overrideVolume()

void DynamicAudioEventInfo::overrideVolume

(

Real

newVolume

)

Override; change the volume of this audio event

Definition at line 99 of file DynamicAudioEventInfo.cpp.

wasAudioNameOverriden()

Bool DynamicAudioEventInfo::wasAudioNameOverriden ( ) const

inline

Query: was overrideAudioName called?

Definition at line 112 of file DynamicAudioEventInfo.h.

wasLoopCountOverriden()

Bool DynamicAudioEventInfo::wasLoopCountOverriden ( ) const

inline

Query: was overrideLoopCount called?

Definition at line 124 of file DynamicAudioEventInfo.h.

wasLoopFlagOverriden()

Bool DynamicAudioEventInfo::wasLoopFlagOverriden ( ) const

inline

Query: was overrideLoopFlag called?

Definition at line 118 of file DynamicAudioEventInfo.h.

wasMaxRangeOverriden()

Bool DynamicAudioEventInfo::wasMaxRangeOverriden ( ) const

inline

Query: was overrideMaxRange called?

Definition at line 148 of file DynamicAudioEventInfo.h.

wasMinRangeOverriden()

Bool DynamicAudioEventInfo::wasMinRangeOverriden ( ) const

inline

Query: was overrideMinRange called?

Definition at line 142 of file DynamicAudioEventInfo.h.

wasMinVolumeOverriden()

Bool DynamicAudioEventInfo::wasMinVolumeOverriden ( ) const

inline

Query: was overrideMinVolume called?

Definition at line 136 of file DynamicAudioEventInfo.h.

wasPriorityOverriden()

Bool DynamicAudioEventInfo::wasPriorityOverriden ( ) const

inline

Query: was overridePriority called?

Definition at line 154 of file DynamicAudioEventInfo.h.

wasVolumeOverriden()

Bool DynamicAudioEventInfo::wasVolumeOverriden ( ) const

inline

Query: was overrideVolume called?

Definition at line 130 of file DynamicAudioEventInfo.h.

xferNoName()

void DynamicAudioEventInfo::xferNoName

(

Xfer *

xfer

)

Transfer all overridden fields except the customized name

Definition at line 152 of file DynamicAudioEventInfo.cpp.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/Common/DynamicAudioEventInfo.h
• Code/GameEngine/Source/Common/Audio/DynamicAudioEventInfo.cpp