OpenXcom  1.0
Open-source clone of the original X-Com
Public Member Functions | List of all members
OpenXcom::ExtraSounds Class Reference

For adding a set of extra sound data to the game. More...

#include <ExtraSounds.h>

Public Member Functions

 ExtraSounds ()
 Creates a blank external sound set. More...
 
virtual ~ExtraSounds ()
 Cleans up the external sound set. More...
 
void load (const YAML::Node &node, int modIndex)
 Loads the data from yaml. More...
 
std::string getType () const
 Gets the sound's type. More...
 
std::map< int, std::string > * getSounds ()
 Gets the list of sounds defined by this mod. More...
 
int getModIndex () const
 Gets the mod index for this external sound set. More...
 
SoundSetloadSoundSet (SoundSet *set) const
 Load the external sound into a set. More...
 

Detailed Description

For adding a set of extra sound data to the game.

Constructor & Destructor Documentation

◆ ExtraSounds()

OpenXcom::ExtraSounds::ExtraSounds ( )

Creates a blank external sound set.

Creates a blank set of extra sound data.

◆ ~ExtraSounds()

OpenXcom::ExtraSounds::~ExtraSounds ( )
virtual

Cleans up the external sound set.

Cleans up the extra sound set.

Member Function Documentation

◆ getModIndex()

int OpenXcom::ExtraSounds::getModIndex ( ) const

Gets the mod index for this external sound set.

Gets the mod index for this external sounds set.

Returns
The mod index for this external sounds set.

◆ getSounds()

std::map< int, std::string > * OpenXcom::ExtraSounds::getSounds ( )

Gets the list of sounds defined by this mod.

Returns
The list of sounds defined my this mod.

◆ getType()

std::string OpenXcom::ExtraSounds::getType ( ) const

Gets the sound's type.

Gets the filename that this sound set represents.

Returns
The sound name.

◆ load()

void OpenXcom::ExtraSounds::load ( const YAML::Node &  node,
int  modIndex 
)

Loads the data from yaml.

Loads the extra sound set from YAML.

Parameters
nodeYAML node.
modIndexThe internal index of the associated mod.

◆ loadSoundSet()

SoundSet * OpenXcom::ExtraSounds::loadSoundSet ( SoundSet set) const

Load the external sound into a set.

Loads the external sounds into a new or existing soundset.

Parameters
setExisting soundset.
Returns
New soundset.

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