diff --git a/docs/_a_l_t_t_p_enums_8hpp_source.html b/docs/_a_l_t_t_p_enums_8hpp_source.html new file mode 100644 index 0000000..9257cd1 --- /dev/null +++ b/docs/_a_l_t_t_p_enums_8hpp_source.html @@ -0,0 +1,234 @@ + + +
+ + + +
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
▼NAthena | |
▼Nerror | |
CException | The baseclass for all Exceptions |
CFileNotFoundException | An excpeption thrown when a file could not be found at the given path |
CInvalidDataException | An exception thrown on Invalid Data calls |
CInvalidOperationException | An excpeption thrown on Invalid Operations calls |
CIOException | An excpeption thrown on inappropriate IO calls |
CNotImplementedException | |
▼Nio | |
CALTTPFileReader | A Link to the Past save data reader class |
CALTTPFileWriter | A Link to the Past save data writer class |
CFileReader | |
CFileWriter | |
CIStream | |
CIStreamReader | |
CIStreamWriter | |
CMCFileReader | The Minish Cap Save save data reader class |
CMCFileWriter | The Minish Cap Save save data writer class |
CMemoryReader | |
CMemoryWriter | |
CSkywardSwordFileReader | |
CSkywardSwordFileWriter | |
CSpriteFileReader | |
CSpriteFileWriter | |
CWiiSaveReader | Wii data.bin reader class |
CWiiSaveWriter | Wii data.bin writer class |
CZQuestFileReader | The ZQuestFileReader class |
CZQuestFileWriter | The ZQuestFileWriter class |
▼NSakura | |
CSprite | |
CSpriteFile | |
CSpriteFrame | |
CSpritePart | |
CSTexture | |
CVector2D | |
CALTTPAbilities | |
CALTTPCrystals | |
CALTTPDungeonItemFlags | |
CALTTPFile | A Link to the Past data container class class |
CALTTPInventory | |
CALTTPLightDarkWorldIndicator | |
CALTTPMagicUsage | |
CALTTPOverworldEvent | |
CALTTPPendants | |
CALTTPProgressFlags1 | |
CALTTPProgressFlags2 | |
CALTTPQuest | A Link to the Past Quest container class |
CALTTPRoomFlags | |
CDir | |
CFileInfo | |
CMCFile | The Minish Cap data container class class |
CMCSlot | |
CSkywardSwordFile | |
CSkywardSwordQuest | |
CWiiBanner | Wii banner container class |
CWiiFile | Wii file container class |
CWiiImage | The WiiImage class |
CWiiSave | Wii data.bin container class |
CZQuestFile | ZQuestFile is an export format for save data |
CBinaryReader | A Stream class for reading binary data |
CBinaryWriter | A Stream class for writing binary data |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::ALTTPFile, including all inherited members.
+ALTTPFile() | Athena::ALTTPFile | |
ALTTPFile(std::vector< ALTTPQuest * > questList, std::vector< ALTTPQuest * > backupList) | Athena::ALTTPFile | |
quest(atUint32 id) const | Athena::ALTTPFile | |
questCount() const | Athena::ALTTPFile | |
QuestIter typedef | Athena::ALTTPFile | |
questList() const | Athena::ALTTPFile | |
setQuest(atUint32 id, ALTTPQuest *val) | Athena::ALTTPFile |
+ Athena IO Library
+
+ |
+
A Link to the Past data container class class. + More...
+ +#include <ALTTPFile.hpp>
+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... | |
ALTTPQuest * | quest (atUint32 id) const |
Returns a quest at the given index. More... | |
atUint32 | questCount () const |
Returns the number of primary quests. More... | |
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 34 of file ALTTPFile.hpp.
+typedef std::vector<ALTTPQuest*>::iterator Athena::ALTTPFile::QuestIter | +
Quest Iterator.
+An Iterator typedef for iterating through the Quest lists
+ +Definition at line 41 of file ALTTPFile.hpp.
+ +Athena::ALTTPFile::ALTTPFile | +( | +) | ++ |
Default constructor.
+ +Athena::ALTTPFile::ALTTPFile | +( | +std::vector< ALTTPQuest * > | +questList, | +
+ | + | std::vector< ALTTPQuest * > | +backupList | +
+ | ) | ++ |
Constructor.
+questList | The primary quest list |
backupList | The backup quest list |
ALTTPQuest* Athena::ALTTPFile::quest | +( | +atUint32 | +id | ) | +const | +
Returns a quest at the given index.
+Returns a quest at the given index
+InvalidOperationException | on index out of range |
atUint32 Athena::ALTTPFile::questCount | +( | +) | +const | +
Returns the number of primary quests.
+std::vector<ALTTPQuest*> Athena::ALTTPFile::questList | +( | +) | +const | +
Returns the primary quest list.
+void Athena::ALTTPFile::setQuest | +( | +atUint32 | +id, | +
+ | + | ALTTPQuest * | +val | +
+ | ) | ++ |
Sets a quest at the given index.
+id | Index to the given quest |
val | The new quest to assign to the given index |
InvalidOperationException | on index out of range |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::ALTTPQuest, including all inherited members.
+
+ Athena IO Library
+
+ |
+
A Link to the Past Quest container class. + More...
+ +#include <ALTTPQuest.hpp>
+Public Member Functions | |
+ | ALTTPQuest () |
ALTTPQuest. | |
void | setRoomFlags (std::vector< ALTTPRoomFlags * > flags) |
setRoomFlags More... | |
void | setRoomFlags (ALTTPRoomFlags *rf, atUint32 id) |
setRoomFlags More... | |
std::vector< ALTTPRoomFlags * > | roomFlags () |
roomFlags More... | |
ALTTPRoomFlags * | roomFlags (atUint32 id) |
roomFlags More... | |
void | setOverworldEvents (std::vector< ALTTPOverworldEvent * > events) |
setOverworldEvents More... | |
void | setOverworldEvents (ALTTPOverworldEvent *ow, atUint32 id) |
setOverworldEvents More... | |
std::vector< ALTTPOverworldEvent * > | overworldEvents () const |
overworldEvents More... | |
ALTTPOverworldEvent * | overworldEvent (atUint32 id) const |
overworldEvent More... | |
void | setInventory (ALTTPInventory *inv) |
setInventory More... | |
ALTTPInventory * | inventory () const |
inventory More... | |
void | setRupeeMax (atUint16 val) |
setRupeeMax More... | |
atUint16 | rupeeMax () const |
rupeeMax More... | |
void | setRupeeCurrent (atUint16 val) |
setRupeeCurrent More... | |
atUint16 | rupeeCurrent () const |
rupeeCurrent More... | |
void | setCompasses (ALTTPDungeonItemFlags flags) |
setCompasses More... | |
ALTTPDungeonItemFlags | compasses () const |
compasses More... | |
void | setBigKeys (ALTTPDungeonItemFlags flags) |
setBigKeys More... | |
ALTTPDungeonItemFlags | bigKeys () const |
bigKeys More... | |
void | setDungeonMaps (ALTTPDungeonItemFlags flags) |
setDungeonMaps More... | |
ALTTPDungeonItemFlags | dungeonMaps () const |
dungeonMaps More... | |
void | setWishingPond (atUint16 val) |
setWishingPond More... | |
atUint16 | wishingPond () const |
wishingPond More... | |
void | setHealthMax (atUint8 val) |
setHealthMax More... | |
atUint8 | healthMax () const |
healthMax More... | |
void | setHealth (atUint8 val) |
setHealth More... | |
atUint8 | health () const |
health More... | |
void | setMagicPower (atUint8 val) |
setMagicPower More... | |
atUint8 | magicPower () const |
magicPower More... | |
void | setKeys (atUint8 val) |
setKeys More... | |
atUint8 | keys () const |
keys More... | |
void | setBombUpgrades (atUint8 val) |
setBombUpgrades More... | |
atUint8 | bombUpgrades () const |
bombUpgrades More... | |
void | setArrowUpgrades (atUint8 val) |
setArrowUpgrades More... | |
atUint8 | arrowUpgrades () const |
arrowUpgrades More... | |
void | setHealthFiller (atUint8 val) |
setHealthFiller More... | |
atUint8 | healthFiller () const |
healthFiller More... | |
void | setMagicFiller (atUint8 val) |
setMagicFiller More... | |
atUint8 | magicFiller () const |
magicFiller More... | |
void | setPendants (ALTTPPendants val) |
setPendants More... | |
ALTTPPendants | pendants () const |
pendants More... | |
void | setBombFiller (atUint8 val) |
setBombFiller More... | |
atUint8 | bombFiller () const |
bombFiller More... | |
void | setArrowFiller (atUint8 val) |
setArrowFiller More... | |
atUint8 | arrowFiller () const |
arrowFiller More... | |
void | setArrows (atUint8 val) |
setArrows More... | |
atUint8 | arrows () const |
arrows More... | |
void | setAbilityFlags (ALTTPAbilities val) |
setAbilityFlags More... | |
ALTTPAbilities | abilityFlags () const |
abilityFlags More... | |
void | setCrystals (ALTTPCrystals val) |
setCrystals More... | |
ALTTPCrystals | crystals () const |
crystals More... | |
void | setMagicUsage (ALTTPMagicUsage val) |
setMagicUsage More... | |
ALTTPMagicUsage | magicUsage () const |
magicUsage More... | |
void | setDungeonKeys (std::vector< atUint8 > val) |
setDungeonKeys More... | |
void | setDungeonKeys (atUint32 id, atUint8 val) |
setDungeonKeys More... | |
atUint8 | dungeonKeys (atUint32 id) const |
dungeonKeys More... | |
atUint32 | dungeonCount () const |
dungeonCount More... | |
void | setProgressIndicator (ALTTPProgressIndicator val) |
setProgressIndicator More... | |
ALTTPProgressIndicator | progressIndicator () const |
progressIndicator More... | |
void | setProgressFlags1 (ALTTPProgressFlags1 val) |
setProgressFlags1 More... | |
ALTTPProgressFlags1 | progressFlags1 () const |
progressFlags1 More... | |
void | setMapIcon (ALTTPMapIcon val) |
setMapIcon More... | |
ALTTPMapIcon | mapIcon () const |
mapIcon More... | |
void | setStartLocation (ALTTPStartLocation val) |
setStartLocation More... | |
ALTTPStartLocation | startLocation () const |
startLocation More... | |
void | setProgressFlags2 (ALTTPProgressFlags2 val) |
setProgressFlags2 More... | |
ALTTPProgressFlags2 | progressFlags2 () const |
progressFlags2 More... | |
void | setLightDarkWorldIndicator (ALTTPLightDarkWorldIndicator val) |
setLightDarkWorldIndicator More... | |
ALTTPLightDarkWorldIndicator | lightDarkWorldIndicator () const |
lightDarkWorldIndicator More... | |
void | setTagAlong (ALTTPTagAlong val) |
setTagAlong More... | |
ALTTPTagAlong | tagAlong () const |
tagAlong More... | |
void | setOldManFlags (std::vector< atUint8 > flags) |
setOldManFlags More... | |
void | setOldManFlag (atUint32 id, atUint8 val) |
setOldManFlag More... | |
atUint8 | oldManFlag (atUint32 id) |
oldManFlag More... | |
atUint32 | oldManFlagCount () const |
oldManFlagCount More... | |
void | setBombFlag (atUint8 flag) |
setBombFlag More... | |
atUint8 | bombFlag () const |
bombFlag More... | |
void | setUnknown1 (std::vector< atUint8 > flags) |
setUnknown1 More... | |
void | setUnknown1 (atUint32 id, atUint8 val) |
setUnknown1 More... | |
atUint8 | unknown1 (atUint32 id) |
unknown1 More... | |
atUint32 | unknown1Count () const |
unknown1Count More... | |
void | setPlayerName (std::vector< atUint16 > playerName) |
setPlayerName More... | |
void | setPlayerName (const std::string &playerName) |
setPlayerName More... | |
std::vector< atUint16 > | playerName () const |
playerName More... | |
std::string | playerNameToString () const |
playerNameToString More... | |
void | setValid (bool val) |
setValid More... | |
bool | valid () |
valid More... | |
void | setDungeonDeathTotals (std::vector< atUint16 > val) |
setDungeonDeathTotals More... | |
void | setDungeonDeathTotal (atUint32 id, atUint16 val) |
setDungeonDeathTotal More... | |
atUint16 | dungeonDeathTotal (atUint32 id) const |
dungeonDeathTotal More... | |
atUint16 | dungeonDeathTotalCount () const |
dungeonDeathTotalCount More... | |
void | setUnknown2 (atUint16 val) |
setUnknown2 More... | |
atUint16 | unknown2 () const |
unknown2 More... | |
void | setDeathSaveCount (atUint16 val) |
setDeathSaveCount More... | |
atUint16 | deathSaveCount () const |
deathSaveCount More... | |
void | setPostGameDeathCounter (atInt16 val) |
setPostGameDeathCounter More... | |
atInt16 | postGameDeathCounter () const |
postGameDeathCounter More... | |
void | setChecksum (atUint16 checksum) |
setChecksum More... | |
atUint16 | checksum () const |
checksum More... | |
A Link to the Past Quest container class.
+Contains all relevant data for an A Link to the Past Quest entry.
+ +Definition at line 35 of file ALTTPQuest.hpp.
+ALTTPAbilities Athena::ALTTPQuest::abilityFlags | +( | +) | +const | +
abilityFlags
+atUint8 Athena::ALTTPQuest::arrowFiller | +( | +) | +const | +
arrowFiller
+atUint8 Athena::ALTTPQuest::arrows | +( | +) | +const | +
arrows
+atUint8 Athena::ALTTPQuest::arrowUpgrades | +( | +) | +const | +
arrowUpgrades
+ALTTPDungeonItemFlags Athena::ALTTPQuest::bigKeys | +( | +) | +const | +
bigKeys
+atUint8 Athena::ALTTPQuest::bombFiller | +( | +) | +const | +
bombFiller
+atUint8 Athena::ALTTPQuest::bombFlag | +( | +) | +const | +
bombFlag
+atUint8 Athena::ALTTPQuest::bombUpgrades | +( | +) | +const | +
bombUpgrades
+atUint16 Athena::ALTTPQuest::checksum | +( | +) | +const | +
checksum
+ALTTPDungeonItemFlags Athena::ALTTPQuest::compasses | +( | +) | +const | +
compasses
+ALTTPCrystals Athena::ALTTPQuest::crystals | +( | +) | +const | +
crystals
+atUint16 Athena::ALTTPQuest::deathSaveCount | +( | +) | +const | +
deathSaveCount
+atUint32 Athena::ALTTPQuest::dungeonCount | +( | +) | +const | +
dungeonCount
+atUint16 Athena::ALTTPQuest::dungeonDeathTotal | +( | +atUint32 | +id | ) | +const | +
dungeonDeathTotal
+id |
atUint16 Athena::ALTTPQuest::dungeonDeathTotalCount | +( | +) | +const | +
dungeonDeathTotalCount
+atUint8 Athena::ALTTPQuest::dungeonKeys | +( | +atUint32 | +id | ) | +const | +
dungeonKeys
+id |
ALTTPDungeonItemFlags Athena::ALTTPQuest::dungeonMaps | +( | +) | +const | +
dungeonMaps
+atUint8 Athena::ALTTPQuest::health | +( | +) | +const | +
health
+atUint8 Athena::ALTTPQuest::healthFiller | +( | +) | +const | +
healthFiller
+atUint8 Athena::ALTTPQuest::healthMax | +( | +) | +const | +
healthMax
+ALTTPInventory* Athena::ALTTPQuest::inventory | +( | +) | +const | +
inventory
+atUint8 Athena::ALTTPQuest::keys | +( | +) | +const | +
keys
+ALTTPLightDarkWorldIndicator Athena::ALTTPQuest::lightDarkWorldIndicator | +( | +) | +const | +
lightDarkWorldIndicator
+atUint8 Athena::ALTTPQuest::magicFiller | +( | +) | +const | +
magicFiller
+atUint8 Athena::ALTTPQuest::magicPower | +( | +) | +const | +
magicPower
+ALTTPMagicUsage Athena::ALTTPQuest::magicUsage | +( | +) | +const | +
magicUsage
+ALTTPMapIcon Athena::ALTTPQuest::mapIcon | +( | +) | +const | +
mapIcon
+atUint8 Athena::ALTTPQuest::oldManFlag | +( | +atUint32 | +id | ) | ++ |
oldManFlag
+id |
atUint32 Athena::ALTTPQuest::oldManFlagCount | +( | +) | +const | +
oldManFlagCount
+ALTTPOverworldEvent* Athena::ALTTPQuest::overworldEvent | +( | +atUint32 | +id | ) | +const | +
overworldEvent
+id |
std::vector<ALTTPOverworldEvent*> Athena::ALTTPQuest::overworldEvents | +( | +) | +const | +
overworldEvents
+ALTTPPendants Athena::ALTTPQuest::pendants | +( | +) | +const | +
pendants
+std::vector<atUint16> Athena::ALTTPQuest::playerName | +( | +) | +const | +
playerName
+std::string Athena::ALTTPQuest::playerNameToString | +( | +) | +const | +
playerNameToString
+atInt16 Athena::ALTTPQuest::postGameDeathCounter | +( | +) | +const | +
postGameDeathCounter
+ALTTPProgressFlags1 Athena::ALTTPQuest::progressFlags1 | +( | +) | +const | +
progressFlags1
+ALTTPProgressFlags2 Athena::ALTTPQuest::progressFlags2 | +( | +) | +const | +
progressFlags2
+ALTTPProgressIndicator Athena::ALTTPQuest::progressIndicator | +( | +) | +const | +
progressIndicator
+std::vector<ALTTPRoomFlags*> Athena::ALTTPQuest::roomFlags | +( | +) | ++ |
roomFlags
+ALTTPRoomFlags* Athena::ALTTPQuest::roomFlags | +( | +atUint32 | +id | ) | ++ |
roomFlags
+id |
atUint16 Athena::ALTTPQuest::rupeeCurrent | +( | +) | +const | +
rupeeCurrent
+atUint16 Athena::ALTTPQuest::rupeeMax | +( | +) | +const | +
rupeeMax
+void Athena::ALTTPQuest::setAbilityFlags | +( | +ALTTPAbilities | +val | ) | ++ |
setAbilityFlags
+val |
void Athena::ALTTPQuest::setArrowFiller | +( | +atUint8 | +val | ) | ++ |
setArrowFiller
+val |
void Athena::ALTTPQuest::setArrows | +( | +atUint8 | +val | ) | ++ |
setArrows
+val |
void Athena::ALTTPQuest::setArrowUpgrades | +( | +atUint8 | +val | ) | ++ |
setArrowUpgrades
+val |
void Athena::ALTTPQuest::setBigKeys | +( | +ALTTPDungeonItemFlags | +flags | ) | ++ |
setBigKeys
+flags |
void Athena::ALTTPQuest::setBombFiller | +( | +atUint8 | +val | ) | ++ |
setBombFiller
+val |
void Athena::ALTTPQuest::setBombFlag | +( | +atUint8 | +flag | ) | ++ |
setBombFlag
+flag |
void Athena::ALTTPQuest::setBombUpgrades | +( | +atUint8 | +val | ) | ++ |
setBombUpgrades
+val |
void Athena::ALTTPQuest::setChecksum | +( | +atUint16 | +checksum | ) | ++ |
setChecksum
+checksum |
void Athena::ALTTPQuest::setCompasses | +( | +ALTTPDungeonItemFlags | +flags | ) | ++ |
setCompasses
+flags |
void Athena::ALTTPQuest::setCrystals | +( | +ALTTPCrystals | +val | ) | ++ |
setCrystals
+val |
void Athena::ALTTPQuest::setDeathSaveCount | +( | +atUint16 | +val | ) | ++ |
setDeathSaveCount
+val |
void Athena::ALTTPQuest::setDungeonDeathTotal | +( | +atUint32 | +id, | +
+ | + | atUint16 | +val | +
+ | ) | ++ |
setDungeonDeathTotal
+id | |
val |
void Athena::ALTTPQuest::setDungeonDeathTotals | +( | +std::vector< atUint16 > | +val | ) | ++ |
setDungeonDeathTotals
+val |
void Athena::ALTTPQuest::setDungeonKeys | +( | +std::vector< atUint8 > | +val | ) | ++ |
setDungeonKeys
+val |
void Athena::ALTTPQuest::setDungeonKeys | +( | +atUint32 | +id, | +
+ | + | atUint8 | +val | +
+ | ) | ++ |
setDungeonKeys
+id | |
val |
void Athena::ALTTPQuest::setDungeonMaps | +( | +ALTTPDungeonItemFlags | +flags | ) | ++ |
setDungeonMaps
+flags |
void Athena::ALTTPQuest::setHealth | +( | +atUint8 | +val | ) | ++ |
setHealth
+val |
void Athena::ALTTPQuest::setHealthFiller | +( | +atUint8 | +val | ) | ++ |
setHealthFiller
+val |
void Athena::ALTTPQuest::setHealthMax | +( | +atUint8 | +val | ) | ++ |
setHealthMax
+val |
void Athena::ALTTPQuest::setInventory | +( | +ALTTPInventory * | +inv | ) | ++ |
setInventory
+inv |
void Athena::ALTTPQuest::setKeys | +( | +atUint8 | +val | ) | ++ |
setKeys
+val |
void Athena::ALTTPQuest::setLightDarkWorldIndicator | +( | +ALTTPLightDarkWorldIndicator | +val | ) | ++ |
setLightDarkWorldIndicator
+val |
void Athena::ALTTPQuest::setMagicFiller | +( | +atUint8 | +val | ) | ++ |
setMagicFiller
+val |
void Athena::ALTTPQuest::setMagicPower | +( | +atUint8 | +val | ) | ++ |
setMagicPower
+val |
void Athena::ALTTPQuest::setMagicUsage | +( | +ALTTPMagicUsage | +val | ) | ++ |
setMagicUsage
+val |
void Athena::ALTTPQuest::setMapIcon | +( | +ALTTPMapIcon | +val | ) | ++ |
setMapIcon
+val |
void Athena::ALTTPQuest::setOldManFlag | +( | +atUint32 | +id, | +
+ | + | atUint8 | +val | +
+ | ) | ++ |
setOldManFlag
+id | |
val |
void Athena::ALTTPQuest::setOldManFlags | +( | +std::vector< atUint8 > | +flags | ) | ++ |
setOldManFlags
+flags |
void Athena::ALTTPQuest::setOverworldEvents | +( | +std::vector< ALTTPOverworldEvent * > | +events | ) | ++ |
setOverworldEvents
+events |
void Athena::ALTTPQuest::setOverworldEvents | +( | +ALTTPOverworldEvent * | +ow, | +
+ | + | atUint32 | +id | +
+ | ) | ++ |
setOverworldEvents
+ow | |
id |
void Athena::ALTTPQuest::setPendants | +( | +ALTTPPendants | +val | ) | ++ |
setPendants
+val |
void Athena::ALTTPQuest::setPlayerName | +( | +std::vector< atUint16 > | +playerName | ) | ++ |
setPlayerName
+playerName |
void Athena::ALTTPQuest::setPlayerName | +( | +const std::string & | +playerName | ) | ++ |
setPlayerName
+playerName |
void Athena::ALTTPQuest::setPostGameDeathCounter | +( | +atInt16 | +val | ) | ++ |
setPostGameDeathCounter
+val |
void Athena::ALTTPQuest::setProgressFlags1 | +( | +ALTTPProgressFlags1 | +val | ) | ++ |
setProgressFlags1
+val |
void Athena::ALTTPQuest::setProgressFlags2 | +( | +ALTTPProgressFlags2 | +val | ) | ++ |
setProgressFlags2
+val |
void Athena::ALTTPQuest::setProgressIndicator | +( | +ALTTPProgressIndicator | +val | ) | ++ |
setProgressIndicator
+val |
void Athena::ALTTPQuest::setRoomFlags | +( | +std::vector< ALTTPRoomFlags * > | +flags | ) | ++ |
setRoomFlags
+flags |
void Athena::ALTTPQuest::setRoomFlags | +( | +ALTTPRoomFlags * | +rf, | +
+ | + | atUint32 | +id | +
+ | ) | ++ |
setRoomFlags
+rf | |
id |
void Athena::ALTTPQuest::setRupeeCurrent | +( | +atUint16 | +val | ) | ++ |
setRupeeCurrent
+val |
void Athena::ALTTPQuest::setRupeeMax | +( | +atUint16 | +val | ) | ++ |
setRupeeMax
+val |
void Athena::ALTTPQuest::setStartLocation | +( | +ALTTPStartLocation | +val | ) | ++ |
setStartLocation
+val |
void Athena::ALTTPQuest::setTagAlong | +( | +ALTTPTagAlong | +val | ) | ++ |
setTagAlong
+val |
void Athena::ALTTPQuest::setUnknown1 | +( | +std::vector< atUint8 > | +flags | ) | ++ |
setUnknown1
+flags |
void Athena::ALTTPQuest::setUnknown1 | +( | +atUint32 | +id, | +
+ | + | atUint8 | +val | +
+ | ) | ++ |
setUnknown1
+id | |
val |
void Athena::ALTTPQuest::setUnknown2 | +( | +atUint16 | +val | ) | ++ |
setUnknown2
+val |
void Athena::ALTTPQuest::setValid | +( | +bool | +val | ) | ++ |
setValid
+val |
void Athena::ALTTPQuest::setWishingPond | +( | +atUint16 | +val | ) | ++ |
setWishingPond
+val |
ALTTPStartLocation Athena::ALTTPQuest::startLocation | +( | +) | +const | +
startLocation
+ALTTPTagAlong Athena::ALTTPQuest::tagAlong | +( | +) | +const | +
tagAlong
+atUint8 Athena::ALTTPQuest::unknown1 | +( | +atUint32 | +id | ) | ++ |
unknown1
+id |
atUint32 Athena::ALTTPQuest::unknown1Count | +( | +) | +const | +
unknown1Count
+atUint16 Athena::ALTTPQuest::unknown2 | +( | +) | +const | +
unknown2
+bool Athena::ALTTPQuest::valid | +( | +) | ++ |
valid
+atUint16 Athena::ALTTPQuest::wishingPond | +( | +) | +const | +
wishingPond
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::Dir, including all inherited members.
+absolutePath() const (defined in Athena::Dir) | Athena::Dir | |
absolutePath(const std::string &path) (defined in Athena::Dir) | Athena::Dir | inlinestatic |
cd(const std::string &path) (defined in Athena::Dir) | Athena::Dir | |
Dir(const std::string &path) (defined in Athena::Dir) | Athena::Dir | explicit |
files() const (defined in Athena::Dir) | Athena::Dir | |
isDir() const (defined in Athena::Dir) | Athena::Dir | |
isDir(const std::string dir) (defined in Athena::Dir) | Athena::Dir | inlinestatic |
mkdir(const std::string &dir, mode_t mode=0755) (defined in Athena::Dir) | Athena::Dir | static |
mkpath(const std::string &path, mode_t mode=0755) (defined in Athena::Dir) | Athena::Dir | static |
rm(const std::string &path) (defined in Athena::Dir) | Athena::Dir | |
touch() (defined in Athena::Dir) | Athena::Dir |
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | Dir (const std::string &path) |
+std::string | absolutePath () const |
+bool | isDir () const |
+std::vector< FileInfo > | files () const |
+bool | cd (const std::string &path) |
+bool | rm (const std::string &path) |
+bool | touch () |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::FileInfo, including all inherited members.
+absoluteFilePath() const (defined in Athena::FileInfo) | Athena::FileInfo | |
absoluteFilePath(const std::string &path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
absolutePath() const (defined in Athena::FileInfo) | Athena::FileInfo | |
absolutePath(const std::string &lnk) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
exists() const (defined in Athena::FileInfo) | Athena::FileInfo | |
exists(const std::string &path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
extension() const (defined in Athena::FileInfo) | Athena::FileInfo | |
extension(const std::string path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
FileInfo(const std::string &path=std::string()) (defined in Athena::FileInfo) | Athena::FileInfo | explicit |
filename() const (defined in Athena::FileInfo) | Athena::FileInfo | |
filename(const std::string path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
isFile() const (defined in Athena::FileInfo) | Athena::FileInfo | |
isFile(const std::string &path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
isLink() const (defined in Athena::FileInfo) | Athena::FileInfo | |
isLink(const std::string &lnk) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
path() const (defined in Athena::FileInfo) | Athena::FileInfo | |
path(const std::string path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
size() const (defined in Athena::FileInfo) | Athena::FileInfo | |
size(const std::string path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
touch() const (defined in Athena::FileInfo) | Athena::FileInfo | |
touch(const std::string &path) (defined in Athena::FileInfo) | Athena::FileInfo | inlinestatic |
+ Athena IO Library
+
+ |
+
Definition at line 10 of file FileInfo.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::MCFile, including all inherited members.
+Deleted enum value (defined in Athena::MCFile) | Athena::MCFile | |
MCFile() (defined in Athena::MCFile) | Athena::MCFile | |
New enum value (defined in Athena::MCFile) | Athena::MCFile | |
SlotType enum name (defined in Athena::MCFile) | Athena::MCFile | |
unscramble(atUint8 *data, atUint64 length) (defined in Athena::MCFile) | Athena::MCFile | static |
Valid enum value (defined in Athena::MCFile) | Athena::MCFile | |
VERSION_EU_JP (defined in Athena::MCFile) | Athena::MCFile | static |
VERSION_US (defined in Athena::MCFile) | Athena::MCFile | static |
+ Athena IO Library
+
+ |
+
The Minish Cap data container class class. + More...
+ +#include <MCFile.hpp>
+Public Types | |
enum | SlotType { New = 0x54494E49, +Valid = 0x4D435A33, +Deleted = 0x466C6544 + } |
+Static Public Member Functions | |
+static atUint8 * | unscramble (atUint8 *data, atUint64 length) |
+Static Public Attributes | |
+static const char | VERSION_EU_JP [33] |
+static const char | VERSION_US [33] |
The Minish Cap data container class class.
+Contains all relevant data for a The Minish Cap save, file.
+ +Definition at line 31 of file MCFile.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::MCSlot, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | MCSlot (atUint8 *data, atUint32 length) |
Public Member Functions inherited from Athena::ZQuestFile | |
+ | ZQuestFile () |
ZQuest. | |
ZQuestFile (Game game, Endian endian, 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 (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... | |
+Additional Inherited Members | |
Public Types inherited from Athena::ZQuestFile | |
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... | |
Static Public Member Functions inherited from Athena::ZQuestFile | |
+static const std::vector< std::string > | gameStringList () |
Static Public Attributes inherited from Athena::ZQuestFile | |
+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 inherited from Athena::ZQuestFile | |
+Game | m_game |
+std::string | m_gameString |
+Endian | m_endian |
+atUint8 * | m_data |
+atUint32 | m_length |
Definition at line 9 of file MCSlot.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::Sakura::Sprite, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | Sprite (SpriteFile *root) |
+ | Sprite (SpriteFile *root, const std::string &name) |
+virtual void | setPosition (const float x, const float y) |
+virtual void | setPosition (const Vector2Df &pos) |
+virtual Vector2Df | position () const |
+void | setName (const std::string &name) |
+std::string | name () const |
+void | addStateId (int id) |
int | stateId (int index) const |
Returns the texture id of a given state. More... | |
+void | setStateIds (std::vector< int > ids) |
+std::vector< int > | stateIds () const |
+atUint32 | stateCount () const |
+void | setCurrentState (atUint32 id) |
+atUint32 | currentState () const |
+bool | addFrame (SpriteFrame *Frame) |
+bool | removeFrame (SpriteFrame *Frame) |
+SpriteFrame * | Frame (atUint32 id) |
+void | setFrame (atUint32 id) |
+void | setFrames (std::vector< SpriteFrame * > frames) |
+atUint32 | frameCount () const |
+std::vector< SpriteFrame * > | frames () const |
+SpriteFile * | container () const |
+void | setCurrentFrame (SpriteFrame *frame) |
+void | setCurrentFrame (atUint32 id) |
+SpriteFrame * | currentFrame () const |
+void | advanceFrame () |
+void | retreatFrame () |
+void | setRoot (SpriteFile *root) |
+SpriteFile * | root () const |
Definition at line 39 of file Sprite.hpp.
+int Athena::Sakura::Sprite::stateId | +( | +int | +index | ) | +const | +
Returns the texture id of a given state.
+index | The index of the id. |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::Sakura::SpriteFile, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | SpriteFile () |
SSprite. | |
SpriteFile (atUint32 width, atUint32 height, float originX, float originY) | |
SSpriteFile. More... | |
SpriteFile (const Vector2Di &size, const Vector2Df &origin) | |
SSpriteFile. More... | |
void | setSize (atUint32 width, atUint32 height) |
setSize More... | |
void | setSize (const Vector2Di &size) |
setSize More... | |
Vector2Di | size () const |
size More... | |
atUint32 | width () const |
width More... | |
atUint32 | height () const |
height More... | |
void | setOrigin (const float x, const float y) |
setOrigin More... | |
void | setOrigin (const Vector2Df &origin) |
setOrigin More... | |
Vector2Df | origin () const |
origin More... | |
float | originX () const |
originX More... | |
float | originY () const |
originY More... | |
bool | addTexture (STexture *texture) |
addTexture More... | |
void | removeTexture (int id) |
removeTexture More... | |
STexture * | texture (atUint32 id) |
texture More... | |
+std::vector< STexture * > | textures () const |
+atUint32 | textureCount () const |
void | setTextures (std::vector< STexture * > textures) |
setTextures More... | |
+void | addSprite (Sprite *sprite) |
+void | removeSprite (const std::string &name) |
+void | removeSprite (Sprite *sprite) |
+void | setSprites (std::unordered_map< std::string, Sprite * > sprites) |
+Sprite * | sprite (const std::string &name) |
+std::unordered_map< std::string, Sprite * > | sprites () const |
+atUint32 | spriteCount () const |
+Static Public Attributes | |
+static const atUint32 | Major |
Major. | |
+static const atUint32 | Minor |
Minor. | |
+static const atUint32 | Revision |
Revision. | |
+static const atUint32 | Build |
Patch. | |
+static const atUint32 | Version |
Version. | |
+static const atUint32 | Magic |
Magic. | |
Definition at line 46 of file SpriteFile.hpp.
+Athena::Sakura::SpriteFile::SpriteFile | +( | +atUint32 | +width, | +
+ | + | atUint32 | +height, | +
+ | + | float | +originX, | +
+ | + | float | +originY | +
+ | ) | ++ |
SSpriteFile.
+width | |
height | |
originX | |
originY |
Athena::Sakura::SpriteFile::SpriteFile | +( | +const Vector2Di & | +size, | +
+ | + | const Vector2Df & | +origin | +
+ | ) | ++ |
SSpriteFile.
+size | |
origin |
bool Athena::Sakura::SpriteFile::addTexture | +( | +STexture * | +texture | ) | ++ |
addTexture
+texture |
atUint32 Athena::Sakura::SpriteFile::height | +( | +) | +const | +
height
+Vector2Df Athena::Sakura::SpriteFile::origin | +( | +) | +const | +
origin
+float Athena::Sakura::SpriteFile::originX | +( | +) | +const | +
originX
+float Athena::Sakura::SpriteFile::originY | +( | +) | +const | +
originY
+void Athena::Sakura::SpriteFile::removeTexture | +( | +int | +id | ) | ++ |
removeTexture
+id |
void Athena::Sakura::SpriteFile::setOrigin | +( | +const float | +x, | +
+ | + | const float | +y | +
+ | ) | ++ |
setOrigin
+x | |
y |
void Athena::Sakura::SpriteFile::setOrigin | +( | +const Vector2Df & | +origin | ) | ++ |
setOrigin
+origin |
void Athena::Sakura::SpriteFile::setSize | +( | +atUint32 | +width, | +
+ | + | atUint32 | +height | +
+ | ) | ++ |
setSize
+width | |
height |
void Athena::Sakura::SpriteFile::setSize | +( | +const Vector2Di & | +size | ) | ++ |
setSize
+size |
void Athena::Sakura::SpriteFile::setTextures | +( | +std::vector< STexture * > | +textures | ) | ++ |
setTextures
+textures |
Vector2Di Athena::Sakura::SpriteFile::size | +( | +) | +const | +
size
+STexture* Athena::Sakura::SpriteFile::texture | +( | +atUint32 | +id | ) | ++ |
texture
+id |
atUint32 Athena::Sakura::SpriteFile::width | +( | +) | +const | +
width
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::Sakura::SpriteFrame, including all inherited members.
+frameTime() const | Athena::Sakura::SpriteFrame | |
partCount() const (defined in Athena::Sakura::SpriteFrame) | Athena::Sakura::SpriteFrame | |
parts() const (defined in Athena::Sakura::SpriteFrame) | Athena::Sakura::SpriteFrame | |
root() const (defined in Athena::Sakura::SpriteFrame) | Athena::Sakura::SpriteFrame | |
setFrameTime(float frameTime) | Athena::Sakura::SpriteFrame | |
setParts(std::vector< SpritePart * > parts) (defined in Athena::Sakura::SpriteFrame) | Athena::Sakura::SpriteFrame | |
setRoot(Sprite *root) (defined in Athena::Sakura::SpriteFrame) | Athena::Sakura::SpriteFrame | |
SpriteFrame() | Athena::Sakura::SpriteFrame | |
SpriteFrame(Sprite *root) (defined in Athena::Sakura::SpriteFrame) | Athena::Sakura::SpriteFrame |
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | SpriteFrame () |
SSpriteFrame. | |
+ | SpriteFrame (Sprite *root) |
void | setFrameTime (float frameTime) |
setFrameTime More... | |
float | frameTime () const |
frameTime More... | |
+void | setParts (std::vector< SpritePart * > parts) |
+std::vector< SpritePart * > | parts () const |
+atUint32 | partCount () const |
+void | setRoot (Sprite *root) |
+Sprite * | root () const |
Definition at line 39 of file SpriteFrame.hpp.
+float Athena::Sakura::SpriteFrame::frameTime | +( | +) | +const | +
frameTime
+void Athena::Sakura::SpriteFrame::setFrameTime | +( | +float | +frameTime | ) | ++ |
setFrameTime
+frameTime |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::Sakura::SpritePart, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | SpritePart (SpriteFrame *root) |
+ | SpritePart (SpriteFrame *root, const std::string &name, bool hasCollision=false) |
+void | setName (const std::string &name) |
+std::string | name () const |
+void | setCollision (bool col) |
+bool | hasCollision () const |
void | setOffset (float x, float y) |
setOffset More... | |
void | setOffset (const Vector2Df &offset) |
setOffset More... | |
Vector2Df | offset () const |
offset More... | |
void | setTextureOffset (float x, float y) |
setTextureOffset More... | |
void | setTextureOffset (const Vector2Df &offset) |
setTextureOffset More... | |
Vector2Df | textureOffset () const |
textureOffset More... | |
void | setSize (atUint32 width, atUint32 height) |
setSize More... | |
void | setSize (const Vector2Di &size) |
setSize More... | |
Vector2Di | size () const |
size More... | |
void | setFlippedHorizontally (const bool val) |
setFlippedHorizontally More... | |
bool | flippedHorizontally () const |
flippedHorizontally More... | |
void | setFlippedVertically (const bool val) |
setFlippedVertically More... | |
bool | flippedVertically () const |
flippedVertically More... | |
+void | setRoot (SpriteFrame *root) |
+SpriteFrame * | root () const |
Definition at line 39 of file SpritePart.hpp.
+bool Athena::Sakura::SpritePart::flippedHorizontally | +( | +) | +const | +
flippedHorizontally
+bool Athena::Sakura::SpritePart::flippedVertically | +( | +) | +const | +
flippedVertically
+Vector2Df Athena::Sakura::SpritePart::offset | +( | +) | +const | +
offset
+void Athena::Sakura::SpritePart::setFlippedHorizontally | +( | +const bool | +val | ) | ++ |
setFlippedHorizontally
+val |
void Athena::Sakura::SpritePart::setFlippedVertically | +( | +const bool | +val | ) | ++ |
setFlippedVertically
+val |
void Athena::Sakura::SpritePart::setOffset | +( | +float | +x, | +
+ | + | float | +y | +
+ | ) | ++ |
setOffset
+x | |
y |
void Athena::Sakura::SpritePart::setOffset | +( | +const Vector2Df & | +offset | ) | ++ |
setOffset
+offset |
void Athena::Sakura::SpritePart::setSize | +( | +atUint32 | +width, | +
+ | + | atUint32 | +height | +
+ | ) | ++ |
setSize
+width | |
height |
void Athena::Sakura::SpritePart::setSize | +( | +const Vector2Di & | +size | ) | ++ |
setSize
+size |
void Athena::Sakura::SpritePart::setTextureOffset | +( | +float | +x, | +
+ | + | float | +y | +
+ | ) | ++ |
setTextureOffset
+x | |
y |
void Athena::Sakura::SpritePart::setTextureOffset | +( | +const Vector2Df & | +offset | ) | ++ |
setTextureOffset
+texOff |
Vector2Di Athena::Sakura::SpritePart::size | +( | +) | +const | +
size
+Vector2Df Athena::Sakura::SpritePart::textureOffset | +( | +) | +const | +
textureOffset
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::Sakura::Vector2D< T >, including all inherited members.
+Vector2D() (defined in Athena::Sakura::Vector2D< T >) | Athena::Sakura::Vector2D< T > | inline |
Vector2D(T x, T y) (defined in Athena::Sakura::Vector2D< T >) | Athena::Sakura::Vector2D< T > | inline |
x (defined in Athena::Sakura::Vector2D< T >) | Athena::Sakura::Vector2D< T > | |
y (defined in Athena::Sakura::Vector2D< T >) | Athena::Sakura::Vector2D< T > |
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | Vector2D (T x, T y) |
+Public Attributes | |
+T | x |
+T | y |
Definition at line 94 of file Global.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::SkywardSwordFile, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Types | |
enum | MagicNumbers { USMagic = 0x534F5545, +JAMagic = 0x534F554A, +EUMagic = 0x534F5550 + } |
+Public Member Functions | |
+ | SkywardSwordFile (std::vector< SkywardSwordQuest * > quests) |
+void | addQuest (SkywardSwordQuest *q) |
+SkywardSwordQuest * | quest (atUint32 id) |
+std::vector< SkywardSwordQuest * > | questList () const |
+void | setRegion (Region region) |
+Region | region () const |
Definition at line 36 of file SkywardSwordFile.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::SkywardSwordQuest, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Types | |
enum | AmmoType { Arrows, +Bombs, +Seeds + } |
Public Types inherited from Athena::ZQuestFile | |
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 | |
+ | SkywardSwordQuest (atUint8 *data, atUint32 len) |
+void | setPlayerName (const std::string &name) |
+std::string | playerName () const |
+void | setRupeeCount (atUint16 value) |
+atUint16 | rupeeCount () |
+void | setAmmoCount (AmmoType type, atUint32 count) |
+atUint32 | ammoCount (AmmoType type) |
+void | setMaxHP (atUint16 val) |
+atUint16 | maxHP () |
+float | maxHearts () |
+void | setSpawnHP (atUint16 val) |
+atUint16 | spawnHP () |
+float | spawnHearts () |
+void | setCurrentHP (atUint16 val) |
+atUint16 | currentHP () |
+float | currentHearts () |
+std::string | currentLocation () |
+std::string | currentArea () |
+std::string | currentLocationCopy () |
+void | setSkipData (const atUint8 *data) |
+atUint8 * | skipData () const |
+atUint32 | slotChecksum () |
+atUint32 | skipChecksum () |
+void | fixChecksums () |
+void | setNew (bool isNew) |
+bool | isNew () const |
Public Member Functions inherited from Athena::ZQuestFile | |
+ | ZQuestFile () |
ZQuest. | |
ZQuestFile (Game game, Endian endian, 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 (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... | |
+Additional Inherited Members | |
Static Public Member Functions inherited from Athena::ZQuestFile | |
+static const std::vector< std::string > | gameStringList () |
Static Public Attributes inherited from Athena::ZQuestFile | |
+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 inherited from Athena::ZQuestFile | |
+Game | m_game |
+std::string | m_gameString |
+Endian | m_endian |
+atUint8 * | m_data |
+atUint32 | m_length |
Definition at line 27 of file SkywardSwordQuest.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::WiiBanner, including all inherited members.
+
+ Athena IO Library
+
+ |
+
Wii banner container class. + More...
+ +#include <WiiBanner.hpp>
+Public Types | |
enum | { NoCopy = 0x00000001, +Bounce = 0x00000010, +NoCopyBounce = NoCopy | Bounce + } |
+Public Member Functions | |
+ | WiiBanner () |
WiiBanner. | |
WiiBanner (atUint32 gameId, const std::string &title, const std::string &subtitle, WiiImage *m_banner, std::vector< WiiImage * > icons) | |
WiiBanner. More... | |
void | setGameID (atUint64 id) |
setGameID More... | |
atUint64 | gameID () const |
gameID More... | |
void | setBannerImage (WiiImage *banner) |
setBannerImage More... | |
WiiImage * | bannerImage () const |
bannerImage More... | |
void | setBannerSize (atUint32 size) |
setBannerSize More... | |
atUint32 | bannerSize () const |
bannerSize More... | |
void | setTitle (const std::string &title) |
setTitle More... | |
std::string | title () const |
title More... | |
void | setSubtitle (const std::string &subtitle) |
setSubtitle More... | |
std::string | subtitle () const |
subtitle More... | |
void | addIcon (WiiImage *icon) |
addIcon More... | |
void | setIcon (atUint32 id, WiiImage *icon) |
setIcon More... | |
WiiImage * | getIcon (atUint32 id) const |
getIcon More... | |
std::vector< WiiImage * > | icons () const |
icons More... | |
void | setAnimationSpeed (atUint16 animSpeed) |
setAnimationSpeed More... | |
atUint16 | animationSpeed () const |
animationSpeed More... | |
void | setPermissions (atUint8 permissions) |
setPermissions More... | |
atUint8 | permissions () const |
permissions More... | |
void | setFlags (atUint32 flags) |
setFlags More... | |
atUint32 | flags () const |
flags More... | |
Wii banner container class.
+Contains all relevant data for a Wii banner.
+ +Definition at line 33 of file WiiBanner.hpp.
+Athena::WiiBanner::WiiBanner | +( | +atUint32 | +gameId, | +
+ | + | const std::string & | +title, | +
+ | + | const std::string & | +subtitle, | +
+ | + | WiiImage * | +m_banner, | +
+ | + | std::vector< WiiImage * > | +icons | +
+ | ) | ++ |
gameId | |
title | |
subtitle | |
m_banner | |
icons |
void Athena::WiiBanner::addIcon | +( | +WiiImage * | +icon | ) | ++ |
addIcon
+icon |
atUint16 Athena::WiiBanner::animationSpeed | +( | +) | +const | +
animationSpeed
+WiiImage* Athena::WiiBanner::bannerImage | +( | +) | +const | +
bannerImage
+atUint32 Athena::WiiBanner::bannerSize | +( | +) | +const | +
bannerSize
+atUint32 Athena::WiiBanner::flags | +( | +) | +const | +
flags
+atUint64 Athena::WiiBanner::gameID | +( | +) | +const | +
gameID
+WiiImage* Athena::WiiBanner::getIcon | +( | +atUint32 | +id | ) | +const | +
getIcon
+id |
std::vector<WiiImage*> Athena::WiiBanner::icons | +( | +) | +const | +
icons
+atUint8 Athena::WiiBanner::permissions | +( | +) | +const | +
permissions
+void Athena::WiiBanner::setAnimationSpeed | +( | +atUint16 | +animSpeed | ) | ++ |
setAnimationSpeed
+animSpeed |
void Athena::WiiBanner::setBannerImage | +( | +WiiImage * | +banner | ) | ++ |
setBannerImage
+banner |
void Athena::WiiBanner::setBannerSize | +( | +atUint32 | +size | ) | ++ |
setBannerSize
+size |
void Athena::WiiBanner::setFlags | +( | +atUint32 | +flags | ) | ++ |
setFlags
+flags |
void Athena::WiiBanner::setGameID | +( | +atUint64 | +id | ) | ++ |
setGameID
+id |
void Athena::WiiBanner::setIcon | +( | +atUint32 | +id, | +
+ | + | WiiImage * | +icon | +
+ | ) | ++ |
setIcon
+id | |
icon |
void Athena::WiiBanner::setPermissions | +( | +atUint8 | +permissions | ) | ++ |
setPermissions
+permissions |
void Athena::WiiBanner::setSubtitle | +( | +const std::string & | +subtitle | ) | ++ |
setSubtitle
+subtitle |
void Athena::WiiBanner::setTitle | +( | +const std::string & | +title | ) | ++ |
setTitle
+title |
std::string Athena::WiiBanner::subtitle | +( | +) | +const | +
subtitle
+std::string Athena::WiiBanner::title | +( | +) | +const | +
title
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::WiiFile, including all inherited members.
+
+ Athena IO Library
+
+ |
+
Wii file container class. + More...
+ +#include <WiiFile.hpp>
+Public Types | |
enum | Permission { + OtherRead = 0x01, +OtherWrite = 0x02, +GroupRead = 0x04, +GroupWrite = 0x08, + + OwnerRead = 0x10, +OwnerWrite = 0x20, +OtherRW = (OtherRead | OtherWrite), +GroupRW = (GroupRead | GroupWrite), + + OwnerRW = (OwnerRead | OwnerWrite) + + } |
The Wii uses a bastardized unix permissions system so these flags reflect the file's individual permissions. More... | |
enum | Type { File = 0x01, +Directory = 0x02 + } |
The Type enum. | |
+Public Member Functions | |
WiiFile (const std::string &filename) | |
WiiFile. More... | |
WiiFile (const std::string &filename, atUint8 permissions, const atUint8 *data, atUint32 length) | |
WiiFile. More... | |
void | setFilename (const std::string &filename) |
setFilename More... | |
std::string | filename () const |
filename More... | |
void | setData (const atUint8 *data) |
setData More... | |
atUint8 * | data () const |
data More... | |
void | setLength (const int len) |
setLength More... | |
int | length () const |
length More... | |
void | setPermissions (const atUint8 permissions) |
setPermissions More... | |
atUint8 | permissions () const |
permissions More... | |
void | setAttributes (const atUint8 attr) |
setAttributes More... | |
atUint8 | attributes () const |
attributes More... | |
void | setType (Type type) |
setType More... | |
Type | type () const |
type More... | |
bool | isDirectory () const |
isDirectory More... | |
bool | isFile () const |
isFile More... | |
void | addChild (WiiFile *file) |
addChild More... | |
std::vector< WiiFile * > | children () |
children More... | |
WiiFile * | child (const std::string &name) |
child More... | |
void | removeChild (const std::string &name) |
removeChild More... | |
void | removeChild (WiiFile *file) |
removeChild More... | |
WiiFile * | parent () |
parent More... | |
void | setParent (WiiFile *parent) |
setParent More... | |
atUint32 | fileCount () |
fileCount More... | |
std::vector< WiiFile * > | allChildren () |
allChildren More... | |
std::string | fullpath () |
fullpath More... | |
Wii file container class.
+Contains all relevant data for a file in a data.bin file.
+ +Definition at line 36 of file WiiFile.hpp.
+enum Athena::WiiFile::Permission | +
The Wii uses a bastardized unix permissions system so these flags reflect the file's individual permissions.
+Enumerator | |
---|---|
OtherRW |
+ Mask to get the Other group permissions. + |
Definition at line 44 of file WiiFile.hpp.
+ +Athena::WiiFile::WiiFile | +( | +const std::string & | +filename | ) | ++ |
filename |
Athena::WiiFile::WiiFile | +( | +const std::string & | +filename, | +
+ | + | atUint8 | +permissions, | +
+ | + | const atUint8 * | +data, | +
+ | + | atUint32 | +length | +
+ | ) | ++ |
filename | |
permissions | |
data | |
length |
void Athena::WiiFile::addChild | +( | +WiiFile * | +file | ) | ++ |
addChild
+file |
std::vector<WiiFile*> Athena::WiiFile::allChildren | +( | +) | ++ |
allChildren
+atUint8 Athena::WiiFile::attributes | +( | +) | +const | +
attributes
+WiiFile* Athena::WiiFile::child | +( | +const std::string & | +name | ) | ++ |
child
+name |
std::vector<WiiFile*> Athena::WiiFile::children | +( | +) | ++ |
children
+atUint8* Athena::WiiFile::data | +( | +) | +const | +
data
+atUint32 Athena::WiiFile::fileCount | +( | +) | ++ |
fileCount
+std::string Athena::WiiFile::filename | +( | +) | +const | +
filename
+std::string Athena::WiiFile::fullpath | +( | +) | ++ |
fullpath
+bool Athena::WiiFile::isDirectory | +( | +) | +const | +
isDirectory
+bool Athena::WiiFile::isFile | +( | +) | +const | +
isFile
+int Athena::WiiFile::length | +( | +) | +const | +
length
+WiiFile* Athena::WiiFile::parent | +( | +) | ++ |
parent
+atUint8 Athena::WiiFile::permissions | +( | +) | +const | +
permissions
+void Athena::WiiFile::removeChild | +( | +const std::string & | +name | ) | ++ |
removeChild
+name |
void Athena::WiiFile::removeChild | +( | +WiiFile * | +file | ) | ++ |
removeChild
+file |
void Athena::WiiFile::setAttributes | +( | +const atUint8 | +attr | ) | ++ |
setAttributes
+attr |
void Athena::WiiFile::setData | +( | +const atUint8 * | +data | ) | ++ |
setData
+data |
void Athena::WiiFile::setFilename | +( | +const std::string & | +filename | ) | ++ |
setFilename
+filename |
void Athena::WiiFile::setLength | +( | +const int | +len | ) | ++ |
setLength
+len |
void Athena::WiiFile::setParent | +( | +WiiFile * | +parent | ) | ++ |
setParent
+parent |
void Athena::WiiFile::setPermissions | +( | +const atUint8 | +permissions | ) | ++ |
setPermissions
+permissions |
void Athena::WiiFile::setType | +( | +Type | +type | ) | ++ |
setType
+type |
Type Athena::WiiFile::type | +( | +) | +const | +
type
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::WiiImage, including all inherited members.
+data() | Athena::WiiImage | |
height() const | Athena::WiiImage | |
setData(const atUint8 *data) | Athena::WiiImage | |
setHeight(const atUint32 height) | Athena::WiiImage | |
setWidth(const atUint32 width) | Athena::WiiImage | |
toRGBA() | Athena::WiiImage | |
width() const | Athena::WiiImage | |
WiiImage() | Athena::WiiImage | |
WiiImage(atUint32 width, atUint32 height, atUint8 *data) | Athena::WiiImage | |
~WiiImage() | Athena::WiiImage |
+ Athena IO Library
+
+ |
+
#include <WiiImage.hpp>
+Public Member Functions | |
+ | WiiImage () |
WiiImage. | |
WiiImage (atUint32 width, atUint32 height, atUint8 *data) | |
WiiImage. More... | |
+ | ~WiiImage () |
~WiiImage | |
void | setWidth (const atUint32 width) |
setWidth More... | |
atUint32 | width () const |
width More... | |
void | setHeight (const atUint32 height) |
setHeight More... | |
atUint32 | height () const |
height More... | |
void | setData (const atUint8 *data) |
setData More... | |
atUint8 * | data () |
data More... | |
atUint8 * | toRGBA () |
toRGBA More... | |
The WiiImage class.
+ +Definition at line 28 of file WiiImage.hpp.
+Athena::WiiImage::WiiImage | +( | +atUint32 | +width, | +
+ | + | atUint32 | +height, | +
+ | + | atUint8 * | +data | +
+ | ) | ++ |
width | |
height | |
data |
atUint8* Athena::WiiImage::data | +( | +) | ++ |
data
+atUint32 Athena::WiiImage::height | +( | +) | +const | +
height
+void Athena::WiiImage::setData | +( | +const atUint8 * | +data | ) | ++ |
setData
+data |
void Athena::WiiImage::setHeight | +( | +const atUint32 | +height | ) | ++ |
setHeight
+height |
void Athena::WiiImage::setWidth | +( | +const atUint32 | +width | ) | ++ |
setWidth
+width |
atUint8* Athena::WiiImage::toRGBA | +( | +) | ++ |
toRGBA
+atUint32 Athena::WiiImage::width | +( | +) | +const | +
width
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::WiiSave, including all inherited members.
+addFile(WiiFile *file) | Athena::WiiSave | |
allFiles() const (defined in Athena::WiiSave) | Athena::WiiSave | |
banner() const | Athena::WiiSave | |
file(const std::string &filename) | Athena::WiiSave | |
fileCount() const (defined in Athena::WiiSave) | Athena::WiiSave | |
FileIterator typedef | Athena::WiiSave | |
root() | Athena::WiiSave | |
setBanner(WiiBanner *banner) | Athena::WiiSave | |
setRoot(WiiFile *root) (defined in Athena::WiiSave) | Athena::WiiSave | |
WiiSave() | Athena::WiiSave | |
~WiiSave() | Athena::WiiSave | virtual |
+ Athena IO Library
+
+ |
+
Wii data.bin container class. + More...
+ +#include <WiiSave.hpp>
+Public Types | |
+typedef std::unordered_map< std::string, WiiFile * >::const_iterator | FileIterator |
FileIterator. | |
+Public Member Functions | |
+ | WiiSave () |
WiiSave. | |
+virtual | ~WiiSave () |
~WiiSave | |
void | addFile (WiiFile *file) |
addFile More... | |
+void | setRoot (WiiFile *root) |
WiiFile * | file (const std::string &filename) |
file More... | |
+atUint32 | fileCount () const |
WiiFile * | root () |
fileList More... | |
void | setBanner (WiiBanner *banner) |
setBanner More... | |
WiiBanner * | banner () const |
banner More... | |
+std::vector< WiiFile * > | allFiles () const |
Wii data.bin container class.
+Contains all relevant data for a Wii data.bin file.
+ +Definition at line 38 of file WiiSave.hpp.
+void Athena::WiiSave::addFile | +( | +WiiFile * | +file | ) | ++ |
addFile
+filename | |
file |
WiiBanner* Athena::WiiSave::banner | +( | +) | +const | +
banner
+WiiFile* Athena::WiiSave::file | +( | +const std::string & | +filename | ) | ++ |
file
+filename |
WiiFile* Athena::WiiSave::root | +( | +) | ++ |
fileList
+void Athena::WiiSave::setBanner | +( | +WiiBanner * | +banner | ) | ++ |
setBanner
+banner |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::ZQuestFile, including all inherited members.
+
+ Athena IO Library
+
+ |
+
ZQuestFile is an export format for save data. + More...
+ +#include <ZQuestFile.hpp>
+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, 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 (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 |
+atUint8 * | m_data |
+atUint32 | m_length |
ZQuestFile is an export format for save data.
+ +Definition at line 33 of file ZQuestFile.hpp.
+enum Athena::ZQuestFile::Game | +
The list of games currently supported by ZQuest.
+Definition at line 62 of file ZQuestFile.hpp.
+ +Athena::ZQuestFile::ZQuestFile | +( | +Game | +game, | +
+ | + | Endian | +endian, | +
+ | + | atUint8 * | +data, | +
+ | + | atUint32 | +length, | +
+ | + | const std::string & | +gameString = std::string() |
+
+ | ) | ++ |
ZQuest.
+game | |
endian | |
data | |
length |
atUint8* Athena::ZQuestFile::data | +( | +) | +const | +
data
+Endian Athena::ZQuestFile::endian | +( | +) | +const | +
endian
+Game Athena::ZQuestFile::game | +( | +) | +const | +
game
+std::string Athena::ZQuestFile::gameString | +( | +) | +const | +
gameString
+atUint32 Athena::ZQuestFile::length | +( | +) | +const | +
length
+void Athena::ZQuestFile::setData | +( | +atUint8 * | +data, | +
+ | + | atUint32 | +length | +
+ | ) | ++ |
setData
+data | The data to assign |
length | The length of the data |
void Athena::ZQuestFile::setEndian | +( | +Endian | +endian | ) | ++ |
setEndian
+endian |
void Athena::ZQuestFile::setGame | +( | +Game | +game | ) | ++ |
setGame
+game |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::error::Exception, including all inherited members.
+Exception(const std::string &message, const std::string &file, const std::string &function, const int line) | Athena::error::Exception | inline |
file() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
formattedMessage() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
function() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
line() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
m_exceptionName (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_file (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_function (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_line (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_message | Athena::error::Exception | protected |
message() const | Athena::error::Exception | inline |
+ Athena IO Library
+
+ |
+
The baseclass for all Exceptions. + More...
+ +#include <Exception.hpp>
+Public Member Functions | |
Exception (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an Exception. More... | |
std::string | message () const |
Returns the Error message of the exception. More... | |
+std::string | file () const |
+std::string | function () const |
+int | line () const |
+std::string | formattedMessage () const |
+Protected Attributes | |
+std::string | m_message |
The error message string. | |
+std::string | m_file |
+std::string | m_function |
+int | m_line |
+std::string | m_exceptionName |
The baseclass for all Exceptions.
+Do Not use Exception directly, instead create an appropriate Exception class and inherit from this baseclass.
+ +Definition at line 38 of file Exception.hpp.
+
+
|
+ +inline | +
The constructor for an Exception.
+message | The error message to throw |
Definition at line 44 of file Exception.hpp.
+ +
+
|
+ +inline | +
Returns the Error message of the exception.
+Definition at line 56 of file Exception.hpp.
+ +
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::error::FileNotFoundException, including all inherited members.
+
+ Athena IO Library
+
+ |
+
An excpeption thrown when a file could not be found at the given path. + More...
+ +#include <FileNotFoundException.hpp>
+Public Member Functions | |
FileNotFoundException (const std::string &filename, const std::string &file, const std::string &function, const int line) | |
The constructor for an FileNotFoundException. More... | |
std::string | filename () const |
Returns the path of the offending file. More... | |
Public Member Functions inherited from Athena::error::Exception | |
Exception (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an Exception. More... | |
std::string | message () const |
Returns the Error message of the exception. More... | |
+std::string | file () const |
+std::string | function () const |
+int | line () const |
+std::string | formattedMessage () const |
+Additional Inherited Members | |
Protected Attributes inherited from Athena::error::Exception | |
+std::string | m_message |
The error message string. | |
+std::string | m_file |
+std::string | m_function |
+int | m_line |
+std::string | m_exceptionName |
An excpeption thrown when a file could not be found at the given path.
+This should only be thrown when the Stream is unable to open a file.
+
+ It is NOT appropriate to use throw new so avoid doing so, keeping things on the stack as much as possible is very important for speed.
Definition at line 33 of file FileNotFoundException.hpp.
+
+
|
+ +inline | +
The constructor for an FileNotFoundException.
+filename | The path of the offending file. |
Definition at line 39 of file FileNotFoundException.hpp.
+ +
+
|
+ +inline | +
Returns the path of the offending file.
+Definition at line 49 of file FileNotFoundException.hpp.
+ +
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::error::IOException, including all inherited members.
+Exception(const std::string &message, const std::string &file, const std::string &function, const int line) | Athena::error::Exception | inline |
file() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
formattedMessage() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
function() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
IOException(const std::string &message, const std::string &file, const std::string &function, const int line) | Athena::error::IOException | inline |
line() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
m_exceptionName (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_file (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_function (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_line (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_message | Athena::error::Exception | protected |
message() const | Athena::error::Exception | inline |
+ Athena IO Library
+
+ |
+
An excpeption thrown on inappropriate IO calls. + More...
+ +#include <IOException.hpp>
+Public Member Functions | |
IOException (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an IOException. More... | |
Public Member Functions inherited from Athena::error::Exception | |
Exception (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an Exception. More... | |
std::string | message () const |
Returns the Error message of the exception. More... | |
+std::string | file () const |
+std::string | function () const |
+int | line () const |
+std::string | formattedMessage () const |
+Additional Inherited Members | |
Protected Attributes inherited from Athena::error::Exception | |
+std::string | m_message |
The error message string. | |
+std::string | m_file |
+std::string | m_function |
+int | m_line |
+std::string | m_exceptionName |
An excpeption thrown on inappropriate IO calls.
+This should only be thrown when the library tries to write to a buffer e.g when the position is greater than the position and the stream is not set to autoresize.
+
+ It is NOT appropriate to use throw new so avoid doing so, keeping things on the stack as much as possible is very important for speed.
Definition at line 36 of file IOException.hpp.
+
+
|
+ +inline | +
The constructor for an IOException.
+message | The error message to throw |
Definition at line 42 of file IOException.hpp.
+ +
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::error::InvalidDataException, including all inherited members.
+Exception(const std::string &message, const std::string &file, const std::string &function, const int line) | Athena::error::Exception | inline |
file() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
formattedMessage() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
function() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
InvalidDataException(const std::string &error, const std::string &file, const std::string &function, const int line) (defined in Athena::error::InvalidDataException) | Athena::error::InvalidDataException | inline |
line() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
m_exceptionName (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_file (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_function (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_line (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_message | Athena::error::Exception | protected |
message() const | Athena::error::Exception | inline |
+ Athena IO Library
+
+ |
+
An exception thrown on Invalid Data calls. + More...
+ +#include <InvalidDataException.hpp>
+Public Member Functions | |
+ | InvalidDataException (const std::string &error, const std::string &file, const std::string &function, const int line) |
Public Member Functions inherited from Athena::error::Exception | |
Exception (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an Exception. More... | |
std::string | message () const |
Returns the Error message of the exception. More... | |
+std::string | file () const |
+std::string | function () const |
+int | line () const |
+std::string | formattedMessage () const |
+Additional Inherited Members | |
Protected Attributes inherited from Athena::error::Exception | |
+std::string | m_message |
The error message string. | |
+std::string | m_file |
+std::string | m_function |
+int | m_line |
+std::string | m_exceptionName |
An exception thrown on Invalid Data calls.
+This should only be thrown when the library tries to e.g pass a NULL pointer to a function which requires a valid pointer.
+ It is NOT appropriate to use throw new so avoid doing so, keeping things on the stack as much as possible is very important for speed.
Definition at line 35 of file InvalidDataException.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::error::InvalidOperationException, including all inherited members.
+
+ Athena IO Library
+
+ |
+
An excpeption thrown on Invalid Operations calls. + More...
+ +#include <InvalidOperationException.hpp>
+Public Member Functions | |
InvalidOperationException (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an InvalidOperationException. More... | |
Public Member Functions inherited from Athena::error::Exception | |
Exception (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an Exception. More... | |
std::string | message () const |
Returns the Error message of the exception. More... | |
+std::string | file () const |
+std::string | function () const |
+int | line () const |
+std::string | formattedMessage () const |
+Additional Inherited Members | |
Protected Attributes inherited from Athena::error::Exception | |
+std::string | m_message |
The error message string. | |
+std::string | m_file |
+std::string | m_function |
+int | m_line |
+std::string | m_exceptionName |
An excpeption thrown on Invalid Operations calls.
+This should only be thrown when the library tries to e.g pass a NULL pointer to a function which requires a valid pointer.
+ It is NOT appropriate to use throw new so avoid doing so, keeping things on the stack as much as possible is very important for speed.
Definition at line 36 of file InvalidOperationException.hpp.
+
+
|
+ +inline | +
The constructor for an InvalidOperationException.
+error | The error message to throw |
Definition at line 42 of file InvalidOperationException.hpp.
+ +
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::error::NotImplementedException, including all inherited members.
+Exception(const std::string &message, const std::string &file, const std::string &function, const int line) | Athena::error::Exception | inline |
file() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
formattedMessage() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
function() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
line() const (defined in Athena::error::Exception) | Athena::error::Exception | inline |
m_exceptionName (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_file (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_function (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_line (defined in Athena::error::Exception) | Athena::error::Exception | protected |
m_message | Athena::error::Exception | protected |
message() const | Athena::error::Exception | inline |
NotImplementedException(const std::string &message, const std::string &file, const std::string &function, const int line) (defined in Athena::error::NotImplementedException) | Athena::error::NotImplementedException | inline |
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | NotImplementedException (const std::string &message, const std::string &file, const std::string &function, const int line) |
Public Member Functions inherited from Athena::error::Exception | |
Exception (const std::string &message, const std::string &file, const std::string &function, const int line) | |
The constructor for an Exception. More... | |
std::string | message () const |
Returns the Error message of the exception. More... | |
+std::string | file () const |
+std::string | function () const |
+int | line () const |
+std::string | formattedMessage () const |
+Additional Inherited Members | |
Protected Attributes inherited from Athena::error::Exception | |
+std::string | m_message |
The error message string. | |
+std::string | m_file |
+std::string | m_function |
+int | m_line |
+std::string | m_exceptionName |
Definition at line 25 of file NotImplementedException.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::ALTTPFileReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
A Link to the Past save data reader class. + More...
+ +#include <ALTTPFileReader.hpp>
+Public Member Functions | |
ALTTPFileReader (atUint8 *, atUint64) | |
This constructor takes an existing buffer to read from. More... | |
ALTTPFileReader (const std::string &) | |
This constructor creates an instance from a file on disk. More... | |
ALTTPFile * | readFile () |
Reads the SRAM data from the buffer. More... | |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryReader | |
+void | loadData () |
MemoryReader (const atUint8 *data, atUint64 length) | |
This constructor takes an existing buffer to read from. More... | |
MemoryReader (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
std::string | filepath () const |
Returns the target file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
bool | readBit () |
Reads a bit at the current position and advances the current position. More... | |
atInt8 | readByte () |
Reads a byte at the current position and advances the current position. More... | |
atUint8 | readUByte () |
Reads a byte at the current position and advances the current position. More... | |
atInt8 * | readBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
atUint8 * | readUBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
+atUint64 | readBytesToBuf (void *buf, atUint64 len) |
+atUint64 | readUBytesToBuf (void *buf, atUint64 len) |
atInt16 | readInt16 () |
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint16 | readUint16 () |
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt32 | readInt32 () |
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint32 | readUint32 () |
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt64 | readInt64 () |
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint64 | readUint64 () |
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
float | readFloat () |
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
double | readDouble () |
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
bool | readBool () |
Reads a bool and advances the current position. More... | |
std::string | readUnicode (atInt32 maxlen=-1) |
Reads a Unicode string and advances the position in the file. More... | |
std::string | readString (atInt32 maxlen=-1) |
Reads a string and advances the position in the file. More... | |
+void | setProgressCallback (std::function< void(int)> cb) |
Protected Attributes inherited from Athena::io::MemoryReader | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
A Link to the Past save data reader class.
+A Class for reading binary data from an ALTTP Save File, all work is done using a memory buffer, and not read directly from the disk.
Definition at line 38 of file ALTTPFileReader.hpp.
+Athena::io::ALTTPFileReader::ALTTPFileReader | +( | +atUint8 * | +, | +
+ | + | atUint64 | ++ |
+ | ) | ++ |
This constructor takes an existing buffer to read from.
+data | The existing buffer |
length | The length of the existing buffer |
Athena::io::ALTTPFileReader::ALTTPFileReader | +( | +const std::string & | +) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
ALTTPFile* Athena::io::ALTTPFileReader::readFile | +( | +) | ++ |
Reads the SRAM data from the buffer.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::ALTTPFileWriter, including all inherited members.
+ALTTPFileWriter(atUint8 *, atUint64) | Athena::io::ALTTPFileWriter | |
ALTTPFileWriter(const std::string &) | Athena::io::ALTTPFileWriter | |
atEnd() const | Athena::io::MemoryWriter | protectedvirtual |
data() const | Athena::io::MemoryWriter | protected |
endian() const | Athena::io::MemoryWriter | protectedvirtual |
filepath() const | Athena::io::MemoryWriter | protected |
fill(atUint8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
fill(atInt8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
isBigEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isLittleEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isOpen() const | Athena::io::MemoryWriter | protectedvirtual |
length() const | Athena::io::MemoryWriter | protectedvirtual |
loadData() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_bitPosition (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_data (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_endian (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_filepath | Athena::io::MemoryWriter | protected |
m_length (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_position (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_progressCallback (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
MemoryWriter(atUint8 *data=nullptr, atUint64 length=0x10) | Athena::io::MemoryWriter | explicitprotected |
MemoryWriter(const std::string &filename, std::function< void(int)> progressFun=nullptr) | Athena::io::MemoryWriter | protected |
position() const | Athena::io::MemoryWriter | protectedvirtual |
save(const std::string &filename="") | Athena::io::MemoryWriter | protected |
seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current) | Athena::io::MemoryWriter | protectedvirtual |
seekAlign32() | Athena::io::MemoryWriter | inlineprotectedvirtual |
seekBit(int bit) | Athena::io::MemoryWriter | protectedvirtual |
setData(const atUint8 *data, atUint64 length) | Athena::io::MemoryWriter | protected |
setEndian(Endian endian) | Athena::io::MemoryWriter | protectedvirtual |
setFilepath(const std::string &filepath) | Athena::io::MemoryWriter | protected |
setProgressCallback(std::function< void(int)> cb) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
writeBit(bool val) | Athena::io::MemoryWriter | protectedvirtual |
writeBool(bool) | Athena::io::MemoryWriter | protectedvirtual |
writeByte(atInt8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeBytes(atInt8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeDouble(double) | Athena::io::MemoryWriter | protectedvirtual |
writeFile(ALTTPFile *file) | Athena::io::ALTTPFileWriter | |
writeFloat(float) | Athena::io::MemoryWriter | protectedvirtual |
writeInt16(atInt16 val) | Athena::io::MemoryWriter | protectedvirtual |
writeInt32(atInt32) | Athena::io::MemoryWriter | protectedvirtual |
writeInt64(atInt64) | Athena::io::MemoryWriter | protectedvirtual |
writeString(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
writeUByte(atUint8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeUBytes(atUint8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeUint16(atUint16) | Athena::io::MemoryWriter | protectedvirtual |
writeUint32(atUint32) | Athena::io::MemoryWriter | protectedvirtual |
writeUint64(atUint64) | Athena::io::MemoryWriter | protectedvirtual |
writeUnicode(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
~IStream() (defined in Athena::io::IStream) | Athena::io::IStream | inlineprotectedvirtual |
~IStreamWriter() (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | inlineprotectedvirtual |
~MemoryWriter() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
+ Athena IO Library
+
+ |
+
A Link to the Past save data writer class. + More...
+ +#include <ALTTPFileWriter.hpp>
+Public Member Functions | |
ALTTPFileWriter (atUint8 *, atUint64) | |
This constructor takes an existing buffer to write to. More... | |
ALTTPFileWriter (const std::string &) | |
This constructor creates an instance from a file on disk. More... | |
void | writeFile (ALTTPFile *file) |
Writes the given SRAM data to a file on disk. More... | |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryWriter | |
+void | loadData () |
MemoryWriter (atUint8 *data=nullptr, atUint64 length=0x10) | |
This constructor takes an existing buffer to write to. More... | |
MemoryWriter (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
+std::string | filepath () const |
Returns the target file. | |
void | save (const std::string &filename="") |
Saves the file to the specified file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
void | writeBit (bool val) |
Writes a bit at the current position and advances the position by one bit. More... | |
void | writeUByte (atUint8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeByte (atInt8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeUBytes (atUint8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeBytes (atInt8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeInt16 (atInt16 val) |
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint16 (atUint16) |
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt32 (atInt32) |
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint32 (atUint32) |
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt64 (atInt64) |
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint64 (atUint64) |
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeFloat (float) |
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeDouble (double) |
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeBool (bool) |
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUnicode (const std::string &str) |
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeString (const std::string &str) |
Writes an string to the buffer and advances the buffer. More... | |
+void | fill (atUint8 val, atUint64 length) |
+void | fill (atInt8 val, atUint64 length) |
+void | setProgressCallback (std::function< void(int)> cb) |
Protected Attributes inherited from Athena::io::MemoryWriter | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
A Link to the Past save data writer class.
+A Class for writing binary data to an ALTTP Save File, all work is done using a memory buffer, and not written directly to the disk.
Definition at line 37 of file ALTTPFileWriter.hpp.
+Athena::io::ALTTPFileWriter::ALTTPFileWriter | +( | +atUint8 * | +, | +
+ | + | atUint64 | ++ |
+ | ) | ++ |
This constructor takes an existing buffer to write to.
+data | The existing buffer |
length | The length of the existing buffer |
Athena::io::ALTTPFileWriter::ALTTPFileWriter | +( | +const std::string & | +) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
void Athena::io::ALTTPFileWriter::writeFile | +( | +ALTTPFile * | +file | ) | ++ |
Writes the given SRAM data to a file on disk.
+file | SRAM data to right |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::FileReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Protected Attributes | |
+std::string | m_filename |
+FILE * | m_fileHandle |
+Endian | m_endian |
+atUint8 | m_currentByte |
+atUint8 | m_bitShift |
+bool | m_bitValid |
Definition at line 27 of file FileReader.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::FileWriter, including all inherited members.
+atEnd() const (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
close() (defined in Athena::io::FileWriter) | Athena::io::FileWriter | |
endian() const (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
FileWriter(const std::string &filename, bool overwrite=true) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | |
fill(atInt8 byte, atUint64 len) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
fill(atUint8 byte, atUint64 len) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
isBigEndian() const (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
isLittleEndian() const (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
isOpen() const (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
length() const (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
open(bool overwrite=true) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | |
position() const (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
seekAlign32() (defined in Athena::io::FileWriter) | Athena::io::FileWriter | inlinevirtual |
seekBit(int bit) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
setEndian(Endian endian) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeBit(bool val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeBool(bool val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeByte(atInt8 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeBytes(atInt8 *data, atUint64 len) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeDouble(double val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeFloat(float val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeInt16(atInt16 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeInt32(atInt32 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeInt64(atInt64 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeString(const std::string &val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeUByte(atUint8 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeUBytes(atUint8 *data, atUint64 len) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeUint16(atUint16 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeUint32(atUint32 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeUint64(atUint64 val) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
writeUnicode(const std::string &str) (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
~FileWriter() (defined in Athena::io::FileWriter) | Athena::io::FileWriter | virtual |
~IStream() (defined in Athena::io::IStream) | Athena::io::IStream | inlinevirtual |
~IStreamWriter() (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | inlinevirtual |
+ Athena IO Library
+
+ |
+
Definition at line 26 of file FileWriter.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::IStream, including all inherited members.
+atEnd() const =0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
endian() const =0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
isBigEndian() const =0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
isLittleEndian() const =0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
isOpen() const =0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
length() const =0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
position() const =0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
seek(atInt64, SeekOrigin)=0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
seekBit(int)=0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
setEndian(Endian)=0 (defined in Athena::io::IStream) | Athena::io::IStream | pure virtual |
~IStream() (defined in Athena::io::IStream) | Athena::io::IStream | inlinevirtual |
+ Athena IO Library
+
+ |
+
Definition at line 28 of file IStream.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::IStreamReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
Definition at line 10 of file IStreamReader.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::IStreamWriter, including all inherited members.
+atEnd() const =0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
endian() const =0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
fill(atUint8, atUint64)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
fill(atInt8, atUint64)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
isBigEndian() const =0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
isLittleEndian() const =0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
isOpen() const =0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
length() const =0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
position() const =0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
seek(atInt64, SeekOrigin)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
seekAlign32()=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
seekBit(int)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
setEndian(Endian)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeBit(bool)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeBool(bool)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeByte(atInt8)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeBytes(atInt8 *, atUint64)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeDouble(double)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeFloat(float)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeInt16(atInt16)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeInt32(atInt32)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeInt64(atInt64)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeString(const std::string &)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeUByte(atUint8)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeUBytes(atUint8 *, atUint64)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeUint16(atUint16)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeUint32(atUint32)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeUint64(atUint64)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
writeUnicode(const std::string &)=0 (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | pure virtual |
~IStream() (defined in Athena::io::IStream) | Athena::io::IStream | inlinevirtual |
~IStreamWriter() (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | inlinevirtual |
+ Athena IO Library
+
+ |
+
Definition at line 10 of file IStreamWriter.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::MCFileReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
The Minish Cap Save save data reader class. + More...
+ +#include <MCFileReader.hpp>
+Public Member Functions | |
MCFileReader (atUint8 *, atUint64) | |
This constructor takes an existing buffer to read from. More... | |
MCFileReader (const std::string &) | |
This constructor creates an instance from a file on disk. More... | |
MCFile * | readFile () |
Reads the save data from the buffer. More... | |
Public Member Functions inherited from Athena::io::MemoryReader | |
MemoryReader (const atUint8 *data, atUint64 length) | |
This constructor takes an existing buffer to read from. More... | |
MemoryReader (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
std::string | filepath () const |
Returns the target file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
bool | readBit () |
Reads a bit at the current position and advances the current position. More... | |
atInt8 | readByte () |
Reads a byte at the current position and advances the current position. More... | |
atUint8 | readUByte () |
Reads a byte at the current position and advances the current position. More... | |
atInt8 * | readBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
atUint8 * | readUBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
+atUint64 | readBytesToBuf (void *buf, atUint64 len) |
+atUint64 | readUBytesToBuf (void *buf, atUint64 len) |
atInt16 | readInt16 () |
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint16 | readUint16 () |
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt32 | readInt32 () |
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint32 | readUint32 () |
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt64 | readInt64 () |
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint64 | readUint64 () |
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
float | readFloat () |
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
double | readDouble () |
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
bool | readBool () |
Reads a bool and advances the current position. More... | |
std::string | readUnicode (atInt32 maxlen=-1) |
Reads a Unicode string and advances the position in the file. More... | |
std::string | readString (atInt32 maxlen=-1) |
Reads a string and advances the position in the file. More... | |
+void | setProgressCallback (std::function< void(int)> cb) |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryReader | |
+void | loadData () |
Protected Attributes inherited from Athena::io::MemoryReader | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
The Minish Cap Save save data reader class.
+A Class for reading binary data from a The Minish Cap Save File, all work is done using a memory buffer, and not read directly from the disk.
Definition at line 37 of file MCFileReader.hpp.
+Athena::io::MCFileReader::MCFileReader | +( | +atUint8 * | +, | +
+ | + | atUint64 | ++ |
+ | ) | ++ |
This constructor takes an existing buffer to read from.
+data | The existing buffer |
length | The length of the existing buffer |
Athena::io::MCFileReader::MCFileReader | +( | +const std::string & | +) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
MCFile* Athena::io::MCFileReader::readFile | +( | +) | ++ |
Reads the save data from the buffer.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::MCFileWriter, including all inherited members.
+atEnd() const | Athena::io::MemoryWriter | protectedvirtual |
calculateChecksum(atUint8 *data, atUint32 length) (defined in Athena::io::MCFileWriter) | Athena::io::MCFileWriter | static |
data() const | Athena::io::MemoryWriter | protected |
endian() const | Athena::io::MemoryWriter | protectedvirtual |
filepath() const | Athena::io::MemoryWriter | protected |
fill(atUint8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
fill(atInt8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
isBigEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isLittleEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isOpen() const | Athena::io::MemoryWriter | protectedvirtual |
length() const | Athena::io::MemoryWriter | protectedvirtual |
loadData() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_bitPosition (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_data (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_endian (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_filepath | Athena::io::MemoryWriter | protected |
m_length (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_position (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_progressCallback (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
MCFileWriter(atUint8 *, atUint64) | Athena::io::MCFileWriter | |
MCFileWriter(const std::string &) | Athena::io::MCFileWriter | |
MemoryWriter(atUint8 *data=nullptr, atUint64 length=0x10) | Athena::io::MemoryWriter | explicitprotected |
MemoryWriter(const std::string &filename, std::function< void(int)> progressFun=nullptr) | Athena::io::MemoryWriter | protected |
position() const | Athena::io::MemoryWriter | protectedvirtual |
save(const std::string &filename="") | Athena::io::MemoryWriter | protected |
seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current) | Athena::io::MemoryWriter | protectedvirtual |
seekAlign32() | Athena::io::MemoryWriter | inlineprotectedvirtual |
seekBit(int bit) | Athena::io::MemoryWriter | protectedvirtual |
setData(const atUint8 *data, atUint64 length) | Athena::io::MemoryWriter | protected |
setEndian(Endian endian) | Athena::io::MemoryWriter | protectedvirtual |
setFilepath(const std::string &filepath) | Athena::io::MemoryWriter | protected |
setProgressCallback(std::function< void(int)> cb) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
writeBit(bool val) | Athena::io::MemoryWriter | protectedvirtual |
writeBool(bool) | Athena::io::MemoryWriter | protectedvirtual |
writeByte(atInt8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeBytes(atInt8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeDouble(double) | Athena::io::MemoryWriter | protectedvirtual |
writeFile(MCFile *file) | Athena::io::MCFileWriter | |
writeFloat(float) | Athena::io::MemoryWriter | protectedvirtual |
writeInt16(atInt16 val) | Athena::io::MemoryWriter | protectedvirtual |
writeInt32(atInt32) | Athena::io::MemoryWriter | protectedvirtual |
writeInt64(atInt64) | Athena::io::MemoryWriter | protectedvirtual |
writeString(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
writeUByte(atUint8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeUBytes(atUint8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeUint16(atUint16) | Athena::io::MemoryWriter | protectedvirtual |
writeUint32(atUint32) | Athena::io::MemoryWriter | protectedvirtual |
writeUint64(atUint64) | Athena::io::MemoryWriter | protectedvirtual |
writeUnicode(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
~IStream() (defined in Athena::io::IStream) | Athena::io::IStream | inlineprotectedvirtual |
~IStreamWriter() (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | inlineprotectedvirtual |
~MemoryWriter() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
+ Athena IO Library
+
+ |
+
The Minish Cap Save save data writer class. + More...
+ +#include <MCFileWriter.hpp>
+Public Member Functions | |
MCFileWriter (atUint8 *, atUint64) | |
This constructor takes an existing buffer to write to. More... | |
MCFileWriter (const std::string &) | |
This constructor creates an instance from a file on disk. More... | |
void | writeFile (MCFile *file) |
Writes the given save data to a file on disk. More... | |
+Static Public Member Functions | |
+static atUint16 | calculateChecksum (atUint8 *data, atUint32 length) |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryWriter | |
+void | loadData () |
MemoryWriter (atUint8 *data=nullptr, atUint64 length=0x10) | |
This constructor takes an existing buffer to write to. More... | |
MemoryWriter (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
+std::string | filepath () const |
Returns the target file. | |
void | save (const std::string &filename="") |
Saves the file to the specified file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
void | writeBit (bool val) |
Writes a bit at the current position and advances the position by one bit. More... | |
void | writeUByte (atUint8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeByte (atInt8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeUBytes (atUint8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeBytes (atInt8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeInt16 (atInt16 val) |
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint16 (atUint16) |
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt32 (atInt32) |
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint32 (atUint32) |
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt64 (atInt64) |
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint64 (atUint64) |
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeFloat (float) |
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeDouble (double) |
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeBool (bool) |
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUnicode (const std::string &str) |
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeString (const std::string &str) |
Writes an string to the buffer and advances the buffer. More... | |
+void | fill (atUint8 val, atUint64 length) |
+void | fill (atInt8 val, atUint64 length) |
+void | setProgressCallback (std::function< void(int)> cb) |
Protected Attributes inherited from Athena::io::MemoryWriter | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
The Minish Cap Save save data writer class.
+A Class for writing binary data to a The Minish Cap Save File, all work is done using a memory buffer, and not written directly from the disk.
Definition at line 38 of file MCFileWriter.hpp.
+Athena::io::MCFileWriter::MCFileWriter | +( | +atUint8 * | +, | +
+ | + | atUint64 | ++ |
+ | ) | ++ |
This constructor takes an existing buffer to write to.
+data | The existing buffer |
length | The length of the existing buffer |
Athena::io::MCFileWriter::MCFileWriter | +( | +const std::string & | +) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
void Athena::io::MCFileWriter::writeFile | +( | +MCFile * | +file | ) | ++ |
Writes the given save data to a file on disk.
+file | Save data to write |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::MemoryReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
MemoryReader (const atUint8 *data, atUint64 length) | |
This constructor takes an existing buffer to read from. More... | |
MemoryReader (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
std::string | filepath () const |
Returns the target file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
bool | readBit () |
Reads a bit at the current position and advances the current position. More... | |
atInt8 | readByte () |
Reads a byte at the current position and advances the current position. More... | |
atUint8 | readUByte () |
Reads a byte at the current position and advances the current position. More... | |
atInt8 * | readBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
atUint8 * | readUBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
+atUint64 | readBytesToBuf (void *buf, atUint64 len) |
+atUint64 | readUBytesToBuf (void *buf, atUint64 len) |
atInt16 | readInt16 () |
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint16 | readUint16 () |
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt32 | readInt32 () |
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint32 | readUint32 () |
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt64 | readInt64 () |
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint64 | readUint64 () |
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
float | readFloat () |
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
double | readDouble () |
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
bool | readBool () |
Reads a bool and advances the current position. More... | |
std::string | readUnicode (atInt32 maxlen=-1) |
Reads a Unicode string and advances the position in the file. More... | |
std::string | readString (atInt32 maxlen=-1) |
Reads a string and advances the position in the file. More... | |
+void | setProgressCallback (std::function< void(int)> cb) |
+Protected Member Functions | |
+void | loadData () |
+Protected Attributes | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Definition at line 35 of file MemoryReader.hpp.
+Athena::io::MemoryReader::MemoryReader | +( | +const atUint8 * | +data, | +
+ | + | atUint64 | +length | +
+ | ) | ++ |
This constructor takes an existing buffer to read from.
+data | The existing buffer |
length | The length of the existing buffer |
Athena::io::MemoryReader::MemoryReader | +( | +const std::string & | +filename, | +
+ | + | std::function< void(int)> | +progressFun = nullptr |
+
+ | ) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
+
|
+ +virtual | +
Returns whether or not the stream is at the end.
+Implements Athena::io::IStreamReader.
+ +atUint8* Athena::io::MemoryReader::data | +( | +) | +const | +
Returns a copy of the current buffer.
+ Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information.
+ However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down.
+
|
+ +virtual | +
Returns the current Endianness of the stream.
+Implements Athena::io::IStreamReader.
+ +std::string Athena::io::MemoryReader::filepath | +( | +) | +const | +
Returns the target file.
+ +
+
|
+ +virtual | +
Returns whether the stream is BigEndian.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Returns whether the stream is LittleEndian.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Retuns whether or not the Stream is open.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Returns whether or not the stream is at the end.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Returns the current position in the stream.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a bit at the current position and advances the current position.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a bool and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a byte at the current position and advances the current position.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +inlinevirtual | +
Reads a byte at the current position and advances the current position.
+Implements Athena::io::IStreamReader.
+ +Definition at line 173 of file MemoryReader.hpp.
+ +
+
|
+ +virtual | +
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a string and advances the position in the file.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a byte at the current position and advances the current position.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a byte at the current position and advances the current position.
+Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Reads a Unicode string and advances the position in the file.
+IOException | when address is out of range |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Sets the buffers position relative to the specified position.
+ It seeks relative to the current position by default.
position | where in the buffer to seek |
origin | The Origin to seek |
Implements Athena::io::IStreamReader.
+ +
+
|
+ +virtual | +
Seeks to the specified bit within the current byte.
+bit | Bit to seek to, range is 0 - 7 |
Implements Athena::io::IStreamReader.
+ +void Athena::io::MemoryReader::setData | +( | +const atUint8 * | +data, | +
+ | + | atUint64 | +length | +
+ | ) | ++ |
Sets the buffer to the given one, deleting the current one.
+ BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent.
+ Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down.
data | The new buffer. |
length | The length of the new buffer. |
IOException |
+
|
+ +virtual | +
Sets the Endianss of the stream.
+endian | The Endianess to set |
Implements Athena::io::IStreamReader.
+ +void Athena::io::MemoryReader::setFilepath | +( | +const std::string & | +filepath | ) | ++ |
Sets the target file.
+filepath | The path to write to. |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::MemoryWriter, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
MemoryWriter (atUint8 *data=nullptr, atUint64 length=0x10) | |
This constructor takes an existing buffer to write to. More... | |
MemoryWriter (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
+std::string | filepath () const |
Returns the target file. | |
void | save (const std::string &filename="") |
Saves the file to the specified file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
void | writeBit (bool val) |
Writes a bit at the current position and advances the position by one bit. More... | |
void | writeUByte (atUint8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeByte (atInt8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeUBytes (atUint8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeBytes (atInt8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeInt16 (atInt16 val) |
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint16 (atUint16) |
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt32 (atInt32) |
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint32 (atUint32) |
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt64 (atInt64) |
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint64 (atUint64) |
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeFloat (float) |
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeDouble (double) |
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeBool (bool) |
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUnicode (const std::string &str) |
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeString (const std::string &str) |
Writes an string to the buffer and advances the buffer. More... | |
+void | fill (atUint8 val, atUint64 length) |
+void | fill (atInt8 val, atUint64 length) |
+void | setProgressCallback (std::function< void(int)> cb) |
+Protected Member Functions | |
+void | loadData () |
+Protected Attributes | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Definition at line 36 of file MemoryWriter.hpp.
+
+
|
+ +explicit | +
This constructor takes an existing buffer to write to.
+data | The existing buffer |
length | The length of the existing buffer |
Athena::io::MemoryWriter::MemoryWriter | +( | +const std::string & | +filename, | +
+ | + | std::function< void(int)> | +progressFun = nullptr |
+
+ | ) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
+
|
+ +virtual | +
Returns whether or not the stream is at the end.
+Implements Athena::io::IStreamWriter.
+ +atUint8* Athena::io::MemoryWriter::data | +( | +) | +const | +
Returns a copy of the current buffer.
+ Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information.
+ However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down.
+
|
+ +virtual | +
Returns the current Endianness of the stream.
+Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Returns whether the stream is BigEndian.
+Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Returns whether the stream is LittleEndian.
+Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Retuns whether or not the Stream is open.
+Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Returns whether or not the stream is at the end.
+Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Returns the current position in the stream.
+Implements Athena::io::IStreamWriter.
+ +void Athena::io::MemoryWriter::save | +( | +const std::string & | +filename = "" | ) | ++ |
Saves the file to the specified file.
+filename | If not empty, the filename to save to |
+
|
+ +virtual | +
Sets the buffers position relative to the specified position.
+ It seeks relative to the current position by default.
position | where in the buffer to seek |
origin | The Origin to seek |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Seeks to the specified bit within the current byte.
+bit | Bit to seek to, range is 0 - 7 |
Implements Athena::io::IStreamWriter.
+ +void Athena::io::MemoryWriter::setData | +( | +const atUint8 * | +data, | +
+ | + | atUint64 | +length | +
+ | ) | ++ |
Sets the buffer to the given one, deleting the current one.
+ BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent.
+ Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down.
data | The new buffer. |
length | The length of the new buffer. |
IOException |
+
|
+ +virtual | +
Sets the Endianss of the stream.
+endian | The Endianess to set |
Implements Athena::io::IStreamWriter.
+ +void Athena::io::MemoryWriter::setFilepath | +( | +const std::string & | +filepath | ) | ++ |
Sets the target file.
+filepath | The path to write to. |
+
|
+ +virtual | +
Writes a bit at the current position and advances the position by one bit.
+val | the value to write |
IOException |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes a byte at the current position and advances the position by one byte.
+byte | The value to write |
IOException |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length.
+data | The buffer to write |
length | The amount to write |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an string to the buffer and advances the buffer.
+str | The string to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes a byte at the current position and advances the position by one byte.
+byte | The value to write |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length.
+data | The buffer to write |
length | The amount to write |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+val | The value to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+
|
+ +virtual | +
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings.
+str | The string to write to the buffer |
Implements Athena::io::IStreamWriter.
+ +
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::SkywardSwordFileReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | SkywardSwordFileReader (atUint8 *data, atUint64 length) |
+ | SkywardSwordFileReader (const std::string &filename) |
+SkywardSwordFile * | read () |
Public Member Functions inherited from Athena::io::MemoryReader | |
MemoryReader (const atUint8 *data, atUint64 length) | |
This constructor takes an existing buffer to read from. More... | |
MemoryReader (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
std::string | filepath () const |
Returns the target file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
bool | readBit () |
Reads a bit at the current position and advances the current position. More... | |
atInt8 | readByte () |
Reads a byte at the current position and advances the current position. More... | |
atUint8 | readUByte () |
Reads a byte at the current position and advances the current position. More... | |
atInt8 * | readBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
atUint8 * | readUBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
+atUint64 | readBytesToBuf (void *buf, atUint64 len) |
+atUint64 | readUBytesToBuf (void *buf, atUint64 len) |
atInt16 | readInt16 () |
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint16 | readUint16 () |
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt32 | readInt32 () |
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint32 | readUint32 () |
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt64 | readInt64 () |
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint64 | readUint64 () |
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
float | readFloat () |
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
double | readDouble () |
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
bool | readBool () |
Reads a bool and advances the current position. More... | |
std::string | readUnicode (atInt32 maxlen=-1) |
Reads a Unicode string and advances the position in the file. More... | |
std::string | readString (atInt32 maxlen=-1) |
Reads a string and advances the position in the file. More... | |
+void | setProgressCallback (std::function< void(int)> cb) |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryReader | |
+void | loadData () |
Protected Attributes inherited from Athena::io::MemoryReader | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Definition at line 27 of file SkywardSwordFileReader.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::SkywardSwordFileWriter, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | SkywardSwordFileWriter (atUint8 *data, atUint64 len) |
+ | SkywardSwordFileWriter (const std::string &filename) |
+void | write (SkywardSwordFile *file) |
Public Member Functions inherited from Athena::io::MemoryWriter | |
MemoryWriter (atUint8 *data=nullptr, atUint64 length=0x10) | |
This constructor takes an existing buffer to write to. More... | |
MemoryWriter (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
+std::string | filepath () const |
Returns the target file. | |
void | save (const std::string &filename="") |
Saves the file to the specified file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
void | writeBit (bool val) |
Writes a bit at the current position and advances the position by one bit. More... | |
void | writeUByte (atUint8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeByte (atInt8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeUBytes (atUint8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeBytes (atInt8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeInt16 (atInt16 val) |
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint16 (atUint16) |
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt32 (atInt32) |
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint32 (atUint32) |
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt64 (atInt64) |
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint64 (atUint64) |
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeFloat (float) |
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeDouble (double) |
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeBool (bool) |
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUnicode (const std::string &str) |
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeString (const std::string &str) |
Writes an string to the buffer and advances the buffer. More... | |
+void | fill (atUint8 val, atUint64 length) |
+void | fill (atInt8 val, atUint64 length) |
+void | setProgressCallback (std::function< void(int)> cb) |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryWriter | |
+void | loadData () |
Protected Attributes inherited from Athena::io::MemoryWriter | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Definition at line 29 of file SkywardSwordFileWriter.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::SpriteFileReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | SpriteFileReader (atUint8 *data, atUint64 length) |
+ | SpriteFileReader (const std::string &filepath) |
+Sakura::SpriteFile * | readFile () |
Public Member Functions inherited from Athena::io::MemoryReader | |
MemoryReader (const atUint8 *data, atUint64 length) | |
This constructor takes an existing buffer to read from. More... | |
MemoryReader (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
std::string | filepath () const |
Returns the target file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
bool | readBit () |
Reads a bit at the current position and advances the current position. More... | |
atInt8 | readByte () |
Reads a byte at the current position and advances the current position. More... | |
atUint8 | readUByte () |
Reads a byte at the current position and advances the current position. More... | |
atInt8 * | readBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
atUint8 * | readUBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
+atUint64 | readBytesToBuf (void *buf, atUint64 len) |
+atUint64 | readUBytesToBuf (void *buf, atUint64 len) |
atInt16 | readInt16 () |
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint16 | readUint16 () |
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt32 | readInt32 () |
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint32 | readUint32 () |
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt64 | readInt64 () |
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint64 | readUint64 () |
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
float | readFloat () |
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
double | readDouble () |
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
bool | readBool () |
Reads a bool and advances the current position. More... | |
std::string | readUnicode (atInt32 maxlen=-1) |
Reads a Unicode string and advances the position in the file. More... | |
std::string | readString (atInt32 maxlen=-1) |
Reads a string and advances the position in the file. More... | |
+void | setProgressCallback (std::function< void(int)> cb) |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryReader | |
+void | loadData () |
Protected Attributes inherited from Athena::io::MemoryReader | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Definition at line 32 of file SpriteFileReader.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::SpriteFileWriter, including all inherited members.
+
+ Athena IO Library
+
+ |
+
+Public Member Functions | |
+ | SpriteFileWriter (atUint8 *data, atUint64 length) |
+ | SpriteFileWriter (const std::string &filepath) |
+void | writeFile (Sakura::SpriteFile *file) |
Public Member Functions inherited from Athena::io::MemoryWriter | |
MemoryWriter (atUint8 *data=nullptr, atUint64 length=0x10) | |
This constructor takes an existing buffer to write to. More... | |
MemoryWriter (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
+std::string | filepath () const |
Returns the target file. | |
void | save (const std::string &filename="") |
Saves the file to the specified file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
void | writeBit (bool val) |
Writes a bit at the current position and advances the position by one bit. More... | |
void | writeUByte (atUint8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeByte (atInt8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeUBytes (atUint8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeBytes (atInt8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeInt16 (atInt16 val) |
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint16 (atUint16) |
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt32 (atInt32) |
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint32 (atUint32) |
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt64 (atInt64) |
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint64 (atUint64) |
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeFloat (float) |
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeDouble (double) |
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeBool (bool) |
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUnicode (const std::string &str) |
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeString (const std::string &str) |
Writes an string to the buffer and advances the buffer. More... | |
+void | fill (atUint8 val, atUint64 length) |
+void | fill (atInt8 val, atUint64 length) |
+void | setProgressCallback (std::function< void(int)> cb) |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryWriter | |
+void | loadData () |
Protected Attributes inherited from Athena::io::MemoryWriter | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Definition at line 32 of file SpriteFileWriter.hpp.
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::WiiSaveReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
Wii data.bin reader class. + More...
+ +#include <WiiSaveReader.hpp>
+Public Member Functions | |
WiiSaveReader (const atUint8 *, atUint64) | |
This constructor takes an existing buffer to read from. More... | |
WiiSaveReader (const std::string &) | |
This constructor creates an instance from a file on disk. More... | |
WiiSave * | readSave () |
readSave More... | |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryReader | |
+void | loadData () |
MemoryReader (const atUint8 *data, atUint64 length) | |
This constructor takes an existing buffer to read from. More... | |
MemoryReader (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
std::string | filepath () const |
Returns the target file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
bool | readBit () |
Reads a bit at the current position and advances the current position. More... | |
atInt8 | readByte () |
Reads a byte at the current position and advances the current position. More... | |
atUint8 | readUByte () |
Reads a byte at the current position and advances the current position. More... | |
atInt8 * | readBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
atUint8 * | readUBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
+atUint64 | readBytesToBuf (void *buf, atUint64 len) |
+atUint64 | readUBytesToBuf (void *buf, atUint64 len) |
atInt16 | readInt16 () |
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint16 | readUint16 () |
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt32 | readInt32 () |
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint32 | readUint32 () |
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt64 | readInt64 () |
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint64 | readUint64 () |
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
float | readFloat () |
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
double | readDouble () |
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
bool | readBool () |
Reads a bool and advances the current position. More... | |
std::string | readUnicode (atInt32 maxlen=-1) |
Reads a Unicode string and advances the position in the file. More... | |
std::string | readString (atInt32 maxlen=-1) |
Reads a string and advances the position in the file. More... | |
+void | setProgressCallback (std::function< void(int)> cb) |
Protected Attributes inherited from Athena::io::MemoryReader | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Wii data.bin reader class.
+A Class for reading binary data from a wii data.bin file, all work is done using a memory buffer, and not read directly from the disk.
Definition at line 40 of file WiiSaveReader.hpp.
+Athena::io::WiiSaveReader::WiiSaveReader | +( | +const atUint8 * | +, | +
+ | + | atUint64 | ++ |
+ | ) | ++ |
This constructor takes an existing buffer to read from.
+data | The existing buffer |
length | The length of the existing buffer |
Athena::io::WiiSaveReader::WiiSaveReader | +( | +const std::string & | +) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
WiiSave* Athena::io::WiiSaveReader::readSave | +( | +) | ++ |
readSave
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::WiiSaveWriter, including all inherited members.
+atEnd() const | Athena::io::MemoryWriter | protectedvirtual |
data() const | Athena::io::MemoryWriter | protected |
endian() const | Athena::io::MemoryWriter | protectedvirtual |
filepath() const | Athena::io::MemoryWriter | protected |
fill(atUint8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
fill(atInt8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
isBigEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isLittleEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isOpen() const | Athena::io::MemoryWriter | protectedvirtual |
length() const | Athena::io::MemoryWriter | protectedvirtual |
loadData() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_bitPosition (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_data (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_endian (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_filepath | Athena::io::MemoryWriter | protected |
m_length (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_position (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_progressCallback (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
MemoryWriter(atUint8 *data=nullptr, atUint64 length=0x10) | Athena::io::MemoryWriter | explicitprotected |
MemoryWriter(const std::string &filename, std::function< void(int)> progressFun=nullptr) | Athena::io::MemoryWriter | protected |
position() const | Athena::io::MemoryWriter | protectedvirtual |
save(const std::string &filename="") | Athena::io::MemoryWriter | protected |
seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current) | Athena::io::MemoryWriter | protectedvirtual |
seekAlign32() | Athena::io::MemoryWriter | inlineprotectedvirtual |
seekBit(int bit) | Athena::io::MemoryWriter | protectedvirtual |
setData(const atUint8 *data, atUint64 length) | Athena::io::MemoryWriter | protected |
setEndian(Endian endian) | Athena::io::MemoryWriter | protectedvirtual |
setFilepath(const std::string &filepath) | Athena::io::MemoryWriter | protected |
setProgressCallback(std::function< void(int)> cb) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
WiiSaveWriter(const std::string &) | Athena::io::WiiSaveWriter | |
writeBit(bool val) | Athena::io::MemoryWriter | protectedvirtual |
writeBool(bool) | Athena::io::MemoryWriter | protectedvirtual |
writeByte(atInt8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeBytes(atInt8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeDouble(double) | Athena::io::MemoryWriter | protectedvirtual |
writeFloat(float) | Athena::io::MemoryWriter | protectedvirtual |
writeInt16(atInt16 val) | Athena::io::MemoryWriter | protectedvirtual |
writeInt32(atInt32) | Athena::io::MemoryWriter | protectedvirtual |
writeInt64(atInt64) | Athena::io::MemoryWriter | protectedvirtual |
writeSave(WiiSave *save, atUint8 *macAddress, atUint32 ngId, atUint8 *ngPriv, atUint8 *ngSig, atUint32 ngKeyId, const std::string &filepath="") | Athena::io::WiiSaveWriter | |
writeString(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
writeUByte(atUint8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeUBytes(atUint8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeUint16(atUint16) | Athena::io::MemoryWriter | protectedvirtual |
writeUint32(atUint32) | Athena::io::MemoryWriter | protectedvirtual |
writeUint64(atUint64) | Athena::io::MemoryWriter | protectedvirtual |
writeUnicode(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
~IStream() (defined in Athena::io::IStream) | Athena::io::IStream | inlineprotectedvirtual |
~IStreamWriter() (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | inlineprotectedvirtual |
~MemoryWriter() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
+ Athena IO Library
+
+ |
+
Wii data.bin writer class. + More...
+ +#include <WiiSaveWriter.hpp>
+Public Member Functions | |
WiiSaveWriter (const std::string &) | |
This constructor creates an instance from a file on disk. More... | |
bool | writeSave (WiiSave *save, atUint8 *macAddress, atUint32 ngId, atUint8 *ngPriv, atUint8 *ngSig, atUint32 ngKeyId, const std::string &filepath="") |
writeSave More... | |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryWriter | |
+void | loadData () |
MemoryWriter (atUint8 *data=nullptr, atUint64 length=0x10) | |
This constructor takes an existing buffer to write to. More... | |
MemoryWriter (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
+std::string | filepath () const |
Returns the target file. | |
void | save (const std::string &filename="") |
Saves the file to the specified file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
void | writeBit (bool val) |
Writes a bit at the current position and advances the position by one bit. More... | |
void | writeUByte (atUint8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeByte (atInt8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeUBytes (atUint8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeBytes (atInt8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeInt16 (atInt16 val) |
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint16 (atUint16) |
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt32 (atInt32) |
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint32 (atUint32) |
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt64 (atInt64) |
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint64 (atUint64) |
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeFloat (float) |
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeDouble (double) |
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeBool (bool) |
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUnicode (const std::string &str) |
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeString (const std::string &str) |
Writes an string to the buffer and advances the buffer. More... | |
+void | fill (atUint8 val, atUint64 length) |
+void | fill (atInt8 val, atUint64 length) |
+void | setProgressCallback (std::function< void(int)> cb) |
Protected Attributes inherited from Athena::io::MemoryWriter | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
Wii data.bin writer class.
+A Class for writing binary data to a wii data.bin file, all work is done using a memory buffer, and not written directly to the disk.
Definition at line 39 of file WiiSaveWriter.hpp.
+Athena::io::WiiSaveWriter::WiiSaveWriter | +( | +const std::string & | +) | ++ |
This constructor creates an instance from a file on disk.
+filename | The file to create the stream from |
bool Athena::io::WiiSaveWriter::writeSave | +( | +WiiSave * | +save, | +
+ | + | atUint8 * | +macAddress, | +
+ | + | atUint32 | +ngId, | +
+ | + | atUint8 * | +ngPriv, | +
+ | + | atUint8 * | +ngSig, | +
+ | + | atUint32 | +ngKeyId, | +
+ | + | const std::string & | +filepath = "" |
+
+ | ) | ++ |
writeSave
+save | |
macAddress | |
ngId | |
ngPriv | |
ngSig | |
ngKeyId | |
filepath |
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::ZQuestFileReader, including all inherited members.
+
+ Athena IO Library
+
+ |
+
The ZQuestFileReader class. + More...
+ +#include <ZQuestFileReader.hpp>
+Public Member Functions | |
ZQuestFileReader (atUint8 *data, atUint64 length) | |
ZQuestFileReader. More... | |
ZQuestFileReader (const std::string &filename) | |
ZQuestFileReader. More... | |
ZQuestFile * | read () |
read More... | |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryReader | |
+void | loadData () |
MemoryReader (const atUint8 *data, atUint64 length) | |
This constructor takes an existing buffer to read from. More... | |
MemoryReader (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
std::string | filepath () const |
Returns the target file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
bool | readBit () |
Reads a bit at the current position and advances the current position. More... | |
atInt8 | readByte () |
Reads a byte at the current position and advances the current position. More... | |
atUint8 | readUByte () |
Reads a byte at the current position and advances the current position. More... | |
atInt8 * | readBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
atUint8 * | readUBytes (atUint64 length) |
Reads a byte at the current position and advances the current position. More... | |
+atUint64 | readBytesToBuf (void *buf, atUint64 len) |
+atUint64 | readUBytesToBuf (void *buf, atUint64 len) |
atInt16 | readInt16 () |
Reads a Int16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint16 | readUint16 () |
Reads a Uint16 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt32 | readInt32 () |
Reads a Int32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint32 | readUint32 () |
Reads a Uint32 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atInt64 | readInt64 () |
Reads a Int64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
atUint64 | readUint64 () |
Reads a Uint64 and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
float | readFloat () |
Reads a float and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
double | readDouble () |
Reads a double and swaps to proper endianness depending on platform and Stream settings, and advances the current position. More... | |
bool | readBool () |
Reads a bool and advances the current position. More... | |
std::string | readUnicode (atInt32 maxlen=-1) |
Reads a Unicode string and advances the position in the file. More... | |
std::string | readString (atInt32 maxlen=-1) |
Reads a string and advances the position in the file. More... | |
+void | setProgressCallback (std::function< void(int)> cb) |
Protected Attributes inherited from Athena::io::MemoryReader | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
The ZQuestFileReader class.
+ +Definition at line 32 of file ZQuestFileReader.hpp.
+Athena::io::ZQuestFileReader::ZQuestFileReader | +( | +atUint8 * | +data, | +
+ | + | atUint64 | +length | +
+ | ) | ++ |
data | |
length |
Athena::io::ZQuestFileReader::ZQuestFileReader | +( | +const std::string & | +filename | ) | ++ |
filename |
ZQuestFile* Athena::io::ZQuestFileReader::read | +( | +) | ++ |
read
+
+ Athena IO Library
+
+ |
+
This is the complete list of members for Athena::io::ZQuestFileWriter, including all inherited members.
+atEnd() const | Athena::io::MemoryWriter | protectedvirtual |
data() const | Athena::io::MemoryWriter | protected |
endian() const | Athena::io::MemoryWriter | protectedvirtual |
filepath() const | Athena::io::MemoryWriter | protected |
fill(atUint8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
fill(atInt8 val, atUint64 length) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
isBigEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isLittleEndian() const | Athena::io::MemoryWriter | protectedvirtual |
isOpen() const | Athena::io::MemoryWriter | protectedvirtual |
length() const | Athena::io::MemoryWriter | protectedvirtual |
loadData() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_bitPosition (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_data (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_endian (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_filepath | Athena::io::MemoryWriter | protected |
m_length (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_position (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
m_progressCallback (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
MemoryWriter(atUint8 *data=nullptr, atUint64 length=0x10) | Athena::io::MemoryWriter | explicitprotected |
MemoryWriter(const std::string &filename, std::function< void(int)> progressFun=nullptr) | Athena::io::MemoryWriter | protected |
position() const | Athena::io::MemoryWriter | protectedvirtual |
save(const std::string &filename="") | Athena::io::MemoryWriter | protected |
seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current) | Athena::io::MemoryWriter | protectedvirtual |
seekAlign32() | Athena::io::MemoryWriter | inlineprotectedvirtual |
seekBit(int bit) | Athena::io::MemoryWriter | protectedvirtual |
setData(const atUint8 *data, atUint64 length) | Athena::io::MemoryWriter | protected |
setEndian(Endian endian) | Athena::io::MemoryWriter | protectedvirtual |
setFilepath(const std::string &filepath) | Athena::io::MemoryWriter | protected |
setProgressCallback(std::function< void(int)> cb) (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protected |
write(ZQuestFile *quest, bool compress=true) | Athena::io::ZQuestFileWriter | |
writeBit(bool val) | Athena::io::MemoryWriter | protectedvirtual |
writeBool(bool) | Athena::io::MemoryWriter | protectedvirtual |
writeByte(atInt8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeBytes(atInt8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeDouble(double) | Athena::io::MemoryWriter | protectedvirtual |
writeFloat(float) | Athena::io::MemoryWriter | protectedvirtual |
writeInt16(atInt16 val) | Athena::io::MemoryWriter | protectedvirtual |
writeInt32(atInt32) | Athena::io::MemoryWriter | protectedvirtual |
writeInt64(atInt64) | Athena::io::MemoryWriter | protectedvirtual |
writeString(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
writeUByte(atUint8 val) | Athena::io::MemoryWriter | protectedvirtual |
writeUBytes(atUint8 *data, atUint64 len) | Athena::io::MemoryWriter | protectedvirtual |
writeUint16(atUint16) | Athena::io::MemoryWriter | protectedvirtual |
writeUint32(atUint32) | Athena::io::MemoryWriter | protectedvirtual |
writeUint64(atUint64) | Athena::io::MemoryWriter | protectedvirtual |
writeUnicode(const std::string &str) | Athena::io::MemoryWriter | protectedvirtual |
ZQuestFileWriter(atUint8 *data, atUint64 length) | Athena::io::ZQuestFileWriter | |
ZQuestFileWriter(const std::string &filename) | Athena::io::ZQuestFileWriter | |
~IStream() (defined in Athena::io::IStream) | Athena::io::IStream | inlineprotectedvirtual |
~IStreamWriter() (defined in Athena::io::IStreamWriter) | Athena::io::IStreamWriter | inlineprotectedvirtual |
~MemoryWriter() (defined in Athena::io::MemoryWriter) | Athena::io::MemoryWriter | protectedvirtual |
+ Athena IO Library
+
+ |
+
The ZQuestFileWriter class. + More...
+ +#include <ZQuestFileWriter.hpp>
+Public Member Functions | |
ZQuestFileWriter (atUint8 *data, atUint64 length) | |
ZQuestFileWriter. More... | |
ZQuestFileWriter (const std::string &filename) | |
ZQuestFileWriter. More... | |
void | write (ZQuestFile *quest, bool compress=true) |
write More... | |
+Additional Inherited Members | |
Protected Member Functions inherited from Athena::io::MemoryWriter | |
+void | loadData () |
MemoryWriter (atUint8 *data=nullptr, atUint64 length=0x10) | |
This constructor takes an existing buffer to write to. More... | |
MemoryWriter (const std::string &filename, std::function< void(int)> progressFun=nullptr) | |
This constructor creates an instance from a file on disk. More... | |
void | setEndian (Endian endian) |
Sets the Endianss of the stream. More... | |
Endian | endian () const |
Returns the current Endianness of the stream. More... | |
bool | isBigEndian () const |
Returns whether the stream is BigEndian. More... | |
bool | isLittleEndian () const |
Returns whether the stream is LittleEndian. More... | |
bool | isOpen () const |
Retuns whether or not the Stream is open. More... | |
void | seek (atInt64 pos, SeekOrigin origin=SeekOrigin::Current) |
Sets the buffers position relative to the specified position. + It seeks relative to the current position by default. More... | |
+void | seekAlign32 () |
Sets the buffers position relative to the next 32-byte aligned position. + | |
bool | atEnd () const |
Returns whether or not the stream is at the end. More... | |
atUint64 | position () const |
Returns the current position in the stream. More... | |
atUint64 | length () const |
Returns whether or not the stream is at the end. More... | |
void | setData (const atUint8 *data, atUint64 length) |
Sets the buffer to the given one, deleting the current one. + BEWARE: As this deletes the current buffer it WILL cause a loss of data if that was not the intent. + Once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
atUint8 * | data () const |
Returns a copy of the current buffer. + Changes to the copy do not affect the buffer so it's perfectly safe to directly edit the buffer and use setData to set the new information. + However once you pass the data to setData DO NOT delete the buffer as Stream now owns the address, this is done to keep memory usage down. More... | |
void | setFilepath (const std::string &filepath) |
Sets the target file. More... | |
+std::string | filepath () const |
Returns the target file. | |
void | save (const std::string &filename="") |
Saves the file to the specified file. More... | |
void | seekBit (int bit) |
Seeks to the specified bit within the current byte. More... | |
void | writeBit (bool val) |
Writes a bit at the current position and advances the position by one bit. More... | |
void | writeUByte (atUint8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeByte (atInt8 val) |
Writes a byte at the current position and advances the position by one byte. More... | |
void | writeUBytes (atUint8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeBytes (atInt8 *data, atUint64 len) |
Writes the given buffer with the specified length, buffers can be bigger than the length however it's undefined behavior to try and write a buffer which is smaller than the given length. More... | |
void | writeInt16 (atInt16 val) |
Writes an Int16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint16 (atUint16) |
Writes an Uint16 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt32 (atInt32) |
Writes an Int32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint32 (atUint32) |
Writes an Uint32 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeInt64 (atInt64) |
Writes an Int64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUint64 (atUint64) |
Writes an Uint64 to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeFloat (float) |
Writes an float to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeDouble (double) |
Writes an double to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeBool (bool) |
Writes an bool to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeUnicode (const std::string &str) |
Writes an unicode string to the buffer and advances the buffer. It also swaps the bytes depending on the platform and Stream settings. More... | |
void | writeString (const std::string &str) |
Writes an string to the buffer and advances the buffer. More... | |
+void | fill (atUint8 val, atUint64 length) |
+void | fill (atInt8 val, atUint64 length) |
+void | setProgressCallback (std::function< void(int)> cb) |
Protected Attributes inherited from Athena::io::MemoryWriter | |
+atUint8 * | m_data |
+atUint64 | m_length |
+std::string | m_filepath |
Path to the target file. | |
+atUint64 | m_position |
+atUint64 | m_bitPosition |
+Endian | m_endian |
+std::function< void(int)> | m_progressCallback |
The ZQuestFileWriter class.
+ +Definition at line 32 of file ZQuestFileWriter.hpp.
+Athena::io::ZQuestFileWriter::ZQuestFileWriter | +( | +atUint8 * | +data, | +
+ | + | atUint64 | +length | +
+ | ) | ++ |
data | |
length |
Athena::io::ZQuestFileWriter::ZQuestFileWriter | +( | +const std::string & | +filename | ) | ++ |
filename |
void Athena::io::ZQuestFileWriter::write | +( | +ZQuestFile * | +quest, | +
+ | + | bool | +compress = true |
+
+ | ) | ++ |
write
+quest | |
compress |
+ Athena IO Library
+
+ |
+
A Stream class for reading binary data. + More...
+ +#include <MemoryReader.hpp>
A Stream class for reading binary data.
+A Class for reading binary data from a file or memory stream, all work is done using a memory buffer, and not read directly from the disk this allows for fast, flexible code as well as the ability to quickly modify data
+ Athena IO Library
+
+ |
+
A Stream class for writing binary data. + More...
+ +#include <MemoryWriter.hpp>
A Stream class for writing binary data.
+A Class for writing binary data to a file or memory stream, all work is done using a memory buffer, and not written directly to the disk this allows for fast, flexible code as well as the ability to quickly modify data
+ Athena IO Library
+
+ |
+
|
| InvalidOperationException (Athena::error) | SkywardSwordFileWriter (Athena::io) | WiiBanner (Athena) | ||
IOException (Athena::error) | SpriteFileReader (Athena::io) | WiiFile (Athena) | ||||
ALTTPAbilities (Athena) | BinaryReader | IStream (Athena::io) | SpriteFileWriter (Athena::io) | WiiImage (Athena) | ||
ALTTPCrystals (Athena) | BinaryWriter | IStreamReader (Athena::io) | Sprite (Athena::Sakura) | WiiSave (Athena) | ||
ALTTPDungeonItemFlags (Athena) |
| IStreamWriter (Athena::io) | SpriteFile (Athena::Sakura) |
| ||
ALTTPFile (Athena) |
| SpriteFrame (Athena::Sakura) | ||||
ALTTPInventory (Athena) | Dir (Athena) | SpritePart (Athena::Sakura) | ZQuestFileReader (Athena::io) | |||
ALTTPLightDarkWorldIndicator (Athena) |
| MCFileReader (Athena::io) | STexture (Athena::Sakura) | ZQuestFileWriter (Athena::io) | ||
ALTTPMagicUsage (Athena) | MCFileWriter (Athena::io) | SkywardSwordFile (Athena) | ZQuestFile (Athena) | |||
ALTTPOverworldEvent (Athena) | Exception (Athena::error) | MemoryReader (Athena::io) | SkywardSwordQuest (Athena) | |||
ALTTPPendants (Athena) |
| MemoryWriter (Athena::io) |
| |||
ALTTPProgressFlags1 (Athena) | MCFile (Athena) | |||||
ALTTPProgressFlags2 (Athena) | FileNotFoundException (Athena::error) | MCSlot (Athena) | Vector2D (Athena::Sakura) | |||
ALTTPQuest (Athena) | FileInfo (Athena) |
|
| |||
ALTTPRoomFlags (Athena) | FileReader (Athena::io) | |||||
ALTTPFileReader (Athena::io) | FileWriter (Athena::io) | NotImplementedException (Athena::error) | WiiSaveReader (Athena::io) | |||
ALTTPFileWriter (Athena::io) |
|
| WiiSaveWriter (Athena::io) | |||
InvalidDataException (Athena::error) | SkywardSwordFileReader (Athena::io) | |||||
+ Athena IO Library
+
+ |
+
+Files | |
file | ALTTPEnums.hpp [code] |
file | ALTTPFile.hpp [code] |
file | ALTTPFileReader.hpp [code] |
file | ALTTPFileWriter.hpp [code] |
file | ALTTPQuest.hpp [code] |
file | ALTTPStructs.hpp [code] |
file | Checksums.hpp [code] |
file | Compression.hpp [code] |
file | Dir.hpp [code] |
file | Exception.hpp [code] |
file | FileInfo.hpp [code] |
file | FileNotFoundException.hpp [code] |
file | FileReader.hpp [code] |
file | FileWriter.hpp [code] |
file | Global.hpp [code] |
file | InvalidDataException.hpp [code] |
file | InvalidOperationException.hpp [code] |
file | IOException.hpp [code] |
file | IStream.hpp [code] |
file | IStreamReader.hpp [code] |
file | IStreamWriter.hpp [code] |
file | MCFile.hpp [code] |
file | MCFileReader.hpp [code] |
file | MCFileWriter.hpp [code] |
file | MCSlot.hpp [code] |
file | MemoryReader.hpp [code] |
file | MemoryWriter.hpp [code] |
file | NotImplementedException.hpp [code] |
file | PHYSFSFileReader.hpp [code] |
file | SkywardSwordFile.hpp [code] |
file | SkywardSwordFileReader.hpp [code] |
file | SkywardSwordFileWriter.hpp [code] |
file | SkywardSwordQuest.hpp [code] |
file | Sprite.hpp [code] |
file | SpriteFile.hpp [code] |
file | SpriteFileReader.hpp [code] |
file | SpriteFileWriter.hpp [code] |
file | SpriteFrame.hpp [code] |
file | SpritePart.hpp [code] |
file | Types.hpp [code] |
file | Utility.hpp [code] |
file | WiiBanner.hpp [code] |
file | WiiFile.hpp [code] |
file | WiiImage.hpp [code] |
file | WiiSave.hpp [code] |
file | WiiSaveReader.hpp [code] |
file | WiiSaveWriter.hpp [code] |
file | ZQuestFile.hpp [code] |
file | ZQuestFileReader.hpp [code] |
file | ZQuestFileWriter.hpp [code] |
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
▼ include | |
▼ Athena | |
ALTTPEnums.hpp | |
ALTTPFile.hpp | |
ALTTPFileReader.hpp | |
ALTTPFileWriter.hpp | |
ALTTPQuest.hpp | |
ALTTPStructs.hpp | |
Checksums.hpp | |
Compression.hpp | |
Dir.hpp | |
Exception.hpp | |
FileInfo.hpp | |
FileNotFoundException.hpp | |
FileReader.hpp | |
FileWriter.hpp | |
Global.hpp | |
InvalidDataException.hpp | |
InvalidOperationException.hpp | |
IOException.hpp | |
IStream.hpp | |
IStreamReader.hpp | |
IStreamWriter.hpp | |
MCFile.hpp | |
MCFileReader.hpp | |
MCFileWriter.hpp | |
MCSlot.hpp | |
MemoryReader.hpp | |
MemoryWriter.hpp | |
NotImplementedException.hpp | |
PHYSFSFileReader.hpp | |
SkywardSwordFile.hpp | |
SkywardSwordFileReader.hpp | |
SkywardSwordFileWriter.hpp | |
SkywardSwordQuest.hpp | |
Sprite.hpp | |
SpriteFile.hpp | |
SpriteFileReader.hpp | |
SpriteFileWriter.hpp | |
SpriteFrame.hpp | |
SpritePart.hpp | |
Types.hpp | |
Utility.hpp | |
WiiBanner.hpp | |
WiiFile.hpp | |
WiiImage.hpp | |
WiiSave.hpp | |
WiiSaveReader.hpp | |
WiiSaveWriter.hpp | |
ZQuestFile.hpp | |
ZQuestFileReader.hpp | |
ZQuestFileWriter.hpp |
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ Athena IO Library
+
+ |
+
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
t |