RoR::SoundScriptTemplate Class Reference

#include <SoundScriptManager.h>

Inheritance diagram for RoR::SoundScriptTemplate:

Collaboration diagram for RoR::SoundScriptTemplate:

Public Member Functions
	SoundScriptTemplate (Ogre::String name, Ogre::String groupname, Ogre::String filename, bool baseTemplate)
virtual	~SoundScriptTemplate () override
int	getNumSounds ()
Ogre::String	getSoundName (int pos)
float	getSoundPitch (int pos)
Ogre::String	getStartSoundName ()
float	getStartSoundPitch ()
Ogre::String	getStopSoundName ()
float	getStopSoundPitch ()
Ogre::String	getName ()
Ogre::String	getFileName ()
Ogre::String	getGroupName ()
bool	isBaseTemplate ()
Public Member Functions inherited from RefCountingObject< SoundScriptTemplate >
	RefCountingObject ()
virtual	~RefCountingObject ()
void	AddRef ()
void	Release ()

Private Member Functions
int	parseModulation (Ogre::String str)
bool	setParameter (Ogre::StringVector vec)

Private Attributes
Ogre::String	name
Ogre::String	file_name
Ogre::String	group_name
bool	base_template
bool	has_start_sound
bool	has_stop_sound
bool	unpitchable
float	gain_multiplier
float	gain_offset
float	gain_square
int	gain_source
float	pitch_multiplier
float	pitch_offset
float	pitch_square
int	pitch_source
Ogre::String	sound_names [MAX_SOUNDS_PER_SCRIPT]
float	sound_pitches [MAX_SOUNDS_PER_SCRIPT]
Ogre::String	start_sound_name
float	start_sound_pitch
Ogre::String	stop_sound_name
float	stop_sound_pitch
int	trigger_source
int	free_sound

Friends
class	SoundScriptManager
class	SoundScriptInstance

Additional Inherited Members
Static Public Member Functions inherited from RefCountingObject< SoundScriptTemplate >
static void	RegisterRefCountingObject (AS_NAMESPACE_QUALIFIER asIScriptEngine *engine, const char *name)
Data Fields inherited from RefCountingObject< SoundScriptTemplate >
int	m_refcount
std::mutex	m_refcount_mtx

Detailed Description

Definition at line 176 of file SoundScriptManager.h.

Constructor & Destructor Documentation

SoundScriptTemplate()

SoundScriptTemplate::SoundScriptTemplate	(	Ogre::String	name,
		Ogre::String	groupname,
		Ogre::String	filename,
		bool	baseTemplate
	)

Definition at line 559 of file SoundScriptManager.cpp.

~SoundScriptTemplate()

virtual RoR::SoundScriptTemplate::~SoundScriptTemplate ( )

inlineoverridevirtual

Definition at line 184 of file SoundScriptManager.h.

Member Function Documentation

getFileName()

Ogre::String RoR::SoundScriptTemplate::getFileName ( )

inline

Definition at line 199 of file SoundScriptManager.h.

getGroupName()

Ogre::String RoR::SoundScriptTemplate::getGroupName ( )

inline

Definition at line 200 of file SoundScriptManager.h.

getName()

Ogre::String RoR::SoundScriptTemplate::getName ( )

inline

Definition at line 198 of file SoundScriptManager.h.

getNumSounds()

int RoR::SoundScriptTemplate::getNumSounds ( )

inline

Definition at line 187 of file SoundScriptManager.h.

getSoundName()

Ogre::String RoR::SoundScriptTemplate::getSoundName ( int  pos )

inline

Definition at line 188 of file SoundScriptManager.h.

getSoundPitch()

float RoR::SoundScriptTemplate::getSoundPitch ( int  pos )

inline

Definition at line 189 of file SoundScriptManager.h.

getStartSoundName()

Ogre::String RoR::SoundScriptTemplate::getStartSoundName ( )

inline

Definition at line 192 of file SoundScriptManager.h.

getStartSoundPitch()

float RoR::SoundScriptTemplate::getStartSoundPitch ( )

inline

Definition at line 193 of file SoundScriptManager.h.

getStopSoundName()

Ogre::String RoR::SoundScriptTemplate::getStopSoundName ( )

inline

Definition at line 194 of file SoundScriptManager.h.

getStopSoundPitch()

float RoR::SoundScriptTemplate::getStopSoundPitch ( )

inline

Definition at line 195 of file SoundScriptManager.h.

isBaseTemplate()

bool RoR::SoundScriptTemplate::isBaseTemplate ( )

inline

Definition at line 201 of file SoundScriptManager.h.

parseModulation()

int SoundScriptTemplate::parseModulation ( Ogre::String  str )

private

Definition at line 1023 of file SoundScriptManager.cpp.

Here is the caller graph for this function:

setParameter()

bool SoundScriptTemplate::setParameter ( Ogre::StringVector  vec )

private

Definition at line 582 of file SoundScriptManager.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

SoundScriptInstance

friend class SoundScriptInstance

friend

Definition at line 179 of file SoundScriptManager.h.

SoundScriptManager

friend class SoundScriptManager

friend

Definition at line 178 of file SoundScriptManager.h.

Field Documentation

base_template

bool RoR::SoundScriptTemplate::base_template

private

Definition at line 212 of file SoundScriptManager.h.

file_name

Ogre::String RoR::SoundScriptTemplate::file_name

private

Definition at line 209 of file SoundScriptManager.h.

free_sound

int RoR::SoundScriptTemplate::free_sound

private

Definition at line 235 of file SoundScriptManager.h.

gain_multiplier

float RoR::SoundScriptTemplate::gain_multiplier

private

Definition at line 217 of file SoundScriptManager.h.

gain_offset

float RoR::SoundScriptTemplate::gain_offset

private

Definition at line 218 of file SoundScriptManager.h.

gain_source

int RoR::SoundScriptTemplate::gain_source

private

Definition at line 220 of file SoundScriptManager.h.

gain_square

float RoR::SoundScriptTemplate::gain_square

private

Definition at line 219 of file SoundScriptManager.h.

group_name

Ogre::String RoR::SoundScriptTemplate::group_name

private

Definition at line 210 of file SoundScriptManager.h.

has_start_sound

bool RoR::SoundScriptTemplate::has_start_sound

private

Definition at line 213 of file SoundScriptManager.h.

has_stop_sound

bool RoR::SoundScriptTemplate::has_stop_sound

private

Definition at line 214 of file SoundScriptManager.h.

name

Ogre::String RoR::SoundScriptTemplate::name

private

Definition at line 208 of file SoundScriptManager.h.

pitch_multiplier

float RoR::SoundScriptTemplate::pitch_multiplier

private

Definition at line 222 of file SoundScriptManager.h.

pitch_offset

float RoR::SoundScriptTemplate::pitch_offset

private

Definition at line 223 of file SoundScriptManager.h.

pitch_source

int RoR::SoundScriptTemplate::pitch_source

private

Definition at line 225 of file SoundScriptManager.h.

pitch_square

float RoR::SoundScriptTemplate::pitch_square

private

Definition at line 224 of file SoundScriptManager.h.

sound_names

Ogre::String RoR::SoundScriptTemplate::sound_names[MAX_SOUNDS_PER_SCRIPT]

private

Definition at line 227 of file SoundScriptManager.h.

sound_pitches

float RoR::SoundScriptTemplate::sound_pitches[MAX_SOUNDS_PER_SCRIPT]

private

Definition at line 228 of file SoundScriptManager.h.

start_sound_name

Ogre::String RoR::SoundScriptTemplate::start_sound_name

private

Definition at line 229 of file SoundScriptManager.h.

start_sound_pitch

float RoR::SoundScriptTemplate::start_sound_pitch

private

Definition at line 230 of file SoundScriptManager.h.

stop_sound_name

Ogre::String RoR::SoundScriptTemplate::stop_sound_name

private

Definition at line 231 of file SoundScriptManager.h.

stop_sound_pitch

float RoR::SoundScriptTemplate::stop_sound_pitch

private

Definition at line 232 of file SoundScriptManager.h.

trigger_source

int RoR::SoundScriptTemplate::trigger_source

private

Definition at line 234 of file SoundScriptManager.h.

unpitchable

bool RoR::SoundScriptTemplate::unpitchable

private

Definition at line 215 of file SoundScriptManager.h.

---

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

• source/main/audio/SoundScriptManager.h
• source/main/audio/SoundScriptManager.cpp