2015-05-21 09:00:28 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2016-09-17 20:12:02 +00:00
< meta name = "generator" content = "Doxygen 1.8.11" / >
< title > Athena IO Library: athena::ALTTPFile Class Reference< / title >
2015-05-21 09:00:28 +00:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
$(window).load(resizeHeight);
< / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { init_search(); });
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
2016-09-17 20:12:02 +00:00
< td id = "projectalign" style = "padding-left: 0.5em;" >
2015-05-21 09:00:28 +00:00
< div id = "projectname" > Athena IO Library
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2016-09-17 20:12:02 +00:00
<!-- Generated by Doxygen 1.8.11 -->
2015-05-21 09:00:28 +00:00
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li class = "current" > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "annotated.html" > < span > Class  List< / span > < / a > < / li >
< li > < a href = "classes.html" > < span > Class  Index< / span > < / a > < / li >
< li > < a href = "inherits.html" > < span > Class  Hierarchy< / span > < / a > < / li >
< li > < a href = "functions.html" > < span > Class  Members< / span > < / a > < / li >
< / ul >
< / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
2016-09-17 20:12:02 +00:00
$(document).ready(function(){initNavTree('classathena_1_1_a_l_t_t_p_file.html','');});
2015-05-21 09:00:28 +00:00
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-types" > Public Types< / a > |
< a href = "#pub-methods" > Public Member Functions< / a > |
2016-09-17 20:12:02 +00:00
< a href = "classathena_1_1_a_l_t_t_p_file-members.html" > List of all members< / a > < / div >
2015-05-21 09:00:28 +00:00
< div class = "headertitle" >
2016-09-17 20:12:02 +00:00
< div class = "title" > athena::ALTTPFile Class Reference< / div > < / div >
2015-05-21 09:00:28 +00:00
< / div > <!-- header -->
< div class = "contents" >
< p > A Link to the Past data container class class.
2016-09-17 20:12:02 +00:00
< a href = "classathena_1_1_a_l_t_t_p_file.html#details" > More...< / a > < / p >
2015-05-21 09:00:28 +00:00
< p > < code > #include < < a class = "el" href = "_a_l_t_t_p_file_8hpp_source.html" > ALTTPFile.hpp< / a > > < / code > < / p >
< div class = "dynheader" >
2016-09-17 20:12:02 +00:00
Collaboration diagram for athena::ALTTPFile:< / div >
2015-05-21 09:00:28 +00:00
< div class = "dyncontent" >
2016-09-17 20:12:02 +00:00
< div class = "center" > < img src = "classathena_1_1_a_l_t_t_p_file__coll__graph.png" border = "0" usemap = "#athena_1_1_a_l_t_t_p_file_coll__map" alt = "Collaboration graph" / > < / div >
< map name = "athena_1_1_a_l_t_t_p_file_coll__map" id = "athena_1_1_a_l_t_t_p_file_coll__map" >
< / map >
2015-05-21 09:00:28 +00:00
< / div >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-types" > < / a >
Public Types< / h2 > < / td > < / tr >
2016-09-17 20:12:02 +00:00
< tr class = "memitem:ab0f5dd1b5c950706be7cb854e0fa20f4" > < td class = "memItemLeft" align = "right" valign = "top" > typedef std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > * > ::iterator  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#ab0f5dd1b5c950706be7cb854e0fa20f4" > QuestIter< / a > < / td > < / tr >
< tr class = "memdesc:ab0f5dd1b5c950706be7cb854e0fa20f4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Quest Iterator. < a href = "#ab0f5dd1b5c950706be7cb854e0fa20f4" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ab0f5dd1b5c950706be7cb854e0fa20f4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-05-21 09:00:28 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2016-09-17 20:12:02 +00:00
< tr class = "memitem:a108e0aaf59510f71b2d5810395cbd6f3" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#a108e0aaf59510f71b2d5810395cbd6f3" > ALTTPFile< / a > ()< / td > < / tr >
< tr class = "memdesc:a108e0aaf59510f71b2d5810395cbd6f3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Default constructor. < a href = "#a108e0aaf59510f71b2d5810395cbd6f3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a108e0aaf59510f71b2d5810395cbd6f3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab20ca651332c9dc0088aea24372b0c69" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#ab20ca651332c9dc0088aea24372b0c69" > ALTTPFile< / a > (std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > * > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#a75a91344aeaf2799dbde3f3b59913f4b" > questList< / a > , std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > * > backupList)< / td > < / tr >
< tr class = "memdesc:ab20ca651332c9dc0088aea24372b0c69" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constructor. < a href = "#ab20ca651332c9dc0088aea24372b0c69" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ab20ca651332c9dc0088aea24372b0c69" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:abab8805b46911d34ca395cee1befcb73" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#abab8805b46911d34ca395cee1befcb73" > setQuest< / a > (atUint32 id, < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > *val)< / td > < / tr >
< tr class = "memdesc:abab8805b46911d34ca395cee1befcb73" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sets a quest at the given index. < a href = "#abab8805b46911d34ca395cee1befcb73" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:abab8805b46911d34ca395cee1befcb73" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a75a91344aeaf2799dbde3f3b59913f4b" > < td class = "memItemLeft" align = "right" valign = "top" > std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > * >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#a75a91344aeaf2799dbde3f3b59913f4b" > questList< / a > () const < / td > < / tr >
< tr class = "memdesc:a75a91344aeaf2799dbde3f3b59913f4b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns the primary quest list. < a href = "#a75a91344aeaf2799dbde3f3b59913f4b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a75a91344aeaf2799dbde3f3b59913f4b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a77729320d22e1278cb93597ea0974129" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#a77729320d22e1278cb93597ea0974129" > quest< / a > (atUint32 id) const < / td > < / tr >
< tr class = "memdesc:a77729320d22e1278cb93597ea0974129" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns a quest at the given index. < a href = "#a77729320d22e1278cb93597ea0974129" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a77729320d22e1278cb93597ea0974129" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad820145a7a7469114be987690d12643b" > < td class = "memItemLeft" align = "right" valign = "top" > atUint32  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#ad820145a7a7469114be987690d12643b" > questCount< / a > () const < / td > < / tr >
< tr class = "memdesc:ad820145a7a7469114be987690d12643b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns the number of primary quests. < a href = "#ad820145a7a7469114be987690d12643b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ad820145a7a7469114be987690d12643b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-05-21 09:00:28 +00:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > A Link to the Past data container class class. < / p >
< p > Contains all relevant data for an A Link to the Past SRM file. < / p >
2016-09-17 20:12:02 +00:00
< p > Definition at line < a class = "el" href = "_a_l_t_t_p_file_8hpp_source.html#l00018" > 18< / a > of file < a class = "el" href = "_a_l_t_t_p_file_8hpp_source.html" > ALTTPFile.hpp< / a > .< / p >
2015-05-21 09:00:28 +00:00
< / div > < h2 class = "groupheader" > Member Typedef Documentation< / h2 >
2016-09-17 20:12:02 +00:00
< a class = "anchor" id = "ab0f5dd1b5c950706be7cb854e0fa20f4" > < / a >
2015-05-21 09:00:28 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-09-17 20:12:02 +00:00
< td class = "memname" > typedef std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > *> ::iterator < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html#ab0f5dd1b5c950706be7cb854e0fa20f4" > athena::ALTTPFile::QuestIter< / a > < / td >
2015-05-21 09:00:28 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Quest Iterator. < / p >
< p > An Iterator typedef for iterating through the Quest lists < / p >
2016-09-17 20:12:02 +00:00
< p > Definition at line < a class = "el" href = "_a_l_t_t_p_file_8hpp_source.html#l00025" > 25< / a > of file < a class = "el" href = "_a_l_t_t_p_file_8hpp_source.html" > ALTTPFile.hpp< / a > .< / p >
2015-05-21 09:00:28 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
2016-09-17 20:12:02 +00:00
< a class = "anchor" id = "a108e0aaf59510f71b2d5810395cbd6f3" > < / a >
2015-05-21 09:00:28 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-09-17 20:12:02 +00:00
< td class = "memname" > athena::ALTTPFile::ALTTPFile < / td >
2015-05-21 09:00:28 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Default constructor. < / p >
< / div >
< / div >
2016-09-17 20:12:02 +00:00
< a class = "anchor" id = "ab20ca651332c9dc0088aea24372b0c69" > < / a >
2015-05-21 09:00:28 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-09-17 20:12:02 +00:00
< td class = "memname" > athena::ALTTPFile::ALTTPFile < / td >
2015-05-21 09:00:28 +00:00
< td > (< / td >
2016-09-17 20:12:02 +00:00
< td class = "paramtype" > std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > * >   < / td >
2015-05-21 09:00:28 +00:00
< td class = "paramname" > < em > questList< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-09-17 20:12:02 +00:00
< td class = "paramtype" > std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > * >   < / td >
2015-05-21 09:00:28 +00:00
< td class = "paramname" > < em > backupList< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Constructor. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > questList< / td > < td > The primary quest list < / td > < / tr >
< tr > < td class = "paramname" > backupList< / td > < td > The backup quest list < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2016-09-17 20:12:02 +00:00
< a class = "anchor" id = "a77729320d22e1278cb93597ea0974129" > < / a >
2015-05-21 09:00:28 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-09-17 20:12:02 +00:00
< td class = "memname" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > * athena::ALTTPFile::quest < / td >
2015-05-21 09:00:28 +00:00
< td > (< / td >
< td class = "paramtype" > atUint32  < / td >
< td class = "paramname" > < em > id< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Returns a quest at the given index. < / p >
< p > Returns a quest at the given index< / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > ALTTPQuest* < / dd > < / dl >
< dl class = "exception" > < dt > Exceptions< / dt > < dd >
< table class = "exception" >
< tr > < td class = "paramname" > InvalidOperationException< / td > < td > on index out of range < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2016-09-17 20:12:02 +00:00
< a class = "anchor" id = "ad820145a7a7469114be987690d12643b" > < / a >
2015-05-21 09:00:28 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-09-17 20:12:02 +00:00
< td class = "memname" > atUint32 athena::ALTTPFile::questCount < / td >
2015-05-21 09:00:28 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Returns the number of primary quests. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > The number of quests < / dd > < / dl >
< / div >
< / div >
2016-09-17 20:12:02 +00:00
< a class = "anchor" id = "a75a91344aeaf2799dbde3f3b59913f4b" > < / a >
2015-05-21 09:00:28 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-09-17 20:12:02 +00:00
< td class = "memname" > std::vector< < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > *> athena::ALTTPFile::questList < / td >
2015-05-21 09:00:28 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Returns the primary quest list. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > The primary quest list < / dd > < / dl >
< / div >
< / div >
2016-09-17 20:12:02 +00:00
< a class = "anchor" id = "abab8805b46911d34ca395cee1befcb73" > < / a >
2015-05-21 09:00:28 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-09-17 20:12:02 +00:00
< td class = "memname" > void athena::ALTTPFile::setQuest < / td >
2015-05-21 09:00:28 +00:00
< td > (< / td >
< td class = "paramtype" > atUint32  < / td >
< td class = "paramname" > < em > id< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-09-17 20:12:02 +00:00
< td class = "paramtype" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_quest.html" > ALTTPQuest< / a > *  < / td >
2015-05-21 09:00:28 +00:00
< td class = "paramname" > < em > val< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Sets a quest at the given index. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > id< / td > < td > Index to the given quest < / td > < / tr >
< tr > < td class = "paramname" > val< / td > < td > The new quest to assign to the given index < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "exception" > < dt > Exceptions< / dt > < dd >
< table class = "exception" >
< tr > < td class = "paramname" > InvalidOperationException< / td > < td > on index out of range < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following file:< ul >
2016-09-17 20:12:02 +00:00
< li > include/athena/< a class = "el" href = "_a_l_t_t_p_file_8hpp_source.html" > ALTTPFile.hpp< / a > < / li >
2015-05-21 09:00:28 +00:00
< / ul >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2016-09-17 20:12:02 +00:00
< li class = "navelem" > < b > athena< / b > < / li > < li class = "navelem" > < a class = "el" href = "classathena_1_1_a_l_t_t_p_file.html" > ALTTPFile< / a > < / li >
< li class = "footer" > Generated on Sat Sep 17 2016 13:10:08 for Athena IO Library by
2015-05-21 09:00:28 +00:00
< a href = "http://www.doxygen.org/index.html" >
2016-09-17 20:12:02 +00:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.11 < / li >
2015-05-21 09:00:28 +00:00
< / ul >
< / div >
< / body >
< / html >