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.
620 lines
31 KiB
HTML
620 lines
31 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.Coroutine 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_coroutine.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-static-attribs">Static Public Attributes</a> |
|
||
|
|
<a href="#properties">Properties</a> |
|
||
|
|
<a href="class_otter_1_1_coroutine-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.Coroutine Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class that manages Coroutines.
|
||
|
|
<a href="class_otter_1_1_coroutine.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:ab347a99605d327ea3d0c3e510c6be002"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#ab347a99605d327ea3d0c3e510c6be002">Coroutine</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ab347a99605d327ea3d0c3e510c6be002"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_coroutine.html" title="Class that manages Coroutines. ">Coroutine</a> manager. <a href="#ab347a99605d327ea3d0c3e510c6be002">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ab347a99605d327ea3d0c3e510c6be002"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8854889af04cb80a569004699041bd2d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a8854889af04cb80a569004699041bd2d">Start</a> (IEnumerator routine)</td></tr>
|
||
|
|
<tr class="memdesc:a8854889af04cb80a569004699041bd2d"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new coroutine and returns an int id for that routine. <a href="#a8854889af04cb80a569004699041bd2d">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8854889af04cb80a569004699041bd2d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2e011298b8f9b6f643bea98cac4d65d4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a2e011298b8f9b6f643bea98cac4d65d4">StopAll</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a2e011298b8f9b6f643bea98cac4d65d4"><td class="mdescLeft"> </td><td class="mdescRight">Immediately clear and stop all Coroutines. <a href="#a2e011298b8f9b6f643bea98cac4d65d4">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a2e011298b8f9b6f643bea98cac4d65d4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aaa7374d9f884b6c60d78006c6d044af7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#aaa7374d9f884b6c60d78006c6d044af7">Stop</a> (int routineId)</td></tr>
|
||
|
|
<tr class="memdesc:aaa7374d9f884b6c60d78006c6d044af7"><td class="mdescLeft"> </td><td class="mdescRight">Stop a routine from running based off its int id. <a href="#aaa7374d9f884b6c60d78006c6d044af7">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aaa7374d9f884b6c60d78006c6d044af7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a758a3277c6082b9a163368018be8cfe2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a758a3277c6082b9a163368018be8cfe2">Update</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a758a3277c6082b9a163368018be8cfe2"><td class="mdescLeft"> </td><td class="mdescRight">Updates all the routines. The coroutine in the <a class="el" href="class_otter_1_1_game.html" title="ᶜ(ᵔᴥᵔ)ᵓ Core class Otter. Create a Game, and then use Game.Start(); to run it. ">Game</a> automatically runs this. <a href="#a758a3277c6082b9a163368018be8cfe2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a758a3277c6082b9a163368018be8cfe2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa2dc3bb16642c50bcbd6ead32b7c35bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#aa2dc3bb16642c50bcbd6ead32b7c35bf">PublishEvent</a> (string id)</td></tr>
|
||
|
|
<tr class="memdesc:aa2dc3bb16642c50bcbd6ead32b7c35bf"><td class="mdescLeft"> </td><td class="mdescRight">Publishes an event to the coroutine manager. Used for WaitForEvent. Events are cleared on every update. <a href="#aa2dc3bb16642c50bcbd6ead32b7c35bf">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa2dc3bb16642c50bcbd6ead32b7c35bf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa0daf4d33bc7ef998e85b5cc93e31aec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#aa0daf4d33bc7ef998e85b5cc93e31aec">PublishEvent</a> (Enum id)</td></tr>
|
||
|
|
<tr class="memdesc:aa0daf4d33bc7ef998e85b5cc93e31aec"><td class="mdescLeft"> </td><td class="mdescRight">Publishes an event to the coroutine manager. Used for WaitForEvent. Events are cleared on every update. <a href="#aa0daf4d33bc7ef998e85b5cc93e31aec">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa0daf4d33bc7ef998e85b5cc93e31aec"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae3384c29ad52b1b185fb99802bd9e261"><td class="memItemLeft" align="right" valign="top">IEnumerator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#ae3384c29ad52b1b185fb99802bd9e261">WaitForEvent</a> (string id)</td></tr>
|
||
|
|
<tr class="memdesc:ae3384c29ad52b1b185fb99802bd9e261"><td class="mdescLeft"> </td><td class="mdescRight">Waits until a specific event has been published. <a href="#ae3384c29ad52b1b185fb99802bd9e261">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ae3384c29ad52b1b185fb99802bd9e261"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a20f552d9b7c0ea4b85d98b1e81cc8b62"><td class="memItemLeft" align="right" valign="top">IEnumerator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a20f552d9b7c0ea4b85d98b1e81cc8b62">WaitForEvent</a> (Enum id)</td></tr>
|
||
|
|
<tr class="memdesc:a20f552d9b7c0ea4b85d98b1e81cc8b62"><td class="mdescLeft"> </td><td class="mdescRight">Waits until a specific event has been published. <a href="#a20f552d9b7c0ea4b85d98b1e81cc8b62">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a20f552d9b7c0ea4b85d98b1e81cc8b62"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a521801d74a6fe159e1446a4e30f5eb8c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a521801d74a6fe159e1446a4e30f5eb8c">HasEvent</a> (string id)</td></tr>
|
||
|
|
<tr class="memdesc:a521801d74a6fe159e1446a4e30f5eb8c"><td class="mdescLeft"> </td><td class="mdescRight">Check if an event has been published. <a href="#a521801d74a6fe159e1446a4e30f5eb8c">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a521801d74a6fe159e1446a4e30f5eb8c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a62a1ac2968fff94e2da3426411088fd1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a62a1ac2968fff94e2da3426411088fd1">HasEvent</a> (Enum id)</td></tr>
|
||
|
|
<tr class="memdesc:a62a1ac2968fff94e2da3426411088fd1"><td class="mdescLeft"> </td><td class="mdescRight">Check if an event has been published. <a href="#a62a1ac2968fff94e2da3426411088fd1">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a62a1ac2968fff94e2da3426411088fd1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a310bcd2ca7e428872fbf2e2bba7870e3"><td class="memItemLeft" align="right" valign="top">IEnumerator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a310bcd2ca7e428872fbf2e2bba7870e3">WaitForSeconds</a> (float seconds)</td></tr>
|
||
|
|
<tr class="memdesc:a310bcd2ca7e428872fbf2e2bba7870e3"><td class="mdescLeft"> </td><td class="mdescRight">Waits until an amount of time has passed. <a href="#a310bcd2ca7e428872fbf2e2bba7870e3">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a310bcd2ca7e428872fbf2e2bba7870e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6f57f0a890eb24262b8b0db154baa5c7"><td class="memItemLeft" align="right" valign="top">IEnumerator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a6f57f0a890eb24262b8b0db154baa5c7">WaitForFrames</a> (int frames)</td></tr>
|
||
|
|
<tr class="memdesc:a6f57f0a890eb24262b8b0db154baa5c7"><td class="mdescLeft"> </td><td class="mdescRight">Waits until an amount of frames have passed. Don't use this with non-fixed framerates. <a href="#a6f57f0a890eb24262b8b0db154baa5c7">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6f57f0a890eb24262b8b0db154baa5c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3ee6941e4b827f06f1162c82cff40653"><td class="memItemLeft" align="right" valign="top">IEnumerator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a3ee6941e4b827f06f1162c82cff40653">WaitForTween</a> (<a class="el" href="class_otter_1_1_tween.html">Tween</a> tween)</td></tr>
|
||
|
|
<tr class="memdesc:a3ee6941e4b827f06f1162c82cff40653"><td class="mdescLeft"> </td><td class="mdescRight">Waits for a <a class="el" href="class_otter_1_1_tween.html">Tween</a> to complete. <a href="#a3ee6941e4b827f06f1162c82cff40653">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3ee6941e4b827f06f1162c82cff40653"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6d54849e02a10bed8eda11f72dce1699"><td class="memItemLeft" align="right" valign="top">IEnumerator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a6d54849e02a10bed8eda11f72dce1699">WaitForDelegate</a> (Func< bool > func)</td></tr>
|
||
|
|
<tr class="memdesc:a6d54849e02a10bed8eda11f72dce1699"><td class="mdescLeft"> </td><td class="mdescRight">Waits for an anonymous method that returns true or false. <a href="#a6d54849e02a10bed8eda11f72dce1699">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6d54849e02a10bed8eda11f72dce1699"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
||
|
|
Static Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a3034b4e2f6e5e00e48ce4d9705b289ee"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_otter_1_1_coroutine.html">Coroutine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a3034b4e2f6e5e00e48ce4d9705b289ee">Instance</a></td></tr>
|
||
|
|
<tr class="memdesc:a3034b4e2f6e5e00e48ce4d9705b289ee"><td class="mdescLeft"> </td><td class="mdescRight">The reference to the main <a class="el" href="class_otter_1_1_coroutine.html" title="Class that manages Coroutines. ">Coroutine</a> object managed by <a class="el" href="namespace_otter.html">Otter</a>. <a href="#a3034b4e2f6e5e00e48ce4d9705b289ee">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3034b4e2f6e5e00e48ce4d9705b289ee"><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:ac11cad16716c780c5a5ad4d2c7ecd858"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#ac11cad16716c780c5a5ad4d2c7ecd858">Count</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:ac11cad16716c780c5a5ad4d2c7ecd858"><td class="mdescLeft"> </td><td class="mdescRight">The current number of running routines. <a href="#ac11cad16716c780c5a5ad4d2c7ecd858">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac11cad16716c780c5a5ad4d2c7ecd858"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5df4be0cb54efab4f6f0ebb6f2c9f013"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_coroutine.html#a5df4be0cb54efab4f6f0ebb6f2c9f013">Running</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:a5df4be0cb54efab4f6f0ebb6f2c9f013"><td class="mdescLeft"> </td><td class="mdescRight">If any routines are currently running. <a href="#a5df4be0cb54efab4f6f0ebb6f2c9f013">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5df4be0cb54efab4f6f0ebb6f2c9f013"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Class that manages Coroutines. </p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a class="anchor" id="ab347a99605d327ea3d0c3e510c6be002"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Otter.Coroutine.Coroutine </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create a new <a class="el" href="class_otter_1_1_coroutine.html" title="Class that manages Coroutines. ">Coroutine</a> manager. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a521801d74a6fe159e1446a4e30f5eb8c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Coroutine.HasEvent </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Check if an event has been published. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The string id of the event.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the event has been published.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a62a1ac2968fff94e2da3426411088fd1"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Coroutine.HasEvent </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Check if an event has been published. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The enum id of the event.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the event has been published.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa2dc3bb16642c50bcbd6ead32b7c35bf"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Coroutine.PublishEvent </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Publishes an event to the coroutine manager. Used for WaitForEvent. Events are cleared on every update. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The string id of the event.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa0daf4d33bc7ef998e85b5cc93e31aec"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Coroutine.PublishEvent </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Publishes an event to the coroutine manager. Used for WaitForEvent. Events are cleared on every update. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The enum id of the event.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8854889af04cb80a569004699041bd2d"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Coroutine.Start </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">IEnumerator </td>
|
||
|
|
<td class="paramname"><em>routine</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Starts a new coroutine and returns an int id for that routine. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">routine</td><td>The coroutine to start running.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>A unique int id for that routine.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aaa7374d9f884b6c60d78006c6d044af7"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Coroutine.Stop </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>routineId</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Stop a routine from running based off its int id. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">routineId</td><td>The id of the routine to stop.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a2e011298b8f9b6f643bea98cac4d65d4"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Coroutine.StopAll </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Immediately clear and stop all Coroutines. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a758a3277c6082b9a163368018be8cfe2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Coroutine.Update </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Updates all the routines. The coroutine in the <a class="el" href="class_otter_1_1_game.html" title="ᶜ(ᵔᴥᵔ)ᵓ Core class Otter. Create a Game, and then use Game.Start(); to run it. ">Game</a> automatically runs this. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6d54849e02a10bed8eda11f72dce1699"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">IEnumerator Otter.Coroutine.WaitForDelegate </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Func< bool > </td>
|
||
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Waits for an anonymous method that returns true or false. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">func</td><td>The method to run until it returns true.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ae3384c29ad52b1b185fb99802bd9e261"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">IEnumerator Otter.Coroutine.WaitForEvent </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Waits until a specific event has been published. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The string id of the event.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a20f552d9b7c0ea4b85d98b1e81cc8b62"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">IEnumerator Otter.Coroutine.WaitForEvent </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Waits until a specific event has been published. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The enum id of the event.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6f57f0a890eb24262b8b0db154baa5c7"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">IEnumerator Otter.Coroutine.WaitForFrames </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>frames</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Waits until an amount of frames have passed. Don't use this with non-fixed framerates. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">frames</td><td>The number of frames to wait.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a310bcd2ca7e428872fbf2e2bba7870e3"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">IEnumerator Otter.Coroutine.WaitForSeconds </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>seconds</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Waits until an amount of time has passed. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">seconds</td><td>The number of seconds to wait.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a3ee6941e4b827f06f1162c82cff40653"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">IEnumerator Otter.Coroutine.WaitForTween </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td>
|
||
|
|
<td class="paramname"><em>tween</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Waits for a <a class="el" href="class_otter_1_1_tween.html">Tween</a> to complete. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">tween</td><td>The <a class="el" href="class_otter_1_1_tween.html">Tween</a> to wait on.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a class="anchor" id="a3034b4e2f6e5e00e48ce4d9705b289ee"></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_coroutine.html">Coroutine</a> Otter.Coroutine.Instance</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The reference to the main <a class="el" href="class_otter_1_1_coroutine.html" title="Class that manages Coroutines. ">Coroutine</a> object managed by <a class="el" href="namespace_otter.html">Otter</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="ac11cad16716c780c5a5ad4d2c7ecd858"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Coroutine.Count</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 current number of running routines. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a5df4be0cb54efab4f6f0ebb6f2c9f013"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Coroutine.Running</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>If any routines are currently running. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Utility/Coroutine.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_coroutine.html">Coroutine</a></li>
|
||
|
|
<li class="footer">Generated on Thu May 12 2016 18:16:53 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>
|