athena::ZQuestFile Class Reference

ZQuestFile is an export format for save data. More...

#include <ZQuestFile.hpp>

Inheritance diagram for athena::ZQuestFile:

Collaboration diagram for athena::ZQuestFile:

Public Types
enum	Game {   NoGame, LoZ, AoL, ALttP,   LA, OoT, OoT3D, MM,   OoS, OoA, FS, WW,   FSA, MC, TP, PH,   ST, SS, ALBW, GameCount }
	The list of games currently supported by ZQuest. More...

Public Member Functions
	ZQuestFile ()
	ZQuest.
	ZQuestFile (Game game, Endian endian, std::unique_ptr< atUint8[]> &&data, atUint32 length, const std::string &gameString=std::string())
	ZQuest. More...
void	setGame (Game game)
	setGame More...
Game	game () const
	game More...
void	setEndian (Endian endian)
	setEndian More...
Endian	endian () const
	endian More...
void	setData (std::unique_ptr< atUint8[]> &&data, atUint32 length)
	setData More...
atUint8 *	data () const
	data More...
atUint32	length () const
	length More...
void	setGameString (const std::string &gameString)
std::string	gameString () const
	gameString More...

Static Public Member Functions
static const std::vector< std::string >	gameStringList ()

Static Public Attributes
static const atUint32	Major
	The current major version of the ZQuest format.
static const atUint32	Minor
	The current minor version of the ZQuest format.
static const atUint32	Revision
	The current revision of the ZQuest format.
static const atUint32	Version
	The current version of the ZQuest format.
static const atUint32	Magic
	The magic number used to identify the file e.g. "ZQS1".

Protected Attributes
Game	m_game
std::string	m_gameString
Endian	m_endian
std::unique_ptr< atUint8[]>	m_data
atUint32	m_length

Detailed Description

ZQuestFile is an export format for save data.

Definition at line 34 of file ZQuestFile.hpp.

Member Enumeration Documentation

enum athena::ZQuestFile::Game

The list of games currently supported by ZQuest.

Enumerator
NoGame	None or Unsupported.
LoZ	Legend of Zelda.
AoL	Adventure of Link.
ALttP	A Link to the Past.
LA	Links Awakening.
OoT	Ocarin of Time.
OoT3D	Ocarina of Time 3D.
MM	Majora's Mask.
OoS	Oracle of Season.
OoA	Oracle of Ages.
FS	Four Swords.
WW	Wind Waker.
FSA	Four Swords Adventures.
MC	Minish Cap.
TP	Twilight Princess.
PH	Phantom Hourglass.
ST	Spirit Tracks.
SS	Skyward Sword.
ALBW	A Link Between Worlds.
GameCount	Total number of supported games.

Definition at line 63 of file ZQuestFile.hpp.

Constructor & Destructor Documentation

athena::ZQuestFile::ZQuestFile	(	Game	game,
		Endian	endian,
		std::unique_ptr< atUint8[]> &&	data,
		atUint32	length,
		const std::string &	gameString = std::string()
	)

ZQuest.

Parameters

game
endian
data
length

Member Function Documentation

atUint8* athena::ZQuestFile::data

(

)

const

data

Returns

Endian athena::ZQuestFile::endian

(

)

const

endian

Returns

Game athena::ZQuestFile::game

(

)

const

game

Returns

std::string athena::ZQuestFile::gameString

(

)

const

gameString

Returns

atUint32 athena::ZQuestFile::length

(

)

const

length

Returns

void athena::ZQuestFile::setData	(	std::unique_ptr< atUint8[]> &&	data,
		atUint32	length
	)

setData

Parameters

data	The data to assign
length	The length of the data

void athena::ZQuestFile::setEndian

(

Endian

endian

)

setEndian

Parameters

endian

void athena::ZQuestFile::setGame

(

Game

game

)

setGame

Parameters

game

---

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

• include/athena/ZQuestFile.hpp