SuperTuxKart
Public Member Functions | Public Attributes | List of all members
SFXManager::SFXCommand Class Reference

Data structure for the queue, which stores a sfx and the command to execute for it. More...

Inheritance diagram for SFXManager::SFXCommand:
Inheritance graph
[legend]

Public Member Functions

 SFXCommand (SFXCommands command, SFXBase *base)
 
 SFXCommand (SFXCommands command, MusicInformation *mi)
 Constructor for music information commands. More...
 
 SFXCommand (SFXCommands command, MusicInformation *mi, float f)
 Constructor for music information commands that take a floating point parameter (which is stored in the X value of m_parameter). More...
 
 SFXCommand (SFXCommands command, SFXBase *base, float parameter)
 
 SFXCommand (SFXCommands command, SFXBase *base, const Vec3 &parameter)
 
 SFXCommand (SFXCommands command, SFXBase *base, float f, const Vec3 &parameter)
 Store a float and vec3 parameter. More...
 

Public Attributes

SFXBasem_sfx
 The sound effect for which the command should be executed. More...
 
SFXBufferm_buffer = NULL
 The sound buffer to play (null = no change)
 
MusicInformationm_music_information
 Stores music information for music commands. More...
 
SFXCommands m_command
 The command to execute. More...
 
Vec3 m_parameter
 Optional parameter for commands that need more input. More...
 

Detailed Description

Data structure for the queue, which stores a sfx and the command to execute for it.

Constructor & Destructor Documentation

◆ SFXCommand() [1/3]

SFXManager::SFXCommand::SFXCommand ( SFXCommands  command,
MusicInformation mi 
)
inline

Constructor for music information commands.

◆ SFXCommand() [2/3]

SFXManager::SFXCommand::SFXCommand ( SFXCommands  command,
MusicInformation mi,
float  f 
)
inline

Constructor for music information commands that take a floating point parameter (which is stored in the X value of m_parameter).

◆ SFXCommand() [3/3]

SFXManager::SFXCommand::SFXCommand ( SFXCommands  command,
SFXBase base,
float  f,
const Vec3 parameter 
)
inline

Store a float and vec3 parameter.

The float is stored as W component of the vector. A bit hacky, but this class is used very frequently, so should remain as small as possible).

Member Data Documentation

◆ m_command

SFXCommands SFXManager::SFXCommand::m_command

The command to execute.

◆ m_music_information

MusicInformation* SFXManager::SFXCommand::m_music_information

Stores music information for music commands.

◆ m_parameter

Vec3 SFXManager::SFXCommand::m_parameter

Optional parameter for commands that need more input.

Single floating point values are stored in the X component.

◆ m_sfx

SFXBase* SFXManager::SFXCommand::m_sfx

The sound effect for which the command should be executed.


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