Skip to content

Commit

Permalink
Read Doxygen docs for the real 0.7.0 instead
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidcernat
davidcernat committed Jan 20, 2019
1 parent 4434edd commit 1d185e7
Show file tree
Hide file tree
Showing 244 changed files with 42,400 additions and 0 deletions.
155 changes: 155 additions & 0 deletions build/html/_actors_8hpp_source.html
View file

Large diffs are not rendered by default.

86 changes: 86 additions & 0 deletions build/html/_books_8hpp_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TES3MP: C:/msys64/home/ICE/openmw-tes3mp-x64-0.7.0/apps/openmw-mp/Script/Functions/Books.hpp Source File</title>
<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="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>
<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;">
<td id="projectlogo"><img alt="Logo" src="tes3mp - logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">TES3MP
&#160;<span id="projectnumber">0.7.0-alpha</span>
</div>
<div id="projectbrief">Multiplayer for OpenMW</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bbaa3e6d145be87c8a5363514d5fd13f.html">msys64</a></li><li class="navelem"><a class="el" href="dir_f8c7842ae88a1005d8e6113798ab7066.html">home</a></li><li class="navelem"><a class="el" href="dir_237c6dea95f2733e4626432478dbb4c7.html">ICE</a></li><li class="navelem"><a class="el" href="dir_4f63a2e2cdf54c3b8fb2db8cc385bcec.html">openmw-tes3mp-x64-0.7.0</a></li><li class="navelem"><a class="el" href="dir_61d39b73f254ac6da4adf507803067ef.html">apps</a></li><li class="navelem"><a class="el" href="dir_56f1d18820da8e632c399773aeecc7f9.html">openmw-mp</a></li><li class="navelem"><a class="el" href="dir_c87890ea96fc6c75f24eaa236282769b.html">Script</a></li><li class="navelem"><a class="el" href="dir_28f5479277138f52f8f382568d06454f.html">Functions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Books.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef OPENMW_BOOKAPI_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define OPENMW_BOOKAPI_HPP</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#define BOOKAPI \</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor"> {&quot;ClearBookChanges&quot;, BookFunctions::ClearBookChanges},\</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor"> \</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor"> {&quot;GetBookChangesSize&quot;, BookFunctions::GetBookChangesSize},\</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"> \</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"> {&quot;AddBook&quot;, BookFunctions::AddBook},\</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor"> \</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor"> {&quot;GetBookId&quot;, BookFunctions::GetBookId},\</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"> \</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor"> {&quot;SendBookChanges&quot;, BookFunctions::SendBookChanges},\</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"> \</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"> {&quot;InitializeBookChanges&quot;, BookFunctions::InitializeBookChanges}</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_book_functions.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_book_functions.html">BookFunctions</a></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_book_functions.html#a071d8718bcd540afbece45f1cf2ee95a">ClearBookChanges</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> pid) noexcept;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_book_functions.html#ae3bf24add9a64aed0bcd57d0eae9ce40">GetBookChangesSize</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> pid) noexcept;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_book_functions.html#ac62bfbbe067bcf38abf89f93818f685c">AddBook</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> pid, <span class="keyword">const</span> <span class="keywordtype">char</span>* bookId) noexcept;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="class_book_functions.html#a02a79324e2113442e1fde3740465986e">GetBookId</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> pid, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index) noexcept;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_book_functions.html#a21fbc6aec17c203183db226bd13eef1b">SendBookChanges</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> pid, <span class="keywordtype">bool</span> sendToOtherPlayers, <span class="keywordtype">bool</span> skipAttachedPlayer) noexcept;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// All methods below are deprecated versions of methods from above</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> InitializeBookChanges(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> pid) noexcept;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;};</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor">#endif //OPENMW_BOOKAPI_HPP</span></div><div class="ttc" id="class_book_functions_html_ac62bfbbe067bcf38abf89f93818f685c"><div class="ttname"><a href="class_book_functions.html#ac62bfbbe067bcf38abf89f93818f685c">BookFunctions::AddBook</a></div><div class="ttdeci">static void AddBook(unsigned short pid, const char *bookId) noexcept</div><div class="ttdoc">Add a new book to the book changes for a player. </div><div class="ttdef"><b>Definition:</b> Books.cpp:26</div></div>
<div class="ttc" id="class_book_functions_html_a21fbc6aec17c203183db226bd13eef1b"><div class="ttname"><a href="class_book_functions.html#a21fbc6aec17c203183db226bd13eef1b">BookFunctions::SendBookChanges</a></div><div class="ttdeci">static void SendBookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept</div><div class="ttdoc">Send a PlayerBook packet with a player&amp;#39;s recorded book changes. </div><div class="ttdef"><b>Definition:</b> Books.cpp:48</div></div>
<div class="ttc" id="class_book_functions_html"><div class="ttname"><a href="class_book_functions.html">BookFunctions</a></div><div class="ttdef"><b>Definition:</b> Books.hpp:17</div></div>
<div class="ttc" id="class_book_functions_html_ae3bf24add9a64aed0bcd57d0eae9ce40"><div class="ttname"><a href="class_book_functions.html#ae3bf24add9a64aed0bcd57d0eae9ce40">BookFunctions::GetBookChangesSize</a></div><div class="ttdeci">static unsigned int GetBookChangesSize(unsigned short pid) noexcept</div><div class="ttdoc">Get the number of indexes in a player&amp;#39;s latest book changes. </div><div class="ttdef"><b>Definition:</b> Books.cpp:18</div></div>
<div class="ttc" id="class_book_functions_html_a02a79324e2113442e1fde3740465986e"><div class="ttname"><a href="class_book_functions.html#a02a79324e2113442e1fde3740465986e">BookFunctions::GetBookId</a></div><div class="ttdeci">static const char * GetBookId(unsigned short pid, unsigned int index) noexcept</div><div class="ttdoc">Get the bookId at a certain index in a player&amp;#39;s latest book changes. </div><div class="ttdef"><b>Definition:</b> Books.cpp:37</div></div>
<div class="ttc" id="class_book_functions_html_a071d8718bcd540afbece45f1cf2ee95a"><div class="ttname"><a href="class_book_functions.html#a071d8718bcd540afbece45f1cf2ee95a">BookFunctions::ClearBookChanges</a></div><div class="ttdeci">static void ClearBookChanges(unsigned short pid) noexcept</div><div class="ttdoc">Clear the last recorded book changes for a player. </div><div class="ttdef"><b>Definition:</b> Books.cpp:10</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

0 comments on commit 1d185e7

Please sign in to comment.