mirror of https://github.com/libAthena/athena.git
88 lines
2.4 KiB
C++
88 lines
2.4 KiB
C++
|
// This file is part of libZelda.
|
||
|
|
//
|
||
|
|
// libZelda is free software: you can redistribute it and/or modify
|
||
|
|
// it under the terms of the GNU General Public License as published by
|
||
|
|
// the Free Software Foundation, either version 3 of the License, or
|
||
|
|
// (at your option) any later version.
|
||
|
|
//
|
||
|
|
// libZelda is distributed in the hope that it will be useful,
|
||
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
// GNU General Public License for more details.
|
||
|
|
//
|
||
|
|
// You should have received a copy of the GNU General Public License
|
||
|
|
// along with libZelda. If not, see <http://www.gnu.org/licenses/>
|
||
|
|
|
||
|
|
#ifndef __ALTTP_FILE_HPP__
|
||
|
|
#define __ALTTP_FILE_HPP__
|
||
|
|
|
||
|
|
#include <Types.hpp>
|
||
|
|
#include <vector>
|
||
|
|
|
||
|
|
class ALTTPQuest;
|
||
|
|
|
||
|
|
/*! \class ALTTPFile
|
||
|
|
* \brief A Link to the Past data container class
|
||
|
|
*
|
||
|
|
* Contains all relevant data for an A Link to the Past
|
||
|
|
* SRM file.
|
||
|
|
*/
|
||
|
|
class ALTTPFile
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/*! \brief Quest Iterator
|
||
|
|
*
|
||
|
|
* An Iterator typedef for iterating through the Quest lists
|
||
|
|
*/
|
||
|
|
typedef std::vector<ALTTPQuest*>::iterator QuestIter;
|
||
|
|
|
||
|
|
/*! \brief Default constructor
|
||
|
|
*
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
ALTTPFile();
|
||
|
|
|
||
|
|
/*! \brief Constructor
|
||
|
|
*
|
||
|
|
* \param questList The primary quest list
|
||
|
|
* \param backupList The backup quest list
|
||
|
|
*/
|
||
|
|
ALTTPFile(std::vector<ALTTPQuest*> questList, std::vector<ALTTPQuest*> backupList);
|
||
|
|
|
||
|
|
|
||
|
|
/*! \brief Sets a quest at the given index
|
||
|
|
*
|
||
|
|
* \param id Index to the given quest
|
||
|
|
* \param val The new quest to assign to the given index
|
||
|
|
* \throw InvalidOperationException on index out of range
|
||
|
|
*/
|
||
|
|
void setQuest(Uint32 id, ALTTPQuest* val);
|
||
|
|
/*! \brief Returns the primary quest list
|
||
|
|
*
|
||
|
|
* \return The primary quest list
|
||
|
|
*/
|
||
|
|
std::vector<ALTTPQuest*> questList() const;
|
||
|
|
|
||
|
|
/*! \brief Returns a quest at the given index
|
||
|
|
*
|
||
|
|
* Returns a quest at the given index
|
||
|
|
*
|
||
|
|
* \return ALTTPQuest*
|
||
|
|
* \throw InvalidOperationException on index out of range
|
||
|
|
*/
|
||
|
|
ALTTPQuest* quest(Uint32 id) const;
|
||
|
|
|
||
|
|
/*! \brief Returns the number of primary quests
|
||
|
|
*
|
||
|
|
* \return The number of quests
|
||
|
|
*/
|
||
|
|
Uint32 questCount() const;
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
std::vector<ALTTPQuest*> m_quests;
|
||
|
|
std::vector<ALTTPQuest*> m_backup;
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif // __ALTTP_FILE_HPP__
|