RPG::SceneFile Class Reference

The Save/Load scene. More...

#include <SceneFile.h>

Public Member Functions
void	saveFile (int saveId)
	Built-in RM2k3 function to save the current game's data to a file.
void	loadFile (int saveId)
	DynRPG function to load a particular save file, and properly draw the resulting scene.
void	loadFileUnpatch ()
	DynRPG function to finish loading a particular save file.
void	loadFileSimple (int saveId)
	Built-in RM2k3 function to load a particular save file, but does NOT redraw the scene afterwards.

Static Public Member Functions
static bool	doesSaveExist (int saveId)
	Built-in RM2k3 function to check whether a save file exists or not.

Public Attributes
void *	AuroraBoard1
	Not even a little bit implemented...
void *	AuroraBoard2
	Not even a little bit implemented...
bool	initialized
	Has the enter hero name scene initialized?
Window *	winInfo
	The info window (very top)
WindowSaveFile *	winFile [15]
	The actual file windows.
FileSceneMode_T	mode
	The mode of the scene (save or load)
bool	fromMenu
	Set to true to return to the main menu.
int	timesScrolled
	Times scrolled down?
int	cursorPosition
	The position of the cursor.
int	timer
	Some kind of timer?
int	scrollCounter
	For scrolling the windows?

Detailed Description

The Save/Load scene.

See also

RPG::saveLoad

Member Function Documentation

doesSaveExist()

static bool RPG::SceneFile::doesSaveExist ( int saveId )

static

Built-in RM2k3 function to check whether a save file exists or not.

Parameters

saveId

The save ID to check for (can be greater than 15)

Returns

true of the save exists, false otherwise

loadFile()

void RPG::SceneFile::loadFile

(

int

saveId

)

DynRPG function to load a particular save file, and properly draw the resulting scene.

Parameters

saveId

The save ID to check for (can be greater than 15)

Note

loadFileUnpatch() must be called onLoadGame after this is called in the same plugin Can be called outside of the actual File scene.

loadFileSimple()

void RPG::SceneFile::loadFileSimple

(

int

saveId

)

Built-in RM2k3 function to load a particular save file, but does NOT redraw the scene afterwards.

Parameters

saveId

The save ID to check for (can be greater than 15)

Note

Can be called outside of the actual File scene. Music, screen and events do not get updated to the newly loaded file. Starts player from FileScene instead of the Map.

Warning

Incompatible with Cherry's SaveLoad patch. Experimental!

loadFileUnpatch()

void RPG::SceneFile::loadFileUnpatch

(

)

DynRPG function to finish loading a particular save file.

Precondition

loadFile(int) must have been called prior to this being called

Note

this function must be called onLoadGame in the plugin that calls loadFile(int)

Warning

It's not recommended to use this for anything else! Please check if SaveXX.lsd exists before loading.

saveFile()

void RPG::SceneFile::saveFile

(

int

saveId

)

Built-in RM2k3 function to save the current game's data to a file.

Parameters

saveId

The save ID to check for (can be greater than 15)

Note

Can be called outside of the actual File scene. Menus, fades, transitions must be handled separately by the plugin!

---

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

• include/DynRPG/SceneFile.h