SoundEventBase Class Reference

Collaboration diagram for SoundEventBase:

Private Member Functions
void	~SoundEventBase ()
bool	IsSkipForControlled ()
void	Tick ()
bool	IsSoundCallbackExist ()
bool	IsDestroyRequested ()
bool	CanPlay ()
bool	Play ()
void	OnPlay (PlayerBase player)
void	Stop ()
int	GetSoundEventID ()
int	GetSoundEventType ()
AbstractWave	GetSoundSetCallback ()

Private Attributes
AbstractWave	m_SoundSetCallback
int	m_Type
int	m_ID
int	m_SoundVoiceAnimEventClassID
bool	m_RequestDestroy
string	m_SoundSetNameRoot
bool	m_SkipForControlledCharacter
int	m_Param

Detailed Description

Definition at line 1 of file SoundEvents.c.

Constructor & Destructor Documentation

~SoundEventBase()

void SoundEventBase::~SoundEventBase ( )

inlineprivate

Definition at line 13 of file SoundEvents.c.

  {
    if (m_SoundSetCallback) m_SoundSetCallback.Stop();
  }

References m_SoundSetCallback, and AbstractWave::Stop().

Member Function Documentation

CanPlay()

bool SoundEventBase::CanPlay ( )

inlineprivate

Definition at line 43 of file SoundEvents.c.

  {
    return true;
  }

GetSoundEventID()

int SoundEventBase::GetSoundEventID ( )

inlineprivate

Definition at line 61 of file SoundEvents.c.

  {
    return m_ID;
  }

References m_ID.

GetSoundEventType()

int SoundEventBase::GetSoundEventType ( )

inlineprivate

Definition at line 66 of file SoundEvents.c.

  {
    return m_Type;
  }

References m_Type.

GetSoundSetCallback()

AbstractWave SoundEventBase::GetSoundSetCallback ( )

inlineprivate

Definition at line 71 of file SoundEvents.c.

  {
    return m_SoundSetCallback;
  }

References m_SoundSetCallback.

IsDestroyRequested()

bool SoundEventBase::IsDestroyRequested ( )

inlineprivate

Definition at line 38 of file SoundEvents.c.

  {
    return m_RequestDestroy;
  }

References m_RequestDestroy.

IsSkipForControlled()

bool SoundEventBase::IsSkipForControlled ( )

inlineprivate

Definition at line 19 of file SoundEvents.c.

  {
    return m_SkipForControlledCharacter;
  }

References m_SkipForControlledCharacter.

IsSoundCallbackExist()

bool SoundEventBase::IsSoundCallbackExist ( )

inlineprivate

Definition at line 30 of file SoundEvents.c.

  {
    if (m_SoundSetCallback)
      return true;
 
    return false;
  }

References m_SoundSetCallback.

OnPlay()

void SoundEventBase::OnPlay ( PlayerBase player )

private

Play()

bool SoundEventBase::Play ( )

inlineprivate

Definition at line 48 of file SoundEvents.c.

  {
    return true;
  }

Stop()

void SoundEventBase::Stop ( )

inlineprivate

Definition at line 55 of file SoundEvents.c.

  {
    if (m_SoundSetCallback)
      m_SoundSetCallback.Stop();
  }

References m_SoundSetCallback, and AbstractWave::Stop().

Tick()

void SoundEventBase::Tick ( )

inlineprivate

Definition at line 24 of file SoundEvents.c.

  {
    if (!m_SoundSetCallback)
      m_RequestDestroy = true;
  }

References m_RequestDestroy, and m_SoundSetCallback.

Member Data Documentation

m_ID

int SoundEventBase::m_ID

private

Definition at line 5 of file SoundEvents.c.

Referenced by GetSoundEventID().

m_Param

int SoundEventBase::m_Param

private

Definition at line 10 of file SoundEvents.c.

m_RequestDestroy

bool SoundEventBase::m_RequestDestroy

private

Definition at line 7 of file SoundEvents.c.

Referenced by IsDestroyRequested(), and Tick().

m_SkipForControlledCharacter

bool SoundEventBase::m_SkipForControlledCharacter

private

Definition at line 9 of file SoundEvents.c.

Referenced by IsSkipForControlled().

m_SoundSetCallback

AbstractWave SoundEventBase::m_SoundSetCallback

private

Definition at line 3 of file SoundEvents.c.

Referenced by GetSoundSetCallback(), IsSoundCallbackExist(), Stop(), Tick(), and ~SoundEventBase().

m_SoundSetNameRoot

string SoundEventBase::m_SoundSetNameRoot

private

Definition at line 8 of file SoundEvents.c.

m_SoundVoiceAnimEventClassID

int SoundEventBase::m_SoundVoiceAnimEventClassID

private

Definition at line 6 of file SoundEvents.c.

m_Type

int SoundEventBase::m_Type

private

Definition at line 4 of file SoundEvents.c.

Referenced by GetSoundEventType().

---

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

• scripts/4_World/Classes/SoundEvents/SoundEvents.c