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

818 lines
66 KiB
HTML
Raw Normal View History Unescape Escape

Initial Commit für Otter2D Framework
2 years ago
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Otter: Otter.Button Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="otterlogosmall.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Otter
&#160;<span id="projectnumber">0.9.8.91</span>
</div>
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_otter_1_1_button.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_otter_1_1_button-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Otter.Button 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 interpreting input as a button. It can recieve input from multiple sources including keyboard, mouse buttons, or joystick buttons and axes. The button input can also be controlled in code.
<a href="class_otter_1_1_button.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:a29164b34478cd0ede86d9fc6605bdeeb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a29164b34478cd0ede86d9fc6605bdeeb">Button</a> ()</td></tr>
<tr class="memdesc:a29164b34478cd0ede86d9fc6605bdeeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a29164b34478cd0ede86d9fc6605bdeeb">More...</a><br/></td></tr>
<tr class="separator:a29164b34478cd0ede86d9fc6605bdeeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab754bf35e711efda0d8fe648fff0b032"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#ab754bf35e711efda0d8fe648fff0b032">Button</a> (<a class="el" href="class_otter_1_1_button.html">Button</a> source)</td></tr>
<tr class="memdesc:ab754bf35e711efda0d8fe648fff0b032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> by copying another existing <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#ab754bf35e711efda0d8fe648fff0b032">More...</a><br/></td></tr>
<tr class="separator:ab754bf35e711efda0d8fe648fff0b032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaae8f3999432d3749d8f2eb3f894d92e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#aaae8f3999432d3749d8f2eb3f894d92e">Reset</a> ()</td></tr>
<tr class="memdesc:aaae8f3999432d3749d8f2eb3f894d92e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> to report no input. <a href="#aaae8f3999432d3749d8f2eb3f894d92e">More...</a><br/></td></tr>
<tr class="separator:aaae8f3999432d3749d8f2eb3f894d92e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeaf8865e2c46b9bc9922bedde84a541"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#adeaf8865e2c46b9bc9922bedde84a541">Clear</a> ()</td></tr>
<tr class="memdesc:adeaf8865e2c46b9bc9922bedde84a541"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all registered inputs for the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#adeaf8865e2c46b9bc9922bedde84a541">More...</a><br/></td></tr>
<tr class="separator:adeaf8865e2c46b9bc9922bedde84a541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3986ce30dbf743883ff2b53eda170920"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a3986ce30dbf743883ff2b53eda170920">AddKey</a> (params <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>[] keys)</td></tr>
<tr class="memdesc:a3986ce30dbf743883ff2b53eda170920"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a keyboard Key to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a3986ce30dbf743883ff2b53eda170920">More...</a><br/></td></tr>
<tr class="separator:a3986ce30dbf743883ff2b53eda170920"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5db5d468fa28b8f6ba3126e2706acbcc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a5db5d468fa28b8f6ba3126e2706acbcc">AddMouseButton</a> (params <a class="el" href="namespace_otter.html#acfe5ce34857620e033849ef1e09f8431">MouseButton</a>[] mouseButtons)</td></tr>
<tr class="memdesc:a5db5d468fa28b8f6ba3126e2706acbcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a mouse button to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a5db5d468fa28b8f6ba3126e2706acbcc">More...</a><br/></td></tr>
<tr class="separator:a5db5d468fa28b8f6ba3126e2706acbcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89814f801b1fac1c41bb8621c467a49b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a89814f801b1fac1c41bb8621c467a49b">AddMouseWheel</a> (<a class="el" href="namespace_otter.html#aa20f1ffa9938a60ed5a40868af35d2bf">MouseWheelDirection</a> direction)</td></tr>
<tr class="memdesc:a89814f801b1fac1c41bb8621c467a49b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the mouse wheel to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a89814f801b1fac1c41bb8621c467a49b">More...</a><br/></td></tr>
<tr class="separator:a89814f801b1fac1c41bb8621c467a49b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebca50604bd2fae233fa951edaaed6dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#aebca50604bd2fae233fa951edaaed6dd">AddJoyButton</a> (int button, int joystick=0)</td></tr>
<tr class="memdesc:aebca50604bd2fae233fa951edaaed6dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a joystick button to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#aebca50604bd2fae233fa951edaaed6dd">More...</a><br/></td></tr>
<tr class="separator:aebca50604bd2fae233fa951edaaed6dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adec6223cd99066e8030721a5f2719b9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#adec6223cd99066e8030721a5f2719b9b">AddButton</a> (<a class="el" href="class_otter_1_1_button.html">Button</a> source)</td></tr>
<tr class="memdesc:adec6223cd99066e8030721a5f2719b9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add another <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> into this <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#adec6223cd99066e8030721a5f2719b9b">More...</a><br/></td></tr>
<tr class="separator:adec6223cd99066e8030721a5f2719b9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0904c3f4557d41a536bdfbd2245fd0ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a0904c3f4557d41a536bdfbd2245fd0ec">AddAxisButton</a> (<a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> button, int joystick=0)</td></tr>
<tr class="memdesc:a0904c3f4557d41a536bdfbd2245fd0ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a joystick AxisButton to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a0904c3f4557d41a536bdfbd2245fd0ec">More...</a><br/></td></tr>
<tr class="separator:a0904c3f4557d41a536bdfbd2245fd0ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3232cb91090096eba72f4c89c4c4da46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a3232cb91090096eba72f4c89c4c4da46">ForceState</a> (bool state)</td></tr>
<tr class="memdesc:a3232cb91090096eba72f4c89c4c4da46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force the state of the button. This will override player input. <a href="#a3232cb91090096eba72f4c89c4c4da46">More...</a><br/></td></tr>
<tr class="separator:a3232cb91090096eba72f4c89c4c4da46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3082d7d0350fe8c64380a814e48c181b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a3082d7d0350fe8c64380a814e48c181b">ReleaseState</a> ()</td></tr>
<tr class="memdesc:a3082d7d0350fe8c64380a814e48c181b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the button's state from forced control. Restores player input. <a href="#a3082d7d0350fe8c64380a814e48c181b">More...</a><br/></td></tr>
<tr class="separator:a3082d7d0350fe8c64380a814e48c181b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8178b6a92e43519e83ac186d1046eb1f"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a8178b6a92e43519e83ac186d1046eb1f">UpdateFirst</a> ()</td></tr>
<tr class="memdesc:a8178b6a92e43519e83ac186d1046eb1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the button status. <a href="#a8178b6a92e43519e83ac186d1046eb1f">More...</a><br/></td></tr>
<tr class="separator:a8178b6a92e43519e83ac186d1046eb1f"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a9614ef82f236ab6ed8c3cb9d7715e815">GetEntity&lt; T &gt;</a> ()</td></tr>
<tr class="memdesc:a9614ef82f236ab6ed8c3cb9d7715e815 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a896ba54fa65a3208621eaa06e23ac042 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a36bfe8aa7c9d8e9a71d0265ed3118e81 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ac0ab335d5603e5f09268e360a0710d09 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ae777aef927019fdb858e31de6cf79909 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ae777aef927019fdb858e31de6cf79909">Update</a> ()</td></tr>
<tr class="memdesc:ae777aef927019fdb858e31de6cf79909 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called during the Update 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="#ae777aef927019fdb858e31de6cf79909">More...</a><br/></td></tr>
<tr class="separator:ae777aef927019fdb858e31de6cf79909 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cbb5cdad72e0ea64e2f7516e025bb11 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:af7b18954fddd565ee9514cc2046b7cea inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a5bc7ea52a216ad05157e7ba5dec11672">GetComponent&lt; T &gt;</a> ()</td></tr>
<tr class="memdesc:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a0ee21d56d7c47862da8be5e52cefb529">GetComponents&lt; T &gt;</a> ()</td></tr>
<tr class="memdesc:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a168180a2000e9702dc1befd176160eb5"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a168180a2000e9702dc1befd176160eb5">Keys</a> = new List&lt;<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>&gt;()</td></tr>
<tr class="memdesc:a168180a2000e9702dc1befd176160eb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The keys registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a168180a2000e9702dc1befd176160eb5">More...</a><br/></td></tr>
<tr class="separator:a168180a2000e9702dc1befd176160eb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94fd0ce41d2f681a50ace08a8128280d"><td class="memItemLeft" align="right" valign="top">List&lt; List&lt; int &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a94fd0ce41d2f681a50ace08a8128280d">JoyButtons</a> = new List&lt;List&lt;int&gt;&gt;()</td></tr>
<tr class="memdesc:a94fd0ce41d2f681a50ace08a8128280d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The joystick Buttons registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a94fd0ce41d2f681a50ace08a8128280d">More...</a><br/></td></tr>
<tr class="separator:a94fd0ce41d2f681a50ace08a8128280d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affee4498d2f7cb5187aa9e268892578c"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="namespace_otter.html#acfe5ce34857620e033849ef1e09f8431">MouseButton</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#affee4498d2f7cb5187aa9e268892578c">MouseButtons</a> = new List&lt;<a class="el" href="namespace_otter.html#acfe5ce34857620e033849ef1e09f8431">MouseButton</a>&gt;()</td></tr>
<tr class="memdesc:affee4498d2f7cb5187aa9e268892578c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The mouse buttons registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#affee4498d2f7cb5187aa9e268892578c">More...</a><br/></td></tr>
<tr class="separator:affee4498d2f7cb5187aa9e268892578c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f254601294e400bc734cbd1372905df"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="namespace_otter.html#aa20f1ffa9938a60ed5a40868af35d2bf">MouseWheelDirection</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a6f254601294e400bc734cbd1372905df">MouseWheel</a> = new List&lt;<a class="el" href="namespace_otter.html#aa20f1ffa9938a60ed5a40868af35d2bf">MouseWheelDirection</a>&gt;()</td></tr>
<tr class="memdesc:a6f254601294e400bc734cbd1372905df"><td class="mdescLeft">&#160;</td><td class="mdescRight">The mouse wheel registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. <a href="#a6f254601294e400bc734cbd1372905df">More...</a><br/></td></tr>
<tr class="separator:a6f254601294e400bc734cbd1372905df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab429904f425a4086828387a375c5c191"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#ab429904f425a4086828387a375c5c191">Enabled</a> = true</td></tr>
<tr class="memdesc:ab429904f425a4086828387a375c5c191"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> is enabled. If not enabled all tests return false. <a href="#ab429904f425a4086828387a375c5c191">More...</a><br/></td></tr>
<tr class="separator:ab429904f425a4086828387a375c5c191"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6812d5208064586b9f614d8d33a1427d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a6812d5208064586b9f614d8d33a1427d">LastPressed</a> = float.MaxValue</td></tr>
<tr class="memdesc:a6812d5208064586b9f614d8d33a1427d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time passed since the last button press. <a href="#a6812d5208064586b9f614d8d33a1427d">More...</a><br/></td></tr>
<tr class="separator:a6812d5208064586b9f614d8d33a1427d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bc723cd88bb85b8dfb976672ff41c56"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a7bc723cd88bb85b8dfb976672ff41c56">LastReleased</a> = float.MaxValue</td></tr>
<tr class="memdesc:a7bc723cd88bb85b8dfb976672ff41c56"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time passed since the last button release. <a href="#a7bc723cd88bb85b8dfb976672ff41c56">More...</a><br/></td></tr>
<tr class="separator:a7bc723cd88bb85b8dfb976672ff41c56"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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>&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a3503c833d8f7da07162182b3af743adb inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a92cf7d2d7058c35ee879daf95728c390 inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:aec8b7e96ceae938a19f99d6e38bd81a3 inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">float&#160;</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">&#160;</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">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ad5560bd25b138d8a1ef9311b67765df7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#ad5560bd25b138d8a1ef9311b67765df7">ForcedInput</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ad5560bd25b138d8a1ef9311b67765df7"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the button is currently controlled <a href="#ad5560bd25b138d8a1ef9311b67765df7">More...</a><br/></td></tr>
<tr class="separator:ad5560bd25b138d8a1ef9311b67765df7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74e366e914909363f78c7188d61fef65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a74e366e914909363f78c7188d61fef65">Pressed</a><code> [get]</code></td></tr>
<tr class="memdesc:a74e366e914909363f78c7188d61fef65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the button has been pressed. <a href="#a74e366e914909363f78c7188d61fef65">More...</a><br/></td></tr>
<tr class="separator:a74e366e914909363f78c7188d61fef65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6068920750dbf7dc101d085f1d672249"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a6068920750dbf7dc101d085f1d672249">Released</a><code> [get]</code></td></tr>
<tr class="memdesc:a6068920750dbf7dc101d085f1d672249"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the button has been released. <a href="#a6068920750dbf7dc101d085f1d672249">More...</a><br/></td></tr>
<tr class="separator:a6068920750dbf7dc101d085f1d672249"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58c33f75837032d0b46d5b1b95e830bf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#a58c33f75837032d0b46d5b1b95e830bf">Down</a><code> [get]</code></td></tr>
<tr class="memdesc:a58c33f75837032d0b46d5b1b95e830bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the button is down. <a href="#a58c33f75837032d0b46d5b1b95e830bf">More...</a><br/></td></tr>
<tr class="separator:a58c33f75837032d0b46d5b1b95e830bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc9dad00ea0efccd515334fa347630b2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_button.html#adc9dad00ea0efccd515334fa347630b2">Up</a><code> [get]</code></td></tr>
<tr class="memdesc:adc9dad00ea0efccd515334fa347630b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the button is up. <a href="#adc9dad00ea0efccd515334fa347630b2">More...</a><br/></td></tr>
<tr class="separator:adc9dad00ea0efccd515334fa347630b2"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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&#160;</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">&#160;</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">&#160;</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>&#160;</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">&#160;</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">&#160;</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>&#160;</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">&#160;</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">&#160;</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>&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:af59740c53a5d56085985232b6da1be3e inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_otter_1_1_graphic.html">Graphic</a> &gt;&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ab0905b7a81b660e8aa4b1c4eb3aa7abc inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_otter_1_1_collider.html">Collider</a> &gt;&#160;</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">&#160;</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">&#160;</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 interpreting input as a button. It can recieve input from multiple sources including keyboard, mouse buttons, or joystick buttons and axes. The button input can also be controlled in code. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a29164b34478cd0ede86d9fc6605bdeeb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Button.Button </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Optional string name of the button.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab754bf35e711efda0d8fe648fff0b032"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Button.Button </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> by copying another existing <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> to copy.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0904c3f4557d41a536bdfbd2245fd0ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Button.AddAxisButton </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a>&#160;</td>
<td class="paramname"><em>button</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>joystick</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a joystick AxisButton to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">button</td><td>The AxisButton to add.</td></tr>
<tr><td class="paramname">joystick</td><td>The joystick id of the button to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>.</dd></dl>
</div>
</div>
<a class="anchor" id="adec6223cd99066e8030721a5f2719b9b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Button.AddButton </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_otter_1_1_button.html">Button</a>&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add another <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> into this <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> to add into this <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>.</dd></dl>
</div>
</div>
<a class="anchor" id="aebca50604bd2fae233fa951edaaed6dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Button.AddJoyButton </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>button</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>joystick</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a joystick button to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">button</td><td>The joystick button to add.</td></tr>
<tr><td class="paramname">joystick</td><td>The joystick id of the button to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>.</dd></dl>
</div>
</div>
<a class="anchor" id="a3986ce30dbf743883ff2b53eda170920"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Button.AddKey </td>
<td>(</td>
<td class="paramtype">params <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>[]&#160;</td>
<td class="paramname"><em>keys</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a keyboard Key to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td>The key to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>.</dd></dl>
</div>
</div>
<a class="anchor" id="a5db5d468fa28b8f6ba3126e2706acbcc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Button.AddMouseButton </td>
<td>(</td>
<td class="paramtype">params <a class="el" href="namespace_otter.html#acfe5ce34857620e033849ef1e09f8431">MouseButton</a>[]&#160;</td>
<td class="paramname"><em>mouseButtons</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a mouse button to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mouseButtons</td><td>The mouse button to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>.</dd></dl>
</div>
</div>
<a class="anchor" id="a89814f801b1fac1c41bb8621c467a49b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Button.AddMouseWheel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespace_otter.html#aa20f1ffa9938a60ed5a40868af35d2bf">MouseWheelDirection</a>&#160;</td>
<td class="paramname"><em>direction</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add the mouse wheel to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">direction</td><td>The mouse wheel direction to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>.</dd></dl>
</div>
</div>
<a class="anchor" id="adeaf8865e2c46b9bc9922bedde84a541"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.Button.Clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear all registered inputs for the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
</div>
</div>
<a class="anchor" id="a3232cb91090096eba72f4c89c4c4da46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.Button.ForceState </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Force the state of the button. This will override player input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>The state of the button, true for down, false for up.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3082d7d0350fe8c64380a814e48c181b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.Button.ReleaseState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Release the button's state from forced control. Restores player input. </p>
</div>
</div>
<a class="anchor" id="aaae8f3999432d3749d8f2eb3f894d92e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.Button.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_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> to report no input. </p>
</div>
</div>
<a class="anchor" id="a8178b6a92e43519e83ac186d1046eb1f"></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.Button.UpdateFirst </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 button status. </p>
<p>Reimplemented from <a class="el" href="class_otter_1_1_component.html#a44d89b80a8843ac6042dbfd4793a8df5">Otter.Component</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ab429904f425a4086828387a375c5c191"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Otter.Button.Enabled = true</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> is enabled. If not enabled all tests return false. </p>
</div>
</div>
<a class="anchor" id="a94fd0ce41d2f681a50ace08a8128280d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">List&lt;List&lt;int&gt; &gt; Otter.Button.JoyButtons = new List&lt;List&lt;int&gt;&gt;()</td>
</tr>
</table>
</div><div class="memdoc">
<p>The joystick Buttons registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
</div>
</div>
<a class="anchor" id="a168180a2000e9702dc1befd176160eb5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">List&lt;<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>&gt; Otter.Button.Keys = new List&lt;<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>&gt;()</td>
</tr>
</table>
</div><div class="memdoc">
<p>The keys registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
</div>
</div>
<a class="anchor" id="a6812d5208064586b9f614d8d33a1427d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.Button.LastPressed = float.MaxValue</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time passed since the last button press. </p>
</div>
</div>
<a class="anchor" id="a7bc723cd88bb85b8dfb976672ff41c56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.Button.LastReleased = float.MaxValue</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time passed since the last button release. </p>
</div>
</div>
<a class="anchor" id="affee4498d2f7cb5187aa9e268892578c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">List&lt;<a class="el" href="namespace_otter.html#acfe5ce34857620e033849ef1e09f8431">MouseButton</a>&gt; Otter.Button.MouseButtons = new List&lt;<a class="el" href="namespace_otter.html#acfe5ce34857620e033849ef1e09f8431">MouseButton</a>&gt;()</td>
</tr>
</table>
</div><div class="memdoc">
<p>The mouse buttons registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
</div>
</div>
<a class="anchor" id="a6f254601294e400bc734cbd1372905df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">List&lt;<a class="el" href="namespace_otter.html#aa20f1ffa9938a60ed5a40868af35d2bf">MouseWheelDirection</a>&gt; Otter.Button.MouseWheel = new List&lt;<a class="el" href="namespace_otter.html#aa20f1ffa9938a60ed5a40868af35d2bf">MouseWheelDirection</a>&gt;()</td>
</tr>
</table>
</div><div class="memdoc">
<p>The mouse wheel registered to the <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a>. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a58c33f75837032d0b46d5b1b95e830bf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Otter.Button.Down</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>Check if the button is down. </p>
</div>
</div>
<a class="anchor" id="ad5560bd25b138d8a1ef9311b67765df7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Otter.Button.ForcedInput</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 button is currently controlled </p>
</div>
</div>
<a class="anchor" id="a74e366e914909363f78c7188d61fef65"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Otter.Button.Pressed</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>Check if the button has been pressed. </p>
</div>
</div>
<a class="anchor" id="a6068920750dbf7dc101d085f1d672249"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Otter.Button.Released</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>Check if the button has been released. </p>
</div>
</div>
<a class="anchor" id="adc9dad00ea0efccd515334fa347630b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Otter.Button.Up</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>Check if the button is up. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Otter/Components/Button.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_button.html">Button</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>