Athena IO Library
athena::ALTTPFile Class Reference

A Link to the Past data container class class. More...

#include <ALTTPFile.hpp>

Collaboration diagram for athena::ALTTPFile:
Collaboration graph

Public Types

typedef std::vector< ALTTPQuest * >::iterator QuestIter
 Quest Iterator. More...
 

Public Member Functions

 ALTTPFile ()
 Default constructor. More...
 
 ALTTPFile (std::vector< ALTTPQuest * > questList, std::vector< ALTTPQuest * > backupList)
 Constructor. More...
 
void setQuest (atUint32 id, ALTTPQuest *val)
 Sets a quest at the given index. More...
 
std::vector< ALTTPQuest * > questList () const
 Returns the primary quest list. More...
 
ALTTPQuestquest (atUint32 id) const
 Returns a quest at the given index. More...
 
atUint32 questCount () const
 Returns the number of primary quests. More...
 

Detailed Description

A Link to the Past data container class class.

Contains all relevant data for an A Link to the Past SRM file.

Definition at line 18 of file ALTTPFile.hpp.

Member Typedef Documentation

typedef std::vector<ALTTPQuest*>::iterator athena::ALTTPFile::QuestIter

Quest Iterator.

An Iterator typedef for iterating through the Quest lists

Definition at line 25 of file ALTTPFile.hpp.

Constructor & Destructor Documentation

athena::ALTTPFile::ALTTPFile ( )

Default constructor.

athena::ALTTPFile::ALTTPFile ( std::vector< ALTTPQuest * >  questList,
std::vector< ALTTPQuest * >  backupList 
)

Constructor.

Parameters
questListThe primary quest list
backupListThe backup quest list

Member Function Documentation

ALTTPQuest* athena::ALTTPFile::quest ( atUint32  id) const

Returns a quest at the given index.

Returns a quest at the given index

Returns
ALTTPQuest*
Exceptions
InvalidOperationExceptionon index out of range
atUint32 athena::ALTTPFile::questCount ( ) const

Returns the number of primary quests.

Returns
The number of quests
std::vector<ALTTPQuest*> athena::ALTTPFile::questList ( ) const

Returns the primary quest list.

Returns
The primary quest list
void athena::ALTTPFile::setQuest ( atUint32  id,
ALTTPQuest val 
)

Sets a quest at the given index.

Parameters
idIndex to the given quest
valThe new quest to assign to the given index
Exceptions
InvalidOperationExceptionon index out of range

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