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.
576 lines
46 KiB
HTML
576 lines
46 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.AutoTimer 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_auto_timer.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-methods">Static Public Member Functions</a> |
|
||
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
||
|
|
<a href="#properties">Properties</a> |
|
||
|
|
<a href="class_otter_1_1_auto_timer-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.AutoTimer Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>A timer that automatically counts on an increment. Useful for handling things like cooldowns.
|
||
|
|
<a href="class_otter_1_1_auto_timer.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p>Inherits <a class="el" href="class_otter_1_1_component.html">Otter.Component</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:a3fbccab9b7d7726c55c4f85900fdeb70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a3fbccab9b7d7726c55c4f85900fdeb70">AutoTimer</a> (float max)</td></tr>
|
||
|
|
<tr class="memdesc:a3fbccab9b7d7726c55c4f85900fdeb70"><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="class_otter_1_1_auto_timer.html" title="A timer that automatically counts on an increment. Useful for handling things like cooldowns...">AutoTimer</a>. <a href="#a3fbccab9b7d7726c55c4f85900fdeb70">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3fbccab9b7d7726c55c4f85900fdeb70"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8867af73537234e1367295df22df8ba8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a8867af73537234e1367295df22df8ba8">AutoTimer</a> (float value, float min, float max, float increment)</td></tr>
|
||
|
|
<tr class="memdesc:a8867af73537234e1367295df22df8ba8"><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="class_otter_1_1_auto_timer.html" title="A timer that automatically counts on an increment. Useful for handling things like cooldowns...">AutoTimer</a>. <a href="#a8867af73537234e1367295df22df8ba8">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8867af73537234e1367295df22df8ba8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a062e5416095db9d88c9a62af7c073b9e"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a062e5416095db9d88c9a62af7c073b9e">Update</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a062e5416095db9d88c9a62af7c073b9e"><td class="mdescLeft"> </td><td class="mdescRight">Update the <a class="el" href="class_otter_1_1_auto_timer.html" title="A timer that automatically counts on an increment. Useful for handling things like cooldowns...">AutoTimer</a>. <a href="#a062e5416095db9d88c9a62af7c073b9e">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a062e5416095db9d88c9a62af7c073b9e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1bfddb0ef0cba5de59ff46c5cfdd8571"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a1bfddb0ef0cba5de59ff46c5cfdd8571">Reset</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a1bfddb0ef0cba5de59ff46c5cfdd8571"><td class="mdescLeft"> </td><td class="mdescRight">Reset the timer to 0. <a href="#a1bfddb0ef0cba5de59ff46c5cfdd8571">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a1bfddb0ef0cba5de59ff46c5cfdd8571"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9aa2f7a72ab39b6ece3e22f587eefe34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a9aa2f7a72ab39b6ece3e22f587eefe34">Pause</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a9aa2f7a72ab39b6ece3e22f587eefe34"><td class="mdescLeft"> </td><td class="mdescRight">Pause the timer. <a href="#a9aa2f7a72ab39b6ece3e22f587eefe34">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a9aa2f7a72ab39b6ece3e22f587eefe34"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae0a6f46547b19b6d119b5cf7593bd125"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#ae0a6f46547b19b6d119b5cf7593bd125">Resume</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ae0a6f46547b19b6d119b5cf7593bd125"><td class="mdescLeft"> </td><td class="mdescRight">Resume the timer if paused. <a href="#ae0a6f46547b19b6d119b5cf7593bd125">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ae0a6f46547b19b6d119b5cf7593bd125"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a90679ed64e95077f4bc416dd56a5db7f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a90679ed64e95077f4bc416dd56a5db7f">Start</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a90679ed64e95077f4bc416dd56a5db7f"><td class="mdescLeft"> </td><td class="mdescRight">Start the timer again from 0. <a href="#a90679ed64e95077f4bc416dd56a5db7f">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a90679ed64e95077f4bc416dd56a5db7f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8815e1bccdf02c74c90c1f695ef79acf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a8815e1bccdf02c74c90c1f695ef79acf">Stop</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a8815e1bccdf02c74c90c1f695ef79acf"><td class="mdescLeft"> </td><td class="mdescRight">Stop the timer and set the value to 0. <a href="#a8815e1bccdf02c74c90c1f695ef79acf">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8815e1bccdf02c74c90c1f695ef79acf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_class_otter_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_otter_1_1_component')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_otter_1_1_component.html">Otter.Component</a></td></tr>
|
||
|
|
<tr class="memitem:a9614ef82f236ab6ed8c3cb9d7715e815 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a9614ef82f236ab6ed8c3cb9d7715e815">GetEntity< T ></a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a9614ef82f236ab6ed8c3cb9d7715e815 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get 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> as a specific Type. <a href="#a9614ef82f236ab6ed8c3cb9d7715e815">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a9614ef82f236ab6ed8c3cb9d7715e815 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a896ba54fa65a3208621eaa06e23ac042 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a896ba54fa65a3208621eaa06e23ac042">Added</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a896ba54fa65a3208621eaa06e23ac042 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called when the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> is added to 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>. <a href="#a896ba54fa65a3208621eaa06e23ac042">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a896ba54fa65a3208621eaa06e23ac042 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a36bfe8aa7c9d8e9a71d0265ed3118e81 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a36bfe8aa7c9d8e9a71d0265ed3118e81">Removed</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a36bfe8aa7c9d8e9a71d0265ed3118e81 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called when the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> is removed from 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>. <a href="#a36bfe8aa7c9d8e9a71d0265ed3118e81">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a36bfe8aa7c9d8e9a71d0265ed3118e81 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac0ab335d5603e5f09268e360a0710d09 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ac0ab335d5603e5f09268e360a0710d09">RemoveSelf</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ac0ab335d5603e5f09268e360a0710d09 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Removes the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> from its parent <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>. <a href="#ac0ab335d5603e5f09268e360a0710d09">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac0ab335d5603e5f09268e360a0710d09 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a44d89b80a8843ac6042dbfd4793a8df5 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a44d89b80a8843ac6042dbfd4793a8df5">UpdateFirst</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a44d89b80a8843ac6042dbfd4793a8df5 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called during the UpdateFirst on the parent <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>. <a href="#a44d89b80a8843ac6042dbfd4793a8df5">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a44d89b80a8843ac6042dbfd4793a8df5 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2cbb5cdad72e0ea64e2f7516e025bb11 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a2cbb5cdad72e0ea64e2f7516e025bb11">Render</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a2cbb5cdad72e0ea64e2f7516e025bb11 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called during the Render on the parent <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>. <a href="#a2cbb5cdad72e0ea64e2f7516e025bb11">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a2cbb5cdad72e0ea64e2f7516e025bb11 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af7b18954fddd565ee9514cc2046b7cea inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#af7b18954fddd565ee9514cc2046b7cea">UpdateLast</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:af7b18954fddd565ee9514cc2046b7cea inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called during the UpdateLast on the parent <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>. <a href="#af7b18954fddd565ee9514cc2046b7cea">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:af7b18954fddd565ee9514cc2046b7cea inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a5bc7ea52a216ad05157e7ba5dec11672">GetComponent< T ></a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Gets the first <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> of type T from this <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>'s <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>. <a href="#a5bc7ea52a216ad05157e7ba5dec11672">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a0ee21d56d7c47862da8be5e52cefb529">GetComponents< T ></a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Gets a list of Components of type T from this <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>'s <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>. <a href="#a0ee21d56d7c47862da8be5e52cefb529">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||
|
|
Static Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:ab2f523afdd4d8a30eb5f1d3be2c6c436"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2f523afdd4d8a30eb5f1d3be2c6c436"></a>
|
||
|
|
static implicit </td><td class="memItemRight" valign="bottom"><b>operator float</b> (<a class="el" href="class_otter_1_1_auto_timer.html">AutoTimer</a> timer)</td></tr>
|
||
|
|
<tr class="separator:ab2f523afdd4d8a30eb5f1d3be2c6c436"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae84963853911e72247c2f10a1294c9bf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae84963853911e72247c2f10a1294c9bf"></a>
|
||
|
|
static implicit </td><td class="memItemRight" valign="bottom"><b>operator int</b> (<a class="el" href="class_otter_1_1_auto_timer.html">AutoTimer</a> timer)</td></tr>
|
||
|
|
<tr class="separator:ae84963853911e72247c2f10a1294c9bf"><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:a16de716474589d7e6bdef0c7ee0da733"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a16de716474589d7e6bdef0c7ee0da733">Value</a></td></tr>
|
||
|
|
<tr class="memdesc:a16de716474589d7e6bdef0c7ee0da733"><td class="mdescLeft"> </td><td class="mdescRight">The current value of the timer. <a href="#a16de716474589d7e6bdef0c7ee0da733">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a16de716474589d7e6bdef0c7ee0da733"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa5d717719a04b4c99e73e0a7c56d5325"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#aa5d717719a04b4c99e73e0a7c56d5325">Max</a></td></tr>
|
||
|
|
<tr class="memdesc:aa5d717719a04b4c99e73e0a7c56d5325"><td class="mdescLeft"> </td><td class="mdescRight">The maximum possible value of the timer. <a href="#aa5d717719a04b4c99e73e0a7c56d5325">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa5d717719a04b4c99e73e0a7c56d5325"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9505e1859fab94a274692994e8a5e400"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a9505e1859fab94a274692994e8a5e400">Min</a></td></tr>
|
||
|
|
<tr class="memdesc:a9505e1859fab94a274692994e8a5e400"><td class="mdescLeft"> </td><td class="mdescRight">The minimum possible value of the timer. <a href="#a9505e1859fab94a274692994e8a5e400">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a9505e1859fab94a274692994e8a5e400"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5a7910613d6edec326fa47a975b32678"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a5a7910613d6edec326fa47a975b32678">Increment</a> = 1</td></tr>
|
||
|
|
<tr class="memdesc:a5a7910613d6edec326fa47a975b32678"><td class="mdescLeft"> </td><td class="mdescRight">How much the timer increments each update. <a href="#a5a7910613d6edec326fa47a975b32678">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5a7910613d6edec326fa47a975b32678"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_attribs_class_otter_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_otter_1_1_component')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_otter_1_1_component.html">Otter.Component</a></td></tr>
|
||
|
|
<tr class="memitem:a622eab27046de9233e421bf9e18824fe inherit pub_attribs_class_otter_1_1_component"><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_component.html#a622eab27046de9233e421bf9e18824fe">Entity</a></td></tr>
|
||
|
|
<tr class="memdesc:a622eab27046de9233e421bf9e18824fe inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The parent <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> of the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>. <a href="#a622eab27046de9233e421bf9e18824fe">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a622eab27046de9233e421bf9e18824fe inherit pub_attribs_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3503c833d8f7da07162182b3af743adb inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a3503c833d8f7da07162182b3af743adb">RenderAfterEntity</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:a3503c833d8f7da07162182b3af743adb inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> should render after 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> has rendered. <a href="#a3503c833d8f7da07162182b3af743adb">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3503c833d8f7da07162182b3af743adb inherit pub_attribs_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a92cf7d2d7058c35ee879daf95728c390 inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a92cf7d2d7058c35ee879daf95728c390">Visible</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:a92cf7d2d7058c35ee879daf95728c390 inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> will render. <a href="#a92cf7d2d7058c35ee879daf95728c390">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a92cf7d2d7058c35ee879daf95728c390 inherit pub_attribs_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aec8b7e96ceae938a19f99d6e38bd81a3 inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#aec8b7e96ceae938a19f99d6e38bd81a3">Timer</a> = 0</td></tr>
|
||
|
|
<tr class="memdesc:aec8b7e96ceae938a19f99d6e38bd81a3 inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">How long the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> has been alive (added to an <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> and updated.) <a href="#aec8b7e96ceae938a19f99d6e38bd81a3">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aec8b7e96ceae938a19f99d6e38bd81a3 inherit pub_attribs_class_otter_1_1_component"><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:af6294c02bdcbae317d66ec92e461c8a1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#af6294c02bdcbae317d66ec92e461c8a1">Paused</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:af6294c02bdcbae317d66ec92e461c8a1"><td class="mdescLeft"> </td><td class="mdescRight">If the timer is currently paused. <a href="#af6294c02bdcbae317d66ec92e461c8a1">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:af6294c02bdcbae317d66ec92e461c8a1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa719987b34f5d23139daf3fd9c2d2a9d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#aa719987b34f5d23139daf3fd9c2d2a9d">AtMax</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:aa719987b34f5d23139daf3fd9c2d2a9d"><td class="mdescLeft"> </td><td class="mdescRight">If the timer is currently at its maximum value. <a href="#aa719987b34f5d23139daf3fd9c2d2a9d">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa719987b34f5d23139daf3fd9c2d2a9d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7825986a3881c0206055bd9386b59e8f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_auto_timer.html#a7825986a3881c0206055bd9386b59e8f">AtMin</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:a7825986a3881c0206055bd9386b59e8f"><td class="mdescLeft"> </td><td class="mdescRight">If the timer is currently at its minimum value. <a href="#a7825986a3881c0206055bd9386b59e8f">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a7825986a3881c0206055bd9386b59e8f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header properties_class_otter_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('properties_class_otter_1_1_component')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_otter_1_1_component.html">Otter.Component</a></td></tr>
|
||
|
|
<tr class="memitem:ac0f8379345a3a41105d1f78413277edd inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ac0f8379345a3a41105d1f78413277edd">InstanceId</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:ac0f8379345a3a41105d1f78413277edd inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>'s id for 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> its attached to. <a href="#ac0f8379345a3a41105d1f78413277edd">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac0f8379345a3a41105d1f78413277edd inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af9b2b3b286b4e37001be95a0674b8285 inherit properties_class_otter_1_1_component"><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_component.html#af9b2b3b286b4e37001be95a0674b8285">Scene</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:af9b2b3b286b4e37001be95a0674b8285 inherit properties_class_otter_1_1_component"><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 the parent <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> is in. <a href="#af9b2b3b286b4e37001be95a0674b8285">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:af9b2b3b286b4e37001be95a0674b8285 inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5c5894d2272d5dd4259d952fed3c4532 inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_collider.html">Collider</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a5c5894d2272d5dd4259d952fed3c4532">Collider</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:a5c5894d2272d5dd4259d952fed3c4532 inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The first <a class="el" href="class_otter_1_1_collider.html" title="The base class used for collision detection. Entities contain Colliders that can check for collisions...">Collider</a> of the parent <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>. <a href="#a5c5894d2272d5dd4259d952fed3c4532">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5c5894d2272d5dd4259d952fed3c4532 inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae1f59cc511b6b9b0ed8efd946dad6ba5 inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_graphic.html">Graphic</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ae1f59cc511b6b9b0ed8efd946dad6ba5">Graphic</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:ae1f59cc511b6b9b0ed8efd946dad6ba5 inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The first <a class="el" href="class_otter_1_1_graphic.html" title="Base abstract class used for anything that can be rendered. ">Graphic</a> of the parent <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>. <a href="#ae1f59cc511b6b9b0ed8efd946dad6ba5">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ae1f59cc511b6b9b0ed8efd946dad6ba5 inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af59740c53a5d56085985232b6da1be3e inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List< <a class="el" href="class_otter_1_1_graphic.html">Graphic</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#af59740c53a5d56085985232b6da1be3e">Graphics</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:af59740c53a5d56085985232b6da1be3e inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The list of Graphics from the parent <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>. <a href="#af59740c53a5d56085985232b6da1be3e">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:af59740c53a5d56085985232b6da1be3e inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab0905b7a81b660e8aa4b1c4eb3aa7abc inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List< <a class="el" href="class_otter_1_1_collider.html">Collider</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ab0905b7a81b660e8aa4b1c4eb3aa7abc">Colliders</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:ab0905b7a81b660e8aa4b1c4eb3aa7abc inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The list of Colliders from the parent <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>. <a href="#ab0905b7a81b660e8aa4b1c4eb3aa7abc">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ab0905b7a81b660e8aa4b1c4eb3aa7abc inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>A timer that automatically counts on an increment. Useful for handling things like cooldowns. </p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a class="anchor" id="a3fbccab9b7d7726c55c4f85900fdeb70"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Otter.AutoTimer.AutoTimer </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>max</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create an <a class="el" href="class_otter_1_1_auto_timer.html" title="A timer that automatically counts on an increment. Useful for handling things like cooldowns...">AutoTimer</a>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">max</td><td>The maximum value of the timer.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8867af73537234e1367295df22df8ba8"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Otter.AutoTimer.AutoTimer </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>value</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>min</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>max</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>increment</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create an <a class="el" href="class_otter_1_1_auto_timer.html" title="A timer that automatically counts on an increment. Useful for handling things like cooldowns...">AutoTimer</a>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">value</td><td>The initial value of the timer.</td></tr>
|
||
|
|
<tr><td class="paramname">min</td><td>The minimum value of the timer.</td></tr>
|
||
|
|
<tr><td class="paramname">max</td><td>The maximum value of the timer.</td></tr>
|
||
|
|
<tr><td class="paramname">increment</td><td>The value that the timer increments with each update.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a9aa2f7a72ab39b6ece3e22f587eefe34"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.AutoTimer.Pause </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Pause the timer. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a1bfddb0ef0cba5de59ff46c5cfdd8571"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.AutoTimer.Reset </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Reset the timer to 0. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ae0a6f46547b19b6d119b5cf7593bd125"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.AutoTimer.Resume </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Resume the timer if paused. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a90679ed64e95077f4bc416dd56a5db7f"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.AutoTimer.Start </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Start the timer again from 0. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8815e1bccdf02c74c90c1f695ef79acf"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.AutoTimer.Stop </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Stop the timer and set the value to 0. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a062e5416095db9d88c9a62af7c073b9e"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">override void Otter.AutoTimer.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>Update the <a class="el" href="class_otter_1_1_auto_timer.html" title="A timer that automatically counts on an increment. Useful for handling things like cooldowns...">AutoTimer</a>. </p>
|
||
|
|
|
||
|
|
<p>Reimplemented from <a class="el" href="class_otter_1_1_component.html#ae777aef927019fdb858e31de6cf79909">Otter.Component</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a class="anchor" id="a5a7910613d6edec326fa47a975b32678"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.AutoTimer.Increment = 1</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>How much the timer increments each update. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa5d717719a04b4c99e73e0a7c56d5325"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.AutoTimer.Max</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The maximum possible value of the timer. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9505e1859fab94a274692994e8a5e400"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.AutoTimer.Min</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The minimum possible value of the timer. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a16de716474589d7e6bdef0c7ee0da733"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.AutoTimer.Value</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The current value of the timer. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="aa719987b34f5d23139daf3fd9c2d2a9d"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.AutoTimer.AtMax</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 the timer is currently at its maximum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a7825986a3881c0206055bd9386b59e8f"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.AutoTimer.AtMin</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 the timer is currently at its minimum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="af6294c02bdcbae317d66ec92e461c8a1"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.AutoTimer.Paused</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>If the timer is currently paused. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Components/AutoTimer.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_auto_timer.html">AutoTimer</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>
|