#include <GameMusic.h>

Inherits MemoryPoolObject.

Public Member Functions
	MusicTrack ()

const FieldParse *	getFieldParse (void) const

Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Public Attributes
Int	index
	Track index.

AsciiString	name
	Logical name of track.

AsciiString	filename
	Filename with extension of music track.

Real	volume
	Mixing level for this track.

Bool	ambient
	Game info about this track(public)

MusicTrack *	next

MusicTrack *	prev

Static Public Attributes
static const FieldParse	m_musicTrackFieldParseTable []
	the parse table for INI definition

Additional Inherited Members
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()

void *	operator new (size_t s)

void	operator delete (void *p)

virtual MemoryPool *	getObjectMemoryPool ()=0

Detailed Description

The MusicTrack struct holds all information about a music track. Place data in TrackInfo that is useful to the game code in determining what tracks to play.

Definition at line 78 of file GameMusic.h.

Constructor & Destructor Documentation

◆ MusicTrack()

MusicTrack::MusicTrack ( )

Member Function Documentation

◆ getFieldParse()

const FieldParse * MusicTrack::getFieldParse ( void ) const

inline

Definition at line 88 of file GameMusic.h.

Member Data Documentation

◆ ambient

Bool MusicTrack::ambient

Game info about this track(public)

Definition at line 94 of file GameMusic.h.

◆ filename

AsciiString MusicTrack::filename

Filename with extension of music track.

Definition at line 92 of file GameMusic.h.

◆ index

Int MusicTrack::index

Track index.

Definition at line 90 of file GameMusic.h.

◆ m_musicTrackFieldParseTable

const FieldParse MusicTrack::m_musicTrackFieldParseTable

static

Initial value:

= 
{
 
    { "Filename",                               INI::parseAsciiString,                         NULL, offsetof( MusicTrack, filename ) },
    { "Volume",                                 INI::parsePercentToReal,                     NULL, offsetof( MusicTrack, volume ) },
    { "Ambient",                                INI::parseBool,                                           NULL, offsetof( MusicTrack, ambient ) },
    { NULL,                                         NULL,                                                               NULL, 0 },
}

the parse table for INI definition

The INI data fields for music tracks

Definition at line 79 of file GameMusic.h.

◆ name

AsciiString MusicTrack::name

Logical name of track.

Definition at line 91 of file GameMusic.h.

◆ next

MusicTrack* MusicTrack::next

Definition at line 96 of file GameMusic.h.

◆ prev

MusicTrack* MusicTrack::prev

Definition at line 97 of file GameMusic.h.

◆ volume

Real MusicTrack::volume

Mixing level for this track.

Definition at line 93 of file GameMusic.h.

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

Code/GameEngine/Include/Common/GameMusic.h
Code/GameEngine/Source/Common/Audio/GameMusic.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members