GameFile class Reference Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

GameFile Class Reference

#include <Ogfile.h>

List of all members.

Public Methods

char * get_save_name ()

int save_game (char *=NULL)

int load_game (char *=NULL)

int save_express_game (char *=NULL)

int load_express_game (char *=NULL)

void set_file_name ()

int validate_header ()

Public Attributes

size_t class_size

char file_name [MAX_PATH+1]

char player_name [PLAYER_NAME_LEN]

int game_date

FILETIME file_date

int school_type

int game_speed

Static Public Attributes

File * file_ptr

char last_read_success_flag = 0

Detailed Description

Class for saving/retrieving complete game state to/from a file. Games are saved to individual files with a .sav extension in the current directory.

Definition at line 46 of file Ogfile.h.

Member Function Documentation

char * GameFile::get_save_name ( )

Definition at line 387 of file Ogfile.cpp.

int GameFile::load_express_game ( char * fileName = NULL )

Restore a game from file
Return : 1 - file read successfully 0 - not successful -1 - incorrect game data version error
Definition at line 239 of file OGFILE2.CPP.
References CURSOR_WAITING, and NULL.

int GameFile::load_game ( char * fileName = NULL )

return : <int> 1 - loaded successfully. 0 - not loaded. -1 - error and partially loaded
Definition at line 116 of file Ogfile.cpp.
References CURSOR_WAITING, and NULL.

int GameFile::save_express_game ( char * fileName = NULL )

Save a game to file
Return : 1 - file written successfully 0 - not successful
Definition at line 142 of file OGFILE2.CPP.
References NULL.

int GameFile::save_game ( char * fileName = NULL )

return : <int> 1 - saved successfully. 0 - not saved.
Definition at line 29 of file Ogfile.cpp.
References NULL.

void GameFile::set_file_name ( )

Set the game file name of current save game, called by GameFile::save_game().
e.g. ENLI_001.SAV - the first saved game of the group "Enlight Enterprise"
Definition at line 225 of file Ogfile.cpp.

int GameFile::validate_header ( )

Definition at line 379 of file Ogfile.cpp.
References class_size.

Member Data Documentation

size_t GameFile::class_size

Definition at line 50 of file Ogfile.h.
Referenced by validate_header().

FILETIME GameFile::file_date

Definition at line 57 of file Ogfile.h.

char GameFile::file_name[MAX_PATH+1]

Definition at line 51 of file Ogfile.h.

File * GameFile::file_ptr [static]

Definition at line 132 of file OGFILE2.CPP.

int GameFile::game_date

Definition at line 56 of file Ogfile.h.

int GameFile::game_speed

Definition at line 64 of file Ogfile.h.

char GameFile::last_read_success_flag = 0 [static]

Definition at line 133 of file OGFILE2.CPP.

char GameFile::player_name[PLAYER_NAME_LEN]

Definition at line 54 of file Ogfile.h.

int GameFile::school_type

Definition at line 58 of file Ogfile.h.

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

Generated on Fri Aug 23 01:39:12 2002 for VirtualU by

1.2.17