Alex
/
OtterPlayGround
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
OtterPlayGround/Docs/class_otter_1_1_state.html

405 lines
20 KiB
HTML
Raw Permalink Normal View History Unescape Escape

Initial Commit für Otter2D Framework
2 years ago
<!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.5"/>
<title>Otter: Otter.State Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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="otterlogosmall.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Otter
&#160;<span id="projectnumber">0.9.8.91</span>
</div>
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">
$(document).ready(function(){initNavTree('class_otter_1_1_state.html','');});
</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)">
<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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_otter_1_1_state-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Otter.State Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used in StateMachine. Contains functions for enter, update, and exit.
<a href="class_otter_1_1_state.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adcbc04299bff22e1ca0449451a80cdf8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#adcbc04299bff22e1ca0449451a80cdf8">State</a> (Action onEnter=null, Action onUpdate=null, Action onExit=null)</td></tr>
<tr class="memdesc:adcbc04299bff22e1ca0449451a80cdf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_state.html" title="Used in StateMachine. Contains functions for enter, update, and exit. ">State</a> with three Actions. <a href="#adcbc04299bff22e1ca0449451a80cdf8">More...</a><br/></td></tr>
<tr class="separator:adcbc04299bff22e1ca0449451a80cdf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a686e2018d1b335b897d664b977b06d54"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#a686e2018d1b335b897d664b977b06d54">State</a> (Action onUpdate)</td></tr>
<tr class="memdesc:a686e2018d1b335b897d664b977b06d54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_state.html" title="Used in StateMachine. Contains functions for enter, update, and exit. ">State</a> with just an update Action. <a href="#a686e2018d1b335b897d664b977b06d54">More...</a><br/></td></tr>
<tr class="separator:a686e2018d1b335b897d664b977b06d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9fe12c03378491b2a1a88d85c02462e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#aa9fe12c03378491b2a1a88d85c02462e">Functions</a> (Action onEnter, Action onUpdate, Action onExit)</td></tr>
<tr class="memdesc:aa9fe12c03378491b2a1a88d85c02462e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set all three of the methods for enter, update, and exit. <a href="#aa9fe12c03378491b2a1a88d85c02462e">More...</a><br/></td></tr>
<tr class="separator:aa9fe12c03378491b2a1a88d85c02462e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8207db30eaf3ab6b3cb0996e7f9c2726"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#a8207db30eaf3ab6b3cb0996e7f9c2726">Update</a> ()</td></tr>
<tr class="memdesc:a8207db30eaf3ab6b3cb0996e7f9c2726"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call OnUpdate. <a href="#a8207db30eaf3ab6b3cb0996e7f9c2726">More...</a><br/></td></tr>
<tr class="separator:a8207db30eaf3ab6b3cb0996e7f9c2726"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe4fa10173b958802239606637062d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#abfe4fa10173b958802239606637062d0">Enter</a> ()</td></tr>
<tr class="memdesc:abfe4fa10173b958802239606637062d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call OnEnter. <a href="#abfe4fa10173b958802239606637062d0">More...</a><br/></td></tr>
<tr class="separator:abfe4fa10173b958802239606637062d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a737a87f38bd185a4657209a6f87ccca7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#a737a87f38bd185a4657209a6f87ccca7">Exit</a> ()</td></tr>
<tr class="memdesc:a737a87f38bd185a4657209a6f87ccca7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call OnExit. <a href="#a737a87f38bd185a4657209a6f87ccca7">More...</a><br/></td></tr>
<tr class="separator:a737a87f38bd185a4657209a6f87ccca7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa4335c6e78c8c8241b2aa3f27f979248"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#aa4335c6e78c8c8241b2aa3f27f979248">OnEnter</a> = delegate { }</td></tr>
<tr class="memdesc:aa4335c6e78c8c8241b2aa3f27f979248"><td class="mdescLeft">&#160;</td><td class="mdescRight">The method to call when entering this state. <a href="#aa4335c6e78c8c8241b2aa3f27f979248">More...</a><br/></td></tr>
<tr class="separator:aa4335c6e78c8c8241b2aa3f27f979248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a006cf19b0c2fe5b32e7f113f479bb115"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#a006cf19b0c2fe5b32e7f113f479bb115">OnUpdate</a> = delegate { }</td></tr>
<tr class="memdesc:a006cf19b0c2fe5b32e7f113f479bb115"><td class="mdescLeft">&#160;</td><td class="mdescRight">The method to call when updating this state. <a href="#a006cf19b0c2fe5b32e7f113f479bb115">More...</a><br/></td></tr>
<tr class="separator:a006cf19b0c2fe5b32e7f113f479bb115"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c3ba4b67d6ba7430bcb2f8bbc09e139"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#a7c3ba4b67d6ba7430bcb2f8bbc09e139">OnExit</a> = delegate { }</td></tr>
<tr class="memdesc:a7c3ba4b67d6ba7430bcb2f8bbc09e139"><td class="mdescLeft">&#160;</td><td class="mdescRight">The method to call when exiting this state. <a href="#a7c3ba4b67d6ba7430bcb2f8bbc09e139">More...</a><br/></td></tr>
<tr class="separator:a7c3ba4b67d6ba7430bcb2f8bbc09e139"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a8a624c0cec8ba946ec55da59192930d9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_state.html#a8a624c0cec8ba946ec55da59192930d9">Id</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a8a624c0cec8ba946ec55da59192930d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Id that this state has been assigned. <a href="#a8a624c0cec8ba946ec55da59192930d9">More...</a><br/></td></tr>
<tr class="separator:a8a624c0cec8ba946ec55da59192930d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used in StateMachine. Contains functions for enter, update, and exit. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="adcbc04299bff22e1ca0449451a80cdf8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.State.State </td>
<td>(</td>
<td class="paramtype">Action&#160;</td>
<td class="paramname"><em>onEnter</em> = <code>null</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Action&#160;</td>
<td class="paramname"><em>onUpdate</em> = <code>null</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Action&#160;</td>
<td class="paramname"><em>onExit</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_state.html" title="Used in StateMachine. Contains functions for enter, update, and exit. ">State</a> with three Actions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">onEnter</td><td>The method to call when entering this state.</td></tr>
<tr><td class="paramname">onUpdate</td><td>The method to call when updating this state.</td></tr>
<tr><td class="paramname">onExit</td><td>The method to call when exiting this state.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a686e2018d1b335b897d664b977b06d54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.State.State </td>
<td>(</td>
<td class="paramtype">Action&#160;</td>
<td class="paramname"><em>onUpdate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_state.html" title="Used in StateMachine. Contains functions for enter, update, and exit. ">State</a> with just an update Action. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">onUpdate</td><td>The method to call when updating this state.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abfe4fa10173b958802239606637062d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.State.Enter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call OnEnter. </p>
</div>
</div>
<a class="anchor" id="a737a87f38bd185a4657209a6f87ccca7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.State.Exit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call OnExit. </p>
</div>
</div>
<a class="anchor" id="aa9fe12c03378491b2a1a88d85c02462e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.State.Functions </td>
<td>(</td>
<td class="paramtype">Action&#160;</td>
<td class="paramname"><em>onEnter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Action&#160;</td>
<td class="paramname"><em>onUpdate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Action&#160;</td>
<td class="paramname"><em>onExit</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set all three of the methods for enter, update, and exit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">onEnter</td><td>The method to call when entering this state.</td></tr>
<tr><td class="paramname">onUpdate</td><td>The method to call when updating this state.</td></tr>
<tr><td class="paramname">onExit</td><td>The method to call when exiting this state.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8207db30eaf3ab6b3cb0996e7f9c2726"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.State.Update </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call OnUpdate. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa4335c6e78c8c8241b2aa3f27f979248"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Action Otter.State.OnEnter = delegate { }</td>
</tr>
</table>
</div><div class="memdoc">
<p>The method to call when entering this state. </p>
</div>
</div>
<a class="anchor" id="a7c3ba4b67d6ba7430bcb2f8bbc09e139"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Action Otter.State.OnExit = delegate { }</td>
</tr>
</table>
</div><div class="memdoc">
<p>The method to call when exiting this state. </p>
</div>
</div>
<a class="anchor" id="a006cf19b0c2fe5b32e7f113f479bb115"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Action Otter.State.OnUpdate = delegate { }</td>
</tr>
</table>
</div><div class="memdoc">
<p>The method to call when updating this state. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a8a624c0cec8ba946ec55da59192930d9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Otter.State.Id</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The Id that this state has been assigned. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Otter/Components/StateMachine.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespace_otter.html">Otter</a></li><li class="navelem"><a class="el" href="class_otter_1_1_state.html">State</a></li>
<li class="footer">Generated on Thu May 12 2016 18:16:52 for Otter by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>