Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
AudioEventInfo Struct Reference

#include <AudioEventInfo.h>

Inherits MemoryPoolObject.

Inherited by DynamicAudioEventInfo.

Public Member Functions

virtual Bool isLevelSpecific () const
 If true, this sound is only defined on the current level and can be deleted when that level ends.
 
virtual DynamicAudioEventInfo * getDynamicAudioEventInfo ()
 If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class.
 
virtual const DynamicAudioEventInfo * getDynamicAudioEventInfo () const
 If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class.
 
Bool isPermanentSound () const
 
const FieldParse * getFieldParse (void) const
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Public Attributes

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

static const FieldParse m_audioEventInfo []
 the parse table for INI definition
 

Additional Inherited Members

- 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 87 of file AudioEventInfo.h.

Member Function Documentation

◆ getDynamicAudioEventInfo() [1/2]

virtual DynamicAudioEventInfo * AudioEventInfo::getDynamicAudioEventInfo ( )
inlinevirtual

If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class.

Reimplemented in DynamicAudioEventInfo.

Definition at line 126 of file AudioEventInfo.h.

◆ getDynamicAudioEventInfo() [2/2]

virtual const DynamicAudioEventInfo * AudioEventInfo::getDynamicAudioEventInfo ( ) const
inlinevirtual

If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class.

Reimplemented in DynamicAudioEventInfo.

Definition at line 127 of file AudioEventInfo.h.

◆ getFieldParse()

const FieldParse * AudioEventInfo::getFieldParse ( void ) const
inline

Definition at line 134 of file AudioEventInfo.h.

◆ isLevelSpecific()

virtual Bool AudioEventInfo::isLevelSpecific ( ) const
inlinevirtual

If true, this sound is only defined on the current level and can be deleted when that level ends.

Reimplemented in DynamicAudioEventInfo.

Definition at line 125 of file AudioEventInfo.h.

◆ isPermanentSound()

Bool AudioEventInfo::isPermanentSound ( ) const
inline

Is this a permenant sound? That is, if I start this sound up, will it ever end "on its own" or only if I explicitly kill it?

Definition at line 131 of file AudioEventInfo.h.

Member Data Documentation

◆ m_attackSounds

std::vector<AsciiString> AudioEventInfo::m_attackSounds

Definition at line 114 of file AudioEventInfo.h.

◆ m_audioEventInfo

const FieldParse AudioEventInfo::m_audioEventInfo
static
Initial value:
=
{
{ "Filename", INI::parseAsciiString, NULL, offsetof( AudioEventInfo, m_filename) },
{ "Volume", INI::parsePercentToReal, NULL, offsetof( AudioEventInfo, m_volume ) },
{ "VolumeShift", INI::parsePercentToReal, NULL, offsetof( AudioEventInfo, m_volumeShift ) },
{ "MinVolume", INI::parsePercentToReal, NULL, offsetof( AudioEventInfo, m_minVolume ) },
{ "PitchShift", parsePitchShift, NULL, 0 },
{ "Delay", parseDelay, NULL, 0 },
{ "Limit", INI::parseInt, NULL, offsetof( AudioEventInfo, m_limit ) },
{ "LoopCount", INI::parseInt, NULL, offsetof( AudioEventInfo, m_loopCount ) },
{ "Priority", INI::parseIndexList, theAudioPriorityNames, offsetof( AudioEventInfo, m_priority ) },
{ "Type", INI::parseBitString32, theSoundTypeNames, offsetof( AudioEventInfo, m_type ) },
{ "Control", INI::parseBitString32, theAudioControlNames, offsetof( AudioEventInfo, m_control ) },
{ "Sounds", INI::parseSoundsList, NULL, offsetof( AudioEventInfo, m_sounds ) },
{ "SoundsNight", INI::parseSoundsList, NULL, offsetof( AudioEventInfo, m_soundsNight ) },
{ "SoundsEvening", INI::parseSoundsList, NULL, offsetof( AudioEventInfo, m_soundsEvening ) },
{ "SoundsMorning", INI::parseSoundsList, NULL, offsetof( AudioEventInfo, m_soundsMorning ) },
{ "Attack", INI::parseSoundsList, NULL, offsetof( AudioEventInfo, m_attackSounds ) },
{ "Decay", INI::parseSoundsList, NULL, offsetof( AudioEventInfo, m_decaySounds ) },
{ "MinRange", INI::parseReal, NULL, offsetof( AudioEventInfo, m_minDistance) },
{ "MaxRange", INI::parseReal, NULL, offsetof( AudioEventInfo, m_maxDistance) },
{ "LowPassCutoff", INI::parsePercentToReal, NULL, offsetof( AudioEventInfo, m_lowPassFreq) },
}
theSoundTypeNames
char * theSoundTypeNames[]
Definition INIAudioEventInfo.cpp:192
theAudioPriorityNames
char * theAudioPriorityNames[]
Definition INIAudioEventInfo.cpp:182
theAudioControlNames
char * theAudioControlNames[]
Definition INIAudioEventInfo.cpp:206
NULL
#define NULL
Definition BaseType.h:92
INI::parseIndexList
static void parseIndexList(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:1399
INI::parsePercentToReal
static void parsePercentToReal(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:873
INI::parseInt
static void parseInt(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:538
INI::parseAsciiString
static void parseAsciiString(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:653
INI::parseReal
static void parseReal(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:558
INI::parseBitString32
static void parseBitString32(INI *ini, void *instance, void *store, const void *userData)
Definition INI.cpp:903
INI::parseSoundsList
static void parseSoundsList(INI *ini, void *instance, void *store, const void *)
Definition INI.cpp:1788
AudioEventInfo::m_attackSounds
std::vector< AsciiString > m_attackSounds
Definition AudioEventInfo.h:114
AudioEventInfo::m_decaySounds
std::vector< AsciiString > m_decaySounds
Definition AudioEventInfo.h:115
AudioEventInfo::m_soundsEvening
std::vector< AsciiString > m_soundsEvening
Definition AudioEventInfo.h:112
AudioEventInfo::m_priority
AudioPriority m_priority
Definition AudioEventInfo.h:105
AudioEventInfo::m_filename
AsciiString m_filename
Definition AudioEventInfo.h:93
AudioEventInfo::m_control
UnsignedInt m_control
Definition AudioEventInfo.h:107
AudioEventInfo::m_soundsMorning
std::vector< AsciiString > m_soundsMorning
Definition AudioEventInfo.h:109
AudioEventInfo::m_type
UnsignedInt m_type
Definition AudioEventInfo.h:106
AudioEventInfo::m_soundsNight
std::vector< AsciiString > m_soundsNight
Definition AudioEventInfo.h:111
AudioEventInfo::m_sounds
std::vector< AsciiString > m_sounds
Definition AudioEventInfo.h:110

the parse table for INI definition

Definition at line 130 of file AudioEventInfo.h.

◆ m_audioName

AsciiString AudioEventInfo::m_audioName

Definition at line 92 of file AudioEventInfo.h.

◆ m_control

UnsignedInt AudioEventInfo::m_control

Definition at line 107 of file AudioEventInfo.h.

◆ m_decaySounds

std::vector<AsciiString> AudioEventInfo::m_decaySounds

Definition at line 115 of file AudioEventInfo.h.

◆ m_delayMax

Int AudioEventInfo::m_delayMax

Definition at line 101 of file AudioEventInfo.h.

◆ m_delayMin

Int AudioEventInfo::m_delayMin

Definition at line 100 of file AudioEventInfo.h.

◆ m_filename

AsciiString AudioEventInfo::m_filename

Definition at line 93 of file AudioEventInfo.h.

◆ m_limit

Int AudioEventInfo::m_limit

Definition at line 102 of file AudioEventInfo.h.

◆ m_loopCount

Int AudioEventInfo::m_loopCount

Definition at line 103 of file AudioEventInfo.h.

◆ m_lowPassFreq

Real AudioEventInfo::m_lowPassFreq

Definition at line 117 of file AudioEventInfo.h.

◆ m_maxDistance

Real AudioEventInfo::m_maxDistance

Definition at line 119 of file AudioEventInfo.h.

◆ m_minDistance

Real AudioEventInfo::m_minDistance

Definition at line 118 of file AudioEventInfo.h.

◆ m_minVolume

Real AudioEventInfo::m_minVolume

Definition at line 97 of file AudioEventInfo.h.

◆ m_pitchShiftMax

Real AudioEventInfo::m_pitchShiftMax

Definition at line 99 of file AudioEventInfo.h.

◆ m_pitchShiftMin

Real AudioEventInfo::m_pitchShiftMin

Definition at line 98 of file AudioEventInfo.h.

◆ m_priority

AudioPriority AudioEventInfo::m_priority

Definition at line 105 of file AudioEventInfo.h.

◆ m_sounds

std::vector<AsciiString> AudioEventInfo::m_sounds

Definition at line 110 of file AudioEventInfo.h.

◆ m_soundsEvening

std::vector<AsciiString> AudioEventInfo::m_soundsEvening

Definition at line 112 of file AudioEventInfo.h.

◆ m_soundsMorning

std::vector<AsciiString> AudioEventInfo::m_soundsMorning

Definition at line 109 of file AudioEventInfo.h.

◆ m_soundsNight

std::vector<AsciiString> AudioEventInfo::m_soundsNight

Definition at line 111 of file AudioEventInfo.h.

◆ m_soundType

AudioType AudioEventInfo::m_soundType

Definition at line 121 of file AudioEventInfo.h.

◆ m_type

UnsignedInt AudioEventInfo::m_type

Definition at line 106 of file AudioEventInfo.h.

◆ m_volume

Real AudioEventInfo::m_volume

Definition at line 95 of file AudioEventInfo.h.

◆ m_volumeShift

Real AudioEventInfo::m_volumeShift

Definition at line 96 of file AudioEventInfo.h.

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