OpenXcom  1.0
Open-source clone of the original X-Com
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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::map< int, std::string > * getSounds ()
 Gets the list of sounds defined by this mod. More...
 
int getModIndex ()
 get the mod index for this external sound set. More...
 

Detailed Description

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

Constructor & Destructor Documentation

OpenXcom::ExtraSounds::ExtraSounds ( )

Creates a blank external sound set.

Creates a blank set of extra sound data.

OpenXcom::ExtraSounds::~ExtraSounds ( )
virtual

Cleans up the external sound set.

Cleans up the extra sound set.

Member Function Documentation

int OpenXcom::ExtraSounds::getModIndex ( )

get 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.
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.
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.

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