Z2SoundHandles Class Reference

#include <Z2SoundHandles.h>

Inheritance diagram for Z2SoundHandles:

Collaboration diagram for Z2SoundHandles:

Public Member Functions
	Z2SoundHandles ()
	~Z2SoundHandles ()
void	initHandlesPool (u8 pNumHandles)
void	deleteHandlesPool ()
Z2SoundHandlePool *	getFreeHandle ()
Z2SoundHandlePool *	getLowPrioSound (JAISoundID pSoundId)
bool	isActive () const
Z2SoundHandlePool *	getHandleSoundID (JAISoundID pSoundId)
Z2SoundHandlePool *	getHandleUserData (u32 pUserData)
void	stopAllSounds (u32 fadeout)
void	stopSound (JAISoundID soundID, u32 param_1)
void	setPos (const JGeometry::TVec3< f32 > &pos)
int	getNumHandles () const
Z2SoundHandlePool *	getHandle (int index)

Private Attributes
u8	mNumHandles

Additional Inherited Members
Protected Member Functions inherited from JSUList< Z2SoundHandlePool >
	JSUList ()
	JSUList (bool init)
	~JSUList ()
bool	append (JSULink< Z2SoundHandlePool > *link)
bool	prepend (JSULink< Z2SoundHandlePool > *link)
bool	insert (JSULink< Z2SoundHandlePool > *before, JSULink< Z2SoundHandlePool > *link)
bool	remove (JSULink< Z2SoundHandlePool > *link)
JSULink< Z2SoundHandlePool > *	getFirst () const
JSULink< Z2SoundHandlePool > *	getLast () const
JSULink< Z2SoundHandlePool > *	getNth (int index)
JSULink< Z2SoundHandlePool > *	getEnd () const
u32	getNumLinks () const
Protected Member Functions inherited from JSUPtrList
	JSUPtrList ()
	JSUPtrList (bool init)
	~JSUPtrList ()
void	initiate ()
void	setFirst (JSUPtrLink *first)
bool	append (JSUPtrLink *ptr)
bool	prepend (JSUPtrLink *ptr)
bool	insert (JSUPtrLink *before, JSUPtrLink *ptr)
bool	remove (JSUPtrLink *ptr)
JSUPtrLink *	getNthLink (u32 i) const
JSUPtrLink *	getFirstLink () const
JSUPtrLink *	getLastLink () const
u32	getNumLinks () const

Constructor & Destructor Documentation

Z2SoundHandles()

Z2SoundHandles::Z2SoundHandles

(

)

~Z2SoundHandles()

Z2SoundHandles::~Z2SoundHandles

(

)

Member Function Documentation

deleteHandlesPool()

void Z2SoundHandles::deleteHandlesPool

(

)

getFreeHandle()

Z2SoundHandlePool * Z2SoundHandles::getFreeHandle

(

)

getHandle()

Z2SoundHandlePool * Z2SoundHandles::getHandle ( int  index )

inline

getHandleSoundID()

Z2SoundHandlePool * Z2SoundHandles::getHandleSoundID

(

JAISoundID

pSoundId

)

getHandleUserData()

Z2SoundHandlePool * Z2SoundHandles::getHandleUserData

(

u32

pUserData

)

getLowPrioSound()

Z2SoundHandlePool * Z2SoundHandles::getLowPrioSound

(

JAISoundID

pSoundId

)

getNumHandles()

int Z2SoundHandles::getNumHandles ( ) const

inline

initHandlesPool()

void Z2SoundHandles::initHandlesPool

(

u8

pNumHandles

)

isActive()

bool Z2SoundHandles::isActive

(

)

const

setPos()

void Z2SoundHandles::setPos

(

const JGeometry::TVec3< f32 > &

pos

)

stopAllSounds()

void Z2SoundHandles::stopAllSounds

(

u32

fadeout

)

@meme: explicit operator bool call required to match and be similar to CHN_debug; could more concisely write handle->isSoundAttached (for some reason cast-to-bool doesn't work?)

stopSound()

void Z2SoundHandles::stopSound ( JAISoundID  soundID, u32  param_1  )

inline

Member Data Documentation

mNumHandles

u8 Z2SoundHandles::mNumHandles

private

---

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

• include/Z2AudioLib/Z2SoundHandles.h
• src/Z2AudioLib/Z2SoundHandles.cpp