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.
413 lines
23 KiB
HTML
413 lines
23 KiB
HTML
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.EventProcessorEvent 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
|
||
|
|
 <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 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 List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
|
|
<li><a href="hierarchy.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">
|
||
|
|
$(document).ready(function(){initNavTree('class_otter_1_1_event_processor_event.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </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> |
|
||
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
||
|
|
<a href="#properties">Properties</a> |
|
||
|
|
<a href="class_otter_1_1_event_processor_event-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.EventProcessorEvent Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<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:a4b23ddac2436ed53a69e2275b04bb1c4"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#a4b23ddac2436ed53a69e2275b04bb1c4">GetScene< T ></a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a4b23ddac2436ed53a69e2275b04bb1c4"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> that has the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that has the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. <a href="#a4b23ddac2436ed53a69e2275b04bb1c4">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4b23ddac2436ed53a69e2275b04bb1c4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afd7365c6414a9f0cd1218477e7ac5cfb"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#afd7365c6414a9f0cd1218477e7ac5cfb">Begin</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:afd7365c6414a9f0cd1218477e7ac5cfb"><td class="mdescLeft"> </td><td class="mdescRight">Called when the Event first starts. <a href="#afd7365c6414a9f0cd1218477e7ac5cfb">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:afd7365c6414a9f0cd1218477e7ac5cfb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3cadfd3e327c8f84cac11cbbd8e099f4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#a3cadfd3e327c8f84cac11cbbd8e099f4">End</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a3cadfd3e327c8f84cac11cbbd8e099f4"><td class="mdescLeft"> </td><td class="mdescRight">Called when the Event finishes and is cleared from the queue. <a href="#a3cadfd3e327c8f84cac11cbbd8e099f4">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3cadfd3e327c8f84cac11cbbd8e099f4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5349887023f033a124a18d59ed19b567"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#a5349887023f033a124a18d59ed19b567">Finish</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a5349887023f033a124a18d59ed19b567"><td class="mdescLeft"> </td><td class="mdescRight">Finishes the event. <a href="#a5349887023f033a124a18d59ed19b567">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5349887023f033a124a18d59ed19b567"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2e48f73ea9209575792f741fc42f3b49"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#a2e48f73ea9209575792f741fc42f3b49">Start</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a2e48f73ea9209575792f741fc42f3b49"><td class="mdescLeft"> </td><td class="mdescRight">Starts the event. <a href="#a2e48f73ea9209575792f741fc42f3b49">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a2e48f73ea9209575792f741fc42f3b49"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab97bbfafec194e66dbe23ed6007d3266"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#ab97bbfafec194e66dbe23ed6007d3266">Update</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ab97bbfafec194e66dbe23ed6007d3266"><td class="mdescLeft"> </td><td class="mdescRight">Called every update from the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a>. <a href="#ab97bbfafec194e66dbe23ed6007d3266">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ab97bbfafec194e66dbe23ed6007d3266"><td class="memSeparator" colspan="2"> </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:a7164d31fad1329049094c1d6b05fb303"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#a7164d31fad1329049094c1d6b05fb303">EventProcessor</a></td></tr>
|
||
|
|
<tr class="memdesc:a7164d31fad1329049094c1d6b05fb303"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. <a href="#a7164d31fad1329049094c1d6b05fb303">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a7164d31fad1329049094c1d6b05fb303"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5248c3f31d4a8eac685c21537a215379"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#a5248c3f31d4a8eac685c21537a215379">Timer</a> = 0</td></tr>
|
||
|
|
<tr class="memdesc:a5248c3f31d4a8eac685c21537a215379"><td class="mdescLeft"> </td><td class="mdescRight">The elapsed time for this event. <a href="#a5248c3f31d4a8eac685c21537a215379">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5248c3f31d4a8eac685c21537a215379"><td class="memSeparator" colspan="2"> </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:ac853f5c6f90dc5b9acd38d845f7e3fd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_entity.html">Entity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#ac853f5c6f90dc5b9acd38d845f7e3fd7">Entity</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:ac853f5c6f90dc5b9acd38d845f7e3fd7"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that has the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. <a href="#ac853f5c6f90dc5b9acd38d845f7e3fd7">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac853f5c6f90dc5b9acd38d845f7e3fd7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa01fe95230bec8460f2e77897bbdf380"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_scene.html">Scene</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#aa01fe95230bec8460f2e77897bbdf380">Scene</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:aa01fe95230bec8460f2e77897bbdf380"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> that has the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that has the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. <a href="#aa01fe95230bec8460f2e77897bbdf380">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa01fe95230bec8460f2e77897bbdf380"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acfc6d699a177fe9b10b065484d380f58"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_event_processor_event.html#acfc6d699a177fe9b10b065484d380f58">IsFinished</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:acfc6d699a177fe9b10b065484d380f58"><td class="mdescLeft"> </td><td class="mdescRight">Whether or not the Event has finished. <a href="#acfc6d699a177fe9b10b065484d380f58">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:acfc6d699a177fe9b10b065484d380f58"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="afd7365c6414a9f0cd1218477e7ac5cfb"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void Otter.EventProcessorEvent.Begin </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Called when the Event first starts. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a3cadfd3e327c8f84cac11cbbd8e099f4"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void Otter.EventProcessorEvent.End </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Called when the Event finishes and is cleared from the queue. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a5349887023f033a124a18d59ed19b567"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.EventProcessorEvent.Finish </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Finishes the event. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4b23ddac2436ed53a69e2275b04bb1c4"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">T Otter.EventProcessorEvent.GetScene< T > </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> that has the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that has the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. </p>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">T</td><td>The Type the <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> should be cast to.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> that has the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that has the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to.</dd></dl>
|
||
|
|
<div class="typeconstraint">
|
||
|
|
<dl><dt><b>Type Constraints</b><dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>Scene</em></td><td> </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a2e48f73ea9209575792f741fc42f3b49"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.EventProcessorEvent.Start </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Starts the event. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ab97bbfafec194e66dbe23ed6007d3266"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void Otter.EventProcessorEvent.Update </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Called every update from the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a class="anchor" id="a7164d31fad1329049094c1d6b05fb303"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> Otter.EventProcessorEvent.EventProcessor</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a5248c3f31d4a8eac685c21537a215379"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.EventProcessorEvent.Timer = 0</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The elapsed time for this event. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="ac853f5c6f90dc5b9acd38d845f7e3fd7"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_entity.html">Entity</a> Otter.EventProcessorEvent.Entity</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">get</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that has the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="acfc6d699a177fe9b10b065484d380f58"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.EventProcessorEvent.IsFinished</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>Whether or not the Event has finished. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa01fe95230bec8460f2e77897bbdf380"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_scene.html">Scene</a> Otter.EventProcessorEvent.Scene</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">get</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> that has the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that has the <a class="el" href="class_otter_1_1_event_processor.html">EventProcessor</a> that this event belongs to. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Components/Events/EventProcessorEvent.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_event_processor_event.html">EventProcessorEvent</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>
|