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.
674 lines
56 KiB
HTML
674 lines
56 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.Counter 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_counter.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_counter-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.Counter Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> used for a value with built in min, max, and wrapping capabilities. Can be useful for making menus.
|
||
|
|
<a href="class_otter_1_1_counter.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:a0e771520102368256cca88cd3a180c68"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a0e771520102368256cca88cd3a180c68">Counter</a> (int value, int min, int max, bool wrap=false, bool cap=true)</td></tr>
|
||
|
|
<tr class="memdesc:a0e771520102368256cca88cd3a180c68"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#a0e771520102368256cca88cd3a180c68">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a0e771520102368256cca88cd3a180c68"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5cee003c5b5c12ab08f5a033379d5367"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a5cee003c5b5c12ab08f5a033379d5367">Reset</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a5cee003c5b5c12ab08f5a033379d5367"><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> back to its initial value. <a href="#a5cee003c5b5c12ab08f5a033379d5367">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5cee003c5b5c12ab08f5a033379d5367"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a627ea649029ca7e909e58064811b6e3f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a627ea649029ca7e909e58064811b6e3f">Increment</a> (int value=1)</td></tr>
|
||
|
|
<tr class="memdesc:a627ea649029ca7e909e58064811b6e3f"><td class="mdescLeft"> </td><td class="mdescRight">Increment the value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#a627ea649029ca7e909e58064811b6e3f">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a627ea649029ca7e909e58064811b6e3f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a46a0057914c584ba7bf4ab6b0be052a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a46a0057914c584ba7bf4ab6b0be052a2">Decrement</a> (int value=1)</td></tr>
|
||
|
|
<tr class="memdesc:a46a0057914c584ba7bf4ab6b0be052a2"><td class="mdescLeft"> </td><td class="mdescRight">Decrement the value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#a46a0057914c584ba7bf4ab6b0be052a2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a46a0057914c584ba7bf4ab6b0be052a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aea8d953bb06c5ce5ef02ca380e4fd1ca"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#aea8d953bb06c5ce5ef02ca380e4fd1ca">Update</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:aea8d953bb06c5ce5ef02ca380e4fd1ca"><td class="mdescLeft"> </td><td class="mdescRight">Update the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#aea8d953bb06c5ce5ef02ca380e4fd1ca">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aea8d953bb06c5ce5ef02ca380e4fd1ca"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8bdb2705e02582b310eaba515f2e7187"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a8bdb2705e02582b310eaba515f2e7187">GoToMax</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a8bdb2705e02582b310eaba515f2e7187"><td class="mdescLeft"> </td><td class="mdescRight">Force the value to the maximum value. <a href="#a8bdb2705e02582b310eaba515f2e7187">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8bdb2705e02582b310eaba515f2e7187"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a258aa35c8b4f8bd17ae11f405c6e1d06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a258aa35c8b4f8bd17ae11f405c6e1d06">GoToMin</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a258aa35c8b4f8bd17ae11f405c6e1d06"><td class="mdescLeft"> </td><td class="mdescRight">Force the value to the minimum value. <a href="#a258aa35c8b4f8bd17ae11f405c6e1d06">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a258aa35c8b4f8bd17ae11f405c6e1d06"><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:a63d05a537aeed59f7531d0ce69205cef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63d05a537aeed59f7531d0ce69205cef"></a>
|
||
|
|
static implicit </td><td class="memItemRight" valign="bottom"><b>operator float</b> (<a class="el" href="class_otter_1_1_counter.html">Counter</a> counter)</td></tr>
|
||
|
|
<tr class="separator:a63d05a537aeed59f7531d0ce69205cef"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac316ccd5677f6932228793c8f138bbb6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac316ccd5677f6932228793c8f138bbb6"></a>
|
||
|
|
static implicit </td><td class="memItemRight" valign="bottom"><b>operator int</b> (<a class="el" href="class_otter_1_1_counter.html">Counter</a> counter)</td></tr>
|
||
|
|
<tr class="separator:ac316ccd5677f6932228793c8f138bbb6"><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:a3ad41ec18b8375675cd507c7a28d8743"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a3ad41ec18b8375675cd507c7a28d8743">Value</a> = 0</td></tr>
|
||
|
|
<tr class="memdesc:a3ad41ec18b8375675cd507c7a28d8743"><td class="mdescLeft"> </td><td class="mdescRight">The current value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#a3ad41ec18b8375675cd507c7a28d8743">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3ad41ec18b8375675cd507c7a28d8743"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aab66d7b9729d80767f2d94f8c5ec77f9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#aab66d7b9729d80767f2d94f8c5ec77f9">Wrap</a> = false</td></tr>
|
||
|
|
<tr class="memdesc:aab66d7b9729d80767f2d94f8c5ec77f9"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the value should wrap around when exceeding the min or max. <a href="#aab66d7b9729d80767f2d94f8c5ec77f9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aab66d7b9729d80767f2d94f8c5ec77f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a76a36163d0e5a5783e0fa0b18af7057b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a76a36163d0e5a5783e0fa0b18af7057b">Cap</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:a76a36163d0e5a5783e0fa0b18af7057b"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the value should be clamped by the minimum and maximum value. <a href="#a76a36163d0e5a5783e0fa0b18af7057b">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a76a36163d0e5a5783e0fa0b18af7057b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a31ac03021a59d7c0de9be9ca1dfd0fb7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a31ac03021a59d7c0de9be9ca1dfd0fb7">Min</a> = 0</td></tr>
|
||
|
|
<tr class="memdesc:a31ac03021a59d7c0de9be9ca1dfd0fb7"><td class="mdescLeft"> </td><td class="mdescRight">The minimum value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#a31ac03021a59d7c0de9be9ca1dfd0fb7">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a31ac03021a59d7c0de9be9ca1dfd0fb7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1aa7617724125fb56e019127522a96e2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a1aa7617724125fb56e019127522a96e2">Max</a> = 0</td></tr>
|
||
|
|
<tr class="memdesc:a1aa7617724125fb56e019127522a96e2"><td class="mdescLeft"> </td><td class="mdescRight">The maximum value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#a1aa7617724125fb56e019127522a96e2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a1aa7617724125fb56e019127522a96e2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac15695b0b0b505a7dbcc1e1b391ae355"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#ac15695b0b0b505a7dbcc1e1b391ae355">InitialValue</a> = 0</td></tr>
|
||
|
|
<tr class="memdesc:ac15695b0b0b505a7dbcc1e1b391ae355"><td class="mdescLeft"> </td><td class="mdescRight">The starting value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. <a href="#ac15695b0b0b505a7dbcc1e1b391ae355">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac15695b0b0b505a7dbcc1e1b391ae355"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9d26938931d74e2b8ba1b9fdefa02080"><td class="memItemLeft" align="right" valign="top">Action </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a9d26938931d74e2b8ba1b9fdefa02080">OnIncrement</a></td></tr>
|
||
|
|
<tr class="memdesc:a9d26938931d74e2b8ba1b9fdefa02080"><td class="mdescLeft"> </td><td class="mdescRight">A callback for when the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> increments. <a href="#a9d26938931d74e2b8ba1b9fdefa02080">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a9d26938931d74e2b8ba1b9fdefa02080"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a74237a00c6e345c8e47c5ee7a882dc1f"><td class="memItemLeft" align="right" valign="top">Action </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a74237a00c6e345c8e47c5ee7a882dc1f">OnDecrement</a></td></tr>
|
||
|
|
<tr class="memdesc:a74237a00c6e345c8e47c5ee7a882dc1f"><td class="mdescLeft"> </td><td class="mdescRight">A callback for when the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> decrements. <a href="#a74237a00c6e345c8e47c5ee7a882dc1f">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a74237a00c6e345c8e47c5ee7a882dc1f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7085af215b08b6afcb689a71a26bd57c"><td class="memItemLeft" align="right" valign="top">Action </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a7085af215b08b6afcb689a71a26bd57c">OnMax</a></td></tr>
|
||
|
|
<tr class="memdesc:a7085af215b08b6afcb689a71a26bd57c"><td class="mdescLeft"> </td><td class="mdescRight">A callback for when the counter reaches the maximum value. <a href="#a7085af215b08b6afcb689a71a26bd57c">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a7085af215b08b6afcb689a71a26bd57c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a52e6575720317a504e466efeda0dbe60"><td class="memItemLeft" align="right" valign="top">Action </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a52e6575720317a504e466efeda0dbe60">OnMin</a></td></tr>
|
||
|
|
<tr class="memdesc:a52e6575720317a504e466efeda0dbe60"><td class="mdescLeft"> </td><td class="mdescRight">A callback for when the counter reaches the minimum value. <a href="#a52e6575720317a504e466efeda0dbe60">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a52e6575720317a504e466efeda0dbe60"><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:a463164887f34a80a3415dde9ddc14122"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a463164887f34a80a3415dde9ddc14122">AtMax</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:a463164887f34a80a3415dde9ddc14122"><td class="mdescLeft"> </td><td class="mdescRight">If the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> is currently at or exceeding the maximum value. <a href="#a463164887f34a80a3415dde9ddc14122">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a463164887f34a80a3415dde9ddc14122"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a23d3488f1b861495aef40b0fb4673d03"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#a23d3488f1b861495aef40b0fb4673d03">AtMin</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:a23d3488f1b861495aef40b0fb4673d03"><td class="mdescLeft"> </td><td class="mdescRight">If the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> is currently at or exceeding the minimum value. <a href="#a23d3488f1b861495aef40b0fb4673d03">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a23d3488f1b861495aef40b0fb4673d03"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acc64667d4618a8a1a014b6f0b641af2f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_counter.html#acc64667d4618a8a1a014b6f0b641af2f">Length</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:acc64667d4618a8a1a014b6f0b641af2f"><td class="mdescLeft"> </td><td class="mdescRight">The length of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> from Min to Max. <a href="#acc64667d4618a8a1a014b6f0b641af2f">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:acc64667d4618a8a1a014b6f0b641af2f"><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 class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> used for a value with built in min, max, and wrapping capabilities. Can be useful for making menus. </p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a class="anchor" id="a0e771520102368256cca88cd3a180c68"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Otter.Counter.Counter </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>value</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>min</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>max</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>wrap</em> = <code>false</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>cap</em> = <code>true</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create a new <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">value</td><td>The initial value.</td></tr>
|
||
|
|
<tr><td class="paramname">min</td><td>The minimum value.</td></tr>
|
||
|
|
<tr><td class="paramname">max</td><td>The maximum value.</td></tr>
|
||
|
|
<tr><td class="paramname">wrap</td><td>If the counter should wrap when it reaches the minimum or maximum values.</td></tr>
|
||
|
|
<tr><td class="paramname">cap</td><td>If the counter shouldn't be allowed to exceed the minimum or maximum values.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a46a0057914c584ba7bf4ab6b0be052a2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Counter.Decrement </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>value</em> = <code>1</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Decrement the value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">value</td><td>How much to decrement by.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The new value.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8bdb2705e02582b310eaba515f2e7187"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Counter.GoToMax </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Force the value to the maximum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a258aa35c8b4f8bd17ae11f405c6e1d06"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Counter.GoToMin </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Force the value to the minimum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a627ea649029ca7e909e58064811b6e3f"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Counter.Increment </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>value</em> = <code>1</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Increment the value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">value</td><td>How much to increment by.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The new value.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a5cee003c5b5c12ab08f5a033379d5367"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Counter.Reset </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Reset the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> back to its initial value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aea8d953bb06c5ce5ef02ca380e4fd1ca"></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.Counter.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_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</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="a76a36163d0e5a5783e0fa0b18af7057b"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Counter.Cap = true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Determines if the value should be clamped by the minimum and maximum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ac15695b0b0b505a7dbcc1e1b391ae355"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Counter.InitialValue = 0</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The starting value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a1aa7617724125fb56e019127522a96e2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Counter.Max = 0</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The maximum value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a31ac03021a59d7c0de9be9ca1dfd0fb7"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Counter.Min = 0</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The minimum value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a74237a00c6e345c8e47c5ee7a882dc1f"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Action Otter.Counter.OnDecrement</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>A callback for when the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> decrements. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9d26938931d74e2b8ba1b9fdefa02080"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Action Otter.Counter.OnIncrement</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>A callback for when the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> increments. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a7085af215b08b6afcb689a71a26bd57c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Action Otter.Counter.OnMax</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>A callback for when the counter reaches the maximum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a52e6575720317a504e466efeda0dbe60"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Action Otter.Counter.OnMin</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>A callback for when the counter reaches the minimum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a3ad41ec18b8375675cd507c7a28d8743"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Counter.Value = 0</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The current value of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aab66d7b9729d80767f2d94f8c5ec77f9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Counter.Wrap = false</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Determines if the value should wrap around when exceeding the min or max. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="a463164887f34a80a3415dde9ddc14122"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Counter.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 <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> is currently at or exceeding the maximum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a23d3488f1b861495aef40b0fb4673d03"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Counter.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 <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> is currently at or exceeding the minimum value. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="acc64667d4618a8a1a014b6f0b641af2f"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Counter.Length</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 length of the <a class="el" href="class_otter_1_1_counter.html" title="Component used for a value with built in min, max, and wrapping capabilities. Can be useful for makin...">Counter</a> from Min to Max. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Components/Counter.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_counter.html">Counter</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>
|