PC Stable Documentation
 
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
SoundEvents.c File Reference

Data Structures

class  SoundEventBase
 

Functions

class SoundEventBase GetSoundEventType (int id)
 
void ~SoundEventBase ()
 
bool IsSkipForControlled ()
 
void Tick ()
 
bool IsSoundCallbackExist ()
 
bool IsDestroyRequested ()
 
bool CanPlay ()
 
bool Play ()
 
void OnPlay (PlayerBase player)
 
void Stop ()
 Stops all elements this effect consists of.
 
int GetSoundEventID ()
 
int GetSoundEventType ()
 
AbstractWave GetSoundSetCallback ()
 
bool PlayRequest (EPlayerSoundEventID id, bool sent_from_server=false)
 
bool PlayRequestEx (EPlayerSoundEventID id, bool sent_from_server=false, int param=0)
 
int GetCurrentStateEventID ()
 
int GetCurrentStateEventType ()
 

Variables

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

Function Documentation

◆ CanPlay()

bool CanPlay ( )

◆ GetCurrentStateEventID()

int GetCurrentStateEventID ( )

◆ GetCurrentStateEventType()

int GetCurrentStateEventType ( )

◆ GetSoundEventID()

int GetSoundEventID ( )

◆ GetSoundEventType() [1/2]

int GetSoundEventType ( )

◆ GetSoundEventType() [2/2]

class SoundEventBase GetSoundEventType ( int  id)

◆ GetSoundSetCallback()

AbstractWave GetSoundSetCallback ( )

◆ IsDestroyRequested()

bool IsDestroyRequested ( )

◆ IsSkipForControlled()

bool IsSkipForControlled ( )

◆ IsSoundCallbackExist()

bool IsSoundCallbackExist ( )

Referenced by IsFinished().

◆ OnPlay()

void OnPlay ( PlayerBase  player)

!! beware of the ifdef above , most likely you want to put your code above it, otherwise it might not get executed !!!

◆ PlayRequest()

bool PlayRequest ( EPlayerSoundEventID  id,
bool  sent_from_server = false 
)

◆ PlayRequestEx()

bool PlayRequestEx ( EPlayerSoundEventID  id,
bool  sent_from_server = false,
int  param = 0 
)

◆ Tick()

void Tick ( )

◆ ~SoundEventBase()

void ~SoundEventBase ( )

Variable Documentation

◆ m_ID

int m_ID

◆ m_Param

int m_Param

Referenced by InitEx().

◆ m_RequestDestroy

bool m_RequestDestroy

◆ m_SkipForControlledCharacter

bool m_SkipForControlledCharacter

◆ m_SoundSetCallback

◆ m_SoundSetNameRoot

◆ m_SoundVoiceAnimEventClassID

◆ m_Type

int m_Type