Files
openmw.github.io/aiface_8hpp_source.html
Travis CI 1afc571f3d Deploy code docs to GitHub Pages Travis build: 4489
Commit: 6e51b4ff57f622c4e11205ec444ffac21e73bbf7
2017-01-24 02:13:55 +00:00

152 lines
17 KiB
HTML

<!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.6"/>
<title>OpenMW: /home/travis/build/OpenMW/openmw/apps/openmw/mwmechanics/aiface.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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.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 style="padding-left: 0.5em;">
<div id="projectname">OpenMW
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(13)"><span class="SelectionMark">&#160;</span>Pages</a></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_9654b8d08f4bba4e84b362c5fd320bee.html">apps</a></li><li class="navelem"><a class="el" href="dir_9edfe748cccf561d6c3b74e2990846ba.html">openmw</a></li><li class="navelem"><a class="el" href="dir_4dc3d87d265d107fb34e011e3afab8f4.html">mwmechanics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">aiface.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="aiface_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef GAME_MWMECHANICS_AIFACE_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GAME_MWMECHANICS_AIFACE_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="apps_2openmw_2mwmechanics_2aipackage_8hpp.html">aipackage.hpp</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">namespace </span>MWMechanics</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;{</div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="classMWMechanics_1_1AiFace.html"> 9</a></span>&#160; <span class="keyword">class </span><a class="code" href="classMWMechanics_1_1AiFace.html">AiFace</a> : <span class="keyword">public</span> <a class="code" href="classMWMechanics_1_1AiPackage.html">AiPackage</a> {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <a class="code" href="classMWMechanics_1_1AiFace.html#a3e7257574d99531112bcc1e5e4c15b64">AiFace</a>(<span class="keywordtype">float</span> targetX, <span class="keywordtype">float</span> targetY);</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classMWMechanics_1_1AiPackage.html">AiPackage</a> *<a class="code" href="classMWMechanics_1_1AiFace.html#a86019d3df3568bd944109cddbafec825">clone</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMWMechanics_1_1AiFace.html#a5b46a6e0e47e793612bcd9184f13eab3">execute</a> (<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a>&amp; actor, <a class="code" href="classMWMechanics_1_1CharacterController.html">CharacterController</a>&amp; characterController, <a class="code" href="classMWMechanics_1_1DerivedClassStorage.html">AiState</a>&amp; state, <span class="keywordtype">float</span> duration);</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"> 17</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classMWMechanics_1_1AiFace.html#a63aab7bc6084ec022c4251525b086612">getTypeId</a>() <span class="keyword">const</span>;</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">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classMWMechanics_1_1AiFace.html#a58e83e9aa32bfea5da8304e819f006cc">getPriority</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classMWMechanics_1_1AiFace.html#af1087d73c68c0742c8099c5dfaa6a02b"> 21</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMWMechanics_1_1AiFace.html#af1087d73c68c0742c8099c5dfaa6a02b">canCancel</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classMWMechanics_1_1AiFace.html#a4d521728a7165ecfb712d12d623bef01"> 22</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMWMechanics_1_1AiFace.html#a4d521728a7165ecfb712d12d623bef01">shouldCancelPreviousAi</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classMWMechanics_1_1AiFace.html#ae075e0e2b24ec8e687d25300a025cb62"> 25</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="classMWMechanics_1_1AiFace.html#a841c92ecdb6ecc65b360cb58206cc647">mTargetX</a>, <a class="code" href="classMWMechanics_1_1AiFace.html#ae075e0e2b24ec8e687d25300a025cb62">mTargetY</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; };</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;}</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_a3e7257574d99531112bcc1e5e4c15b64"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#a3e7257574d99531112bcc1e5e4c15b64">MWMechanics::AiFace::AiFace</a></div><div class="ttdeci">AiFace(float targetX, float targetY)</div><div class="ttdef"><b>Definition:</b> aiface.cpp:7</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_a5b46a6e0e47e793612bcd9184f13eab3"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#a5b46a6e0e47e793612bcd9184f13eab3">MWMechanics::AiFace::execute</a></div><div class="ttdeci">virtual bool execute(const MWWorld::Ptr &amp;actor, CharacterController &amp;characterController, AiState &amp;state, float duration)</div><div class="ttdef"><b>Definition:</b> aiface.cpp:17</div></div>
<div class="ttc" id="classMWMechanics_1_1DerivedClassStorage_html"><div class="ttname"><a href="classMWMechanics_1_1DerivedClassStorage.html">MWMechanics::DerivedClassStorage&lt; AiTemporaryBase &gt;</a></div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_a63aab7bc6084ec022c4251525b086612"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#a63aab7bc6084ec022c4251525b086612">MWMechanics::AiFace::getTypeId</a></div><div class="ttdeci">virtual int getTypeId() const </div><div class="ttdef"><b>Definition:</b> aiface.cpp:23</div></div>
<div class="ttc" id="classMWMechanics_1_1AiPackage_html"><div class="ttname"><a href="classMWMechanics_1_1AiPackage.html">MWMechanics::AiPackage</a></div><div class="ttdoc">Base class for AI packages. </div><div class="ttdef"><b>Definition:</b> aipackage.hpp:32</div></div>
<div class="ttc" id="classMWMechanics_1_1CharacterController_html"><div class="ttname"><a href="classMWMechanics_1_1CharacterController.html">MWMechanics::CharacterController</a></div><div class="ttdef"><b>Definition:</b> character.hpp:145</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_ae075e0e2b24ec8e687d25300a025cb62"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#ae075e0e2b24ec8e687d25300a025cb62">MWMechanics::AiFace::mTargetY</a></div><div class="ttdeci">float mTargetY</div><div class="ttdef"><b>Definition:</b> aiface.hpp:25</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_a58e83e9aa32bfea5da8304e819f006cc"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#a58e83e9aa32bfea5da8304e819f006cc">MWMechanics::AiFace::getPriority</a></div><div class="ttdeci">virtual unsigned int getPriority() const </div><div class="ttdoc">Higher number is higher priority (0 being the lowest) </div><div class="ttdef"><b>Definition:</b> aiface.cpp:28</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_a86019d3df3568bd944109cddbafec825"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#a86019d3df3568bd944109cddbafec825">MWMechanics::AiFace::clone</a></div><div class="ttdeci">virtual AiPackage * clone() const </div><div class="ttdoc">Clones the package. </div><div class="ttdef"><b>Definition:</b> aiface.cpp:12</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html">MWMechanics::AiFace</a></div><div class="ttdoc">AiPackage which makes an actor face a certain direction. </div><div class="ttdef"><b>Definition:</b> aiface.hpp:9</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_a4d521728a7165ecfb712d12d623bef01"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#a4d521728a7165ecfb712d12d623bef01">MWMechanics::AiFace::shouldCancelPreviousAi</a></div><div class="ttdeci">virtual bool shouldCancelPreviousAi() const </div><div class="ttdoc">Upon adding this Ai package, should the Ai Sequence attempt to cancel previous Ai packages (default t...</div><div class="ttdef"><b>Definition:</b> aiface.hpp:22</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_a841c92ecdb6ecc65b360cb58206cc647"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#a841c92ecdb6ecc65b360cb58206cc647">MWMechanics::AiFace::mTargetX</a></div><div class="ttdeci">float mTargetX</div><div class="ttdef"><b>Definition:</b> aiface.hpp:25</div></div>
<div class="ttc" id="classMWWorld_1_1Ptr_html"><div class="ttname"><a href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a></div><div class="ttdoc">Pointer to a LiveCellRef. </div><div class="ttdef"><b>Definition:</b> ptr.hpp:19</div></div>
<div class="ttc" id="classMWMechanics_1_1AiFace_html_af1087d73c68c0742c8099c5dfaa6a02b"><div class="ttname"><a href="classMWMechanics_1_1AiFace.html#af1087d73c68c0742c8099c5dfaa6a02b">MWMechanics::AiFace::canCancel</a></div><div class="ttdeci">virtual bool canCancel() const </div><div class="ttdoc">Can this Ai package be canceled? (default true) </div><div class="ttdef"><b>Definition:</b> aiface.hpp:21</div></div>
<div class="ttc" id="apps_2openmw_2mwmechanics_2aipackage_8hpp_html"><div class="ttname"><a href="apps_2openmw_2mwmechanics_2aipackage_8hpp.html">aipackage.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 24 2017 02:05:50 for OpenMW by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>