The current map's audio: which track plays, and a couple of music flags. More...

#include <areaaudio.h>

Inheritance diagram for AreaAudio:

Collaboration diagram for AreaAudio:

Public Member Functions
	AreaAudio (SaveFile *saveFile=nullptr)
	< Playing track id.
virtual	~AreaAudio ()
void	load (SaveFile *saveFile=nullptr)
	Expand audio settings from the save.
void	save (SaveFile *saveFile)
	Flatten audio settings to the save.
protected::void	musicIDChanged ()
void	musicBankChanged ()
void	noAudioFadeoutChanged ()
void	preventMusicChangeChanged ()
void	reset ()
	Blank audio settings.
void	randomize ()
	Randomize the track.
void	setTo (MapDBEntry *map)
	Set music to `map's` default.

Public Attributes
int	musicID
int	musicBank
bool	noAudioFadeout
bool	preventMusicChange

Detailed Description

The current map's audio: which track plays, and a couple of music flags.

Holds the musicID / musicBank that select the playing track, plus noAudioFadeout and preventMusicChange behaviour flags. Standard expanded-node convention (see SaveFileExpanded); setTo() pulls the right music for a chosen map.

See also: Area (container), MapDBEntry.

Definition at line 34 of file areaaudio.h.

Constructor & Destructor Documentation

◆ AreaAudio()

AreaAudio::AreaAudio ( SaveFile * saveFile = nullptr )

< Playing track id.

Bank the track lives in. Skip the audio fade-out. Lock the current music.

Definition at line 31 of file areaaudio.cpp.

References load().

◆ ~AreaAudio()

AreaAudio::~AreaAudio ( )

virtual

Definition at line 36 of file areaaudio.cpp.

Member Function Documentation

◆ load()

void AreaAudio::load ( SaveFile * saveFile = nullptr )

Expand audio settings from the save.

Definition at line 38 of file areaaudio.cpp.

References musicBank, musicBankChanged(), musicID, musicIDChanged(), noAudioFadeout, noAudioFadeoutChanged(), preventMusicChange, preventMusicChangeChanged(), reset(), and SaveFile::toolset.

Referenced by AreaAudio().

◆ musicBankChanged()

void AreaAudio::musicBankChanged ( )

Referenced by load(), randomize(), reset(), and setTo().

◆ musicIDChanged()

protected::void AreaAudio::musicIDChanged ( )

Referenced by load(), randomize(), reset(), and setTo().

◆ noAudioFadeoutChanged()

void AreaAudio::noAudioFadeoutChanged ( )

Referenced by load(), and reset().

◆ preventMusicChangeChanged()

void AreaAudio::preventMusicChangeChanged ( )

References randomize(), reset(), and setTo().

Referenced by load(), and reset().

◆ randomize()

void AreaAudio::randomize ( )

Randomize the track.

Definition at line 84 of file areaaudio.cpp.

References MusicDB::getStore(), MusicDB::inst(), Random::inst(), musicBank, musicBankChanged(), musicID, musicIDChanged(), and reset().

Referenced by preventMusicChangeChanged().

◆ reset()

void AreaAudio::reset ( )

Blank audio settings.

Definition at line 69 of file areaaudio.cpp.

References musicBank, musicBankChanged(), musicID, musicIDChanged(), noAudioFadeout, noAudioFadeoutChanged(), preventMusicChange, and preventMusicChangeChanged().

Referenced by load(), preventMusicChangeChanged(), randomize(), and setTo().

◆ save()

void AreaAudio::save ( SaveFile * saveFile )

Flatten audio settings to the save.

Definition at line 59 of file areaaudio.cpp.

References musicBank, musicID, noAudioFadeout, preventMusicChange, SaveFileToolset::setByte(), and SaveFile::toolset.

◆ setTo()

void AreaAudio::setTo ( MapDBEntry * map )

Set music to map's default.

Definition at line 99 of file areaaudio.cpp.

References MusicDBEntry::bank, MapDBEntry::getToMusic(), MusicDBEntry::id, musicBank, musicBankChanged(), musicID, musicIDChanged(), and reset().

Referenced by preventMusicChangeChanged().

Member Data Documentation

◆ musicBank

int AreaAudio::musicBank

See also: musicBank property.

Definition at line 63 of file areaaudio.h.

Referenced by load(), randomize(), reset(), save(), and setTo().

◆ musicID

int AreaAudio::musicID

See also: musicID property.

Definition at line 62 of file areaaudio.h.

Referenced by load(), randomize(), reset(), save(), and setTo().

◆ noAudioFadeout

bool AreaAudio::noAudioFadeout

See also: noAudioFadeout property.

Definition at line 64 of file areaaudio.h.

Referenced by load(), reset(), and save().

◆ preventMusicChange

bool AreaAudio::preventMusicChange

See also: preventMusicChange property.

Definition at line 65 of file areaaudio.h.