Open source remastering of the Freespace 2 engine
mainhallmenu.h File Reference

Go to the source code of this file.


class  main_hall_region
class  main_hall_defines


void main_hall_init (const SCP_string &main_hall_name)
void main_hall_table_init ()
void parse_main_hall_table (const char *filename)
void main_hall_do (float frametime)
void main_hall_close ()
void main_hall_start_music ()
void main_hall_stop_music (bool fade)
int main_hall_get_music_index (int main_hall_num)
main_hall_definesmain_hall_get_pointer (const SCP_string &name_to_find)
int main_hall_get_index (const SCP_string &name_to_find)
int main_hall_get_resolution_index (int main_hall_num)
void main_hall_get_name (SCP_string &name, unsigned int index)
int main_hall_get_overlay_id ()
int main_hall_get_overlay_resolution_index ()
int main_hall_id ()
int main_hall_is_vasudan ()
void main_hall_start_ambient ()
void main_hall_stop_ambient ()
void main_hall_reset_ambient_vol ()
void main_hall_do_multi_ready ()
void main_hall_vasudan_funny ()
void main_hall_pause ()
void main_hall_unpause ()


SCP_vector< SCP_vector< main_hall_defines > > Main_hall_defines

Function Documentation

void main_hall_close ( )

Close the main hall proper

Definition at line 1027 of file mainhallmenu.cpp.

void main_hall_do ( float  frametime)

Do a frame for the main hall

frametimeAnimation frame time

Definition at line 653 of file mainhallmenu.cpp.

void main_hall_do_multi_ready ( )

Definition at line 307 of file mainhallmenu.cpp.

int main_hall_get_index ( const SCP_string name_to_find)

CommanderDJ - finds the mainhall struct whose name is equal to the passed string

name_to_findName of mainhall we're searching for
index of mainhall in Main_hall_defines if one with a matching name is found
-1 otherwise

Definition at line 1815 of file mainhallmenu.cpp.

int main_hall_get_music_index ( int  main_hall_num)

Return music index

main_hall_numIndex to seek
Index into spooled music

Definition at line 1100 of file mainhallmenu.cpp.

void main_hall_get_name ( SCP_string name,
unsigned int  index 

Definition at line 1841 of file mainhallmenu.cpp.

int main_hall_get_overlay_id ( )

Definition at line 1850 of file mainhallmenu.cpp.

int main_hall_get_overlay_resolution_index ( )

Definition at line 1859 of file mainhallmenu.cpp.

main_hall_defines* main_hall_get_pointer ( const SCP_string name_to_find)

CommanderDJ - finds the mainhall struct whose name is equal to the passed string

name_to_findName of mainhall we're searching for
pointer to mainhall if one with a matching name is found
NULL otherwise

Definition at line 1795 of file mainhallmenu.cpp.

int main_hall_get_resolution_index ( int  main_hall_num)

Definition at line 1827 of file mainhallmenu.cpp.

int main_hall_id ( )

Definition at line 1869 of file mainhallmenu.cpp.

void main_hall_init ( const SCP_string main_hall_name)

Initialize the main hall proper

main_hall_nameName of main hall to initialise

Definition at line 407 of file mainhallmenu.cpp.

int main_hall_is_vasudan ( )

Lookup if Vasudan main hall, based upon music name

1 if true, 0 if false

Definition at line 2510 of file mainhallmenu.cpp.

void main_hall_pause ( )

Silence sounds on mainhall if we hit a pause mode (ie. lost window focus, minimized, etc)

Definition at line 2519 of file mainhallmenu.cpp.

void main_hall_reset_ambient_vol ( )

Reset the volume of the looping ambient sound.

This is called from the options screen when the looping ambient sound might be playing.

Definition at line 1671 of file mainhallmenu.cpp.

void main_hall_start_ambient ( )

Start a looping ambient sound for main hall

Definition at line 1634 of file mainhallmenu.cpp.

void main_hall_start_music ( )

Start the main hall music playing

Definition at line 1129 of file mainhallmenu.cpp.

void main_hall_stop_ambient ( )

Stop a looping ambient sound for the main hall

Definition at line 1658 of file mainhallmenu.cpp.

void main_hall_stop_music ( bool  fade)

Stop the main hall music

Definition at line 1169 of file mainhallmenu.cpp.

void main_hall_table_init ( )

Read in main hall table

Definition at line 2051 of file mainhallmenu.cpp.

void main_hall_unpause ( )

Recover from a paused state (ie. lost window focus, minimized, etc)

Definition at line 2535 of file mainhallmenu.cpp.

void main_hall_vasudan_funny ( )

Make the vasudan main hall funny

Definition at line 2501 of file mainhallmenu.cpp.

void parse_main_hall_table ( const char *  filename)

the reason that this is an error is that even if we were to change the names to match it is very likely the user would get the wrong mainhall loaded since their campaign files may still refer to the entry with the incorrect name

Definition at line 2066 of file mainhallmenu.cpp.

Variable Documentation

SCP_vector< SCP_vector<main_hall_defines> > Main_hall_defines

Definition at line 60 of file mainhallmenu.cpp.