game_save

game_save(STRING* name,var number,var mode)

Saves the current state of the application in a .sav file the save_dir folder, for later resuming the game at the current position.

Parameters:

name

Name of the file to be saved, without extension and path

num

STRING* or char*, number of up to three digits which will be added to the file name. The extension ".sav " will be added automatically.

mode

Save mode, can be combined by adding or subtracting the following flags:

SV_VARS	saves all the global user defined variables except var_info and var_nsave variables (C-Script) resp. except variables that end with _i or _n (lite-C).
SV_INFO	saves all global var_info variables (C-Script) resp. all global variables that end with _i (lite-C).
SV_SYS	saves all predefined engine variables.
SV_STRINGS	saves all modified strings.
SV_POINTERS	saves all pointers (C-Script only). In lite-C, use handles for saving references to objects.
SV_BMAPS	saves all bmaps modified by bmap_for_screen. Other bmap manipulations are not saved.
SV_KEYS	saves all functions assigned to keyboard, mouse, joystick, or other events.
SV_FUNCTIONS	saves the state of all currently running functions, and all local variables.
SV_PANELS	saves all panels and texts.
SV_VIEWS	saves all views.
SV_SKY	saves all sky entities.
SV_LEVEL	saves the current level and all dynamic level entities. The physics registrations and velocities, the orientations of model bones, and the deformation of entity and terrain meshes is not saved.
SV_MATERIAL	saves all materials. Effect code is not saved.
SV_PATH	saves all paths changed by path_setnode or path_setedge
SV_STRUCT	saves all memory areas marked by add_struct.
SV_ALL	saves everything.

Returns:

> 0 - successfully saved, <= 0 - operation failed.

Speed:

Slow

Remarks:

Objects are stored by their indices. Therefore levels, scripts, and objects must not change between game_save and game_load, with exception of level entities. All .._create and .._remove functions, except for creating and removing level entities, must be executed before the first game_save or game_load call. Thus, the number of engine objects like panels or texts must be the same at save and load time. When the script was changed in any way, or when the number of objects is different, game_load will fail.
With SV_FUNCTIONS, all functions resume their operation at their current wait() positions, with the exception of the current process that called the game_save function. This process is not resumed, and thus should not contain a wait() call.
All local variables and the global my and you pointers are saved with functions. Local pointers will normally not point to the same object after loading; therefore local pointers to engine objects, such as entities or bmaps, should be stored in a handle for retrieving them when a save/load operation occurred during the wait() cycle. An example can be found under ptr_for_handle().
Event assignments are only saved for script functions. External language functions must be assigned to events before the first game_save instruction, and not be changed afterwards.
The orientation of model bones is not saved. For saving the state of a model's skeleton, use entity skills for the animation percentage that you are passing to ent_animate . Entity skills are automatically saved.
The status of particles is not saved. Therefore all particles should have a limited lifespan.
The deformation of entity and terrain meshes by vec_to_mesh is not saved. The deformation should be stored in variable arrays when necessary.
For not unnecessarily inflating the save file, SV_STRINGS only saves modified strings. If you modify a string after game_save, it was not saved, and is consequently not overwritten to its initial content on game_load. So modify all strings that should be saved and loaded before game_save; for instance set them to their initial content.
The content of the .sav file is compressed. It can not be read out of the file with any file commands other than game_load.

Example: