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.
541 lines
50 KiB
HTML
541 lines
50 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.Controller 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_controller.html','');});
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a></div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
||
|
|
<a href="#properties">Properties</a> |
|
||
|
|
<a href="class_otter_1_1_controller-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.Controller 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> representing a group of <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> and <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> classes. The controller updates all buttons and axes manually. This is used by the <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a> class to manage player input.
|
||
|
|
<a href="class_otter_1_1_controller.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p>Inherits <a class="el" href="class_otter_1_1_component.html">Otter.Component</a>.</p>
|
||
|
|
|
||
|
|
<p>Inherited by <a class="el" href="class_otter_1_1_controller_p_s3.html">Otter.ControllerPS3</a>, and <a class="el" href="class_otter_1_1_controller_xbox360.html">Otter.ControllerXbox360</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:a6871e2c6a367147be7009e968bf59f92"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6871e2c6a367147be7009e968bf59f92"></a>
|
||
|
|
 </td><td class="memItemRight" valign="bottom"><b>Controller</b> (params int[] joystickId)</td></tr>
|
||
|
|
<tr class="separator:a6871e2c6a367147be7009e968bf59f92"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a56bdfa36079ce81b610aac371f9d67fc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56bdfa36079ce81b610aac371f9d67fc"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_button.html">Button</a> </td><td class="memItemRight" valign="bottom"><b>Button</b> (Enum name)</td></tr>
|
||
|
|
<tr class="separator:a56bdfa36079ce81b610aac371f9d67fc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0efc688cf06208ee07354e6d085e8c5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0efc688cf06208ee07354e6d085e8c5e"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_button.html">Button</a> </td><td class="memItemRight" valign="bottom"><b>Button</b> (string name)</td></tr>
|
||
|
|
<tr class="separator:a0efc688cf06208ee07354e6d085e8c5e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7fb1399a298bec72a0d079fcb6d3dd63"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fb1399a298bec72a0d079fcb6d3dd63"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><b>Axis</b> (Enum name)</td></tr>
|
||
|
|
<tr class="separator:a7fb1399a298bec72a0d079fcb6d3dd63"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab851e2318ee6a85c3cee16ffdbe14239"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab851e2318ee6a85c3cee16ffdbe14239"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><b>Axis</b> (string name)</td></tr>
|
||
|
|
<tr class="separator:ab851e2318ee6a85c3cee16ffdbe14239"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5c3e380a262abeeb37b26c216a2cf2e8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c3e380a262abeeb37b26c216a2cf2e8"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddButton</b> (Enum name, <a class="el" href="class_otter_1_1_button.html">Button</a> b=null)</td></tr>
|
||
|
|
<tr class="separator:a5c3e380a262abeeb37b26c216a2cf2e8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae734d60f7e876f8a73061243bea93e16"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae734d60f7e876f8a73061243bea93e16"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddButton</b> (params Enum[] names)</td></tr>
|
||
|
|
<tr class="separator:ae734d60f7e876f8a73061243bea93e16"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af0e1cda01f9e30f1b751145e6abdf46c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0e1cda01f9e30f1b751145e6abdf46c"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddButton</b> (params string[] names)</td></tr>
|
||
|
|
<tr class="separator:af0e1cda01f9e30f1b751145e6abdf46c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a890f32cef050afee69cb782bc23115fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a890f32cef050afee69cb782bc23115fd"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddButton</b> (string name, <a class="el" href="class_otter_1_1_button.html">Button</a> b=null)</td></tr>
|
||
|
|
<tr class="separator:a890f32cef050afee69cb782bc23115fd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a902cf9cb8696cbc0c8a2174c56d64062"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a902cf9cb8696cbc0c8a2174c56d64062"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddAxis</b> (Enum name, <a class="el" href="class_otter_1_1_axis.html">Axis</a> a=null)</td></tr>
|
||
|
|
<tr class="separator:a902cf9cb8696cbc0c8a2174c56d64062"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a605dc697cdace532593f6729f29df2ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a605dc697cdace532593f6729f29df2ad"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddAxis</b> (string name, <a class="el" href="class_otter_1_1_axis.html">Axis</a> a=null)</td></tr>
|
||
|
|
<tr class="separator:a605dc697cdace532593f6729f29df2ad"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a97b033d66ad423f2fb65f01cf363d3ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97b033d66ad423f2fb65f01cf363d3ac"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddAxis</b> (params Enum[] names)</td></tr>
|
||
|
|
<tr class="separator:a97b033d66ad423f2fb65f01cf363d3ac"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:addcc9761e0bed1c6c4af43a2d20d152c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="addcc9761e0bed1c6c4af43a2d20d152c"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><b>AddAxis</b> (params string[] names)</td></tr>
|
||
|
|
<tr class="separator:addcc9761e0bed1c6c4af43a2d20d152c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afdb27f1a3b609f377bd781ae867032d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdb27f1a3b609f377bd781ae867032d4"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>Clear</b> ()</td></tr>
|
||
|
|
<tr class="separator:afdb27f1a3b609f377bd781ae867032d4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a72dbdccb383a2fa0e249f5ca95c43565"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#a72dbdccb383a2fa0e249f5ca95c43565">UpdateFirst</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a72dbdccb383a2fa0e249f5ca95c43565"><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="#a72dbdccb383a2fa0e249f5ca95c43565">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a72dbdccb383a2fa0e249f5ca95c43565"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4c1940c11f418fc3e8dbc2bd11550ba3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#a4c1940c11f418fc3e8dbc2bd11550ba3">Record</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a4c1940c11f418fc3e8dbc2bd11550ba3"><td class="mdescLeft"> </td><td class="mdescRight">Record the input to a string. Optionally save it out to a file when finished. <a href="#a4c1940c11f418fc3e8dbc2bd11550ba3">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4c1940c11f418fc3e8dbc2bd11550ba3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac6012777ada770fc585549f491ed5b10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#ac6012777ada770fc585549f491ed5b10">Playback</a> (string source)</td></tr>
|
||
|
|
<tr class="memdesc:ac6012777ada770fc585549f491ed5b10"><td class="mdescLeft"> </td><td class="mdescRight">Play back recorded input data. <a href="#ac6012777ada770fc585549f491ed5b10">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac6012777ada770fc585549f491ed5b10"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab36d10bce6ea439a813ebc9717808367"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#ab36d10bce6ea439a813ebc9717808367">PlaybackFile</a> (string path)</td></tr>
|
||
|
|
<tr class="memdesc:ab36d10bce6ea439a813ebc9717808367"><td class="mdescLeft"> </td><td class="mdescRight">Playbacks the recorded input data loaded from a file path. <a href="#ab36d10bce6ea439a813ebc9717808367">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ab36d10bce6ea439a813ebc9717808367"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a65e13d1f17c6a2ae654d2667a2834be2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#a65e13d1f17c6a2ae654d2667a2834be2">SaveRecording</a> (string path="")</td></tr>
|
||
|
|
<tr class="memdesc:a65e13d1f17c6a2ae654d2667a2834be2"><td class="mdescLeft"> </td><td class="mdescRight">Save the last recorded input data to a file. <a href="#a65e13d1f17c6a2ae654d2667a2834be2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a65e13d1f17c6a2ae654d2667a2834be2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a112badfcea08f3503adfd17bc8c528ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#a112badfcea08f3503adfd17bc8c528ae">Stop</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a112badfcea08f3503adfd17bc8c528ae"><td class="mdescLeft"> </td><td class="mdescRight">Stop the recording or playback of the controller. This will also release input states. <a href="#a112badfcea08f3503adfd17bc8c528ae">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a112badfcea08f3503adfd17bc8c528ae"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a683b855ec7cc1ef9f073f1dfdf03c680"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a683b855ec7cc1ef9f073f1dfdf03c680"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>Disable</b> ()</td></tr>
|
||
|
|
<tr class="separator:a683b855ec7cc1ef9f073f1dfdf03c680"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a812b5612596371eac3239cf9c8dc1a96"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a812b5612596371eac3239cf9c8dc1a96"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>Enable</b> ()</td></tr>
|
||
|
|
<tr class="separator:a812b5612596371eac3239cf9c8dc1a96"><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:ae777aef927019fdb858e31de6cf79909 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#ae777aef927019fdb858e31de6cf79909">Update</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ae777aef927019fdb858e31de6cf79909 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </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"> </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-attribs"></a>
|
||
|
|
Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a8085b5ff499a2feecbdb99fde01b43ef"><td class="memItemLeft" align="right" valign="top">List< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#a8085b5ff499a2feecbdb99fde01b43ef">JoystickIds</a> = new List<int>()</td></tr>
|
||
|
|
<tr class="memdesc:a8085b5ff499a2feecbdb99fde01b43ef"><td class="mdescLeft"> </td><td class="mdescRight">The joystick id associated with this controller. <a href="#a8085b5ff499a2feecbdb99fde01b43ef">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8085b5ff499a2feecbdb99fde01b43ef"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac34afeb30d8bd322e427008583dc9de2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#ac34afeb30d8bd322e427008583dc9de2">Enabled</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:ac34afeb30d8bd322e427008583dc9de2"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the controller is enabled. If not, all buttons return false, and all axes return 0, 0. <a href="#ac34afeb30d8bd322e427008583dc9de2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac34afeb30d8bd322e427008583dc9de2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6e42eea134c8e084a580200c486da6ac"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#a6e42eea134c8e084a580200c486da6ac">RecordAxes</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:a6e42eea134c8e084a580200c486da6ac"><td class="mdescLeft"> </td><td class="mdescRight">If the controller should record axes data. <a href="#a6e42eea134c8e084a580200c486da6ac">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6e42eea134c8e084a580200c486da6ac"><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:af1d4cfc969cd9517b4c7a14d126a06b9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#af1d4cfc969cd9517b4c7a14d126a06b9">Recording</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:af1d4cfc969cd9517b4c7a14d126a06b9"><td class="mdescLeft"> </td><td class="mdescRight">If the controller is currently recording input. <a href="#af1d4cfc969cd9517b4c7a14d126a06b9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:af1d4cfc969cd9517b4c7a14d126a06b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aad5cd6cc5e20b557794501f987d2cd1b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#aad5cd6cc5e20b557794501f987d2cd1b">Playing</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:aad5cd6cc5e20b557794501f987d2cd1b"><td class="mdescLeft"> </td><td class="mdescRight">If the controller is currently playing input data. <a href="#aad5cd6cc5e20b557794501f987d2cd1b">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aad5cd6cc5e20b557794501f987d2cd1b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa6d0ddd5b82e932deba2b969c3e2bff3"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_controller.html#aa6d0ddd5b82e932deba2b969c3e2bff3">LastRecordedString</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:aa6d0ddd5b82e932deba2b969c3e2bff3"><td class="mdescLeft"> </td><td class="mdescRight">The last recorded data as a compressed string. <a href="#aa6d0ddd5b82e932deba2b969c3e2bff3">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa6d0ddd5b82e932deba2b969c3e2bff3"><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> representing a group of <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> and <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> classes. The controller updates all buttons and axes manually. This is used by the <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a> class to manage player input. </p>
|
||
|
|
<p><a class="el" href="class_otter_1_1_input.html" title="Class used for managing input from the keyboard, mouse, and joysticks. Updated by the active Game...">Input</a> recording should only be used in fixed framerate games! If used with variable framerate the playback is not reliable. </p>
|
||
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="ac6012777ada770fc585549f491ed5b10"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Controller.Playback </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>source</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Play back recorded input data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">source</td><td>The recorded data.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ab36d10bce6ea439a813ebc9717808367"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Controller.PlaybackFile </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>path</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Playbacks the recorded input data loaded from a file path. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">path</td><td>The path to the file relative to <a class="el" href="class_otter_1_1_game.html#a72ef64d3ff24cce30aeaaf6595528d52" title="The main filepath for saving and loading files for the game. ">Game.Filepath</a>.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4c1940c11f418fc3e8dbc2bd11550ba3"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Controller.Record </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Record the input to a string. Optionally save it out to a file when finished. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a65e13d1f17c6a2ae654d2667a2834be2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Controller.SaveRecording </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>path</em> = <code>""</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Save the last recorded input data to a file. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">path</td><td>The path to save the data to.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a112badfcea08f3503adfd17bc8c528ae"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.Controller.Stop </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Stop the recording or playback of the controller. This will also release input states. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a72dbdccb383a2fa0e249f5ca95c43565"></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.Controller.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>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>. </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="ac34afeb30d8bd322e427008583dc9de2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Controller.Enabled = true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Determines if the controller is enabled. If not, all buttons return false, and all axes return 0, 0. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8085b5ff499a2feecbdb99fde01b43ef"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">List<int> Otter.Controller.JoystickIds = new List<int>()</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The joystick id associated with this controller. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6e42eea134c8e084a580200c486da6ac"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Controller.RecordAxes = true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>If the controller should record axes data. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="aa6d0ddd5b82e932deba2b969c3e2bff3"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.Controller.LastRecordedString</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 last recorded data as a compressed string. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aad5cd6cc5e20b557794501f987d2cd1b"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Controller.Playing</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 controller is currently playing input data. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="af1d4cfc969cd9517b4c7a14d126a06b9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.Controller.Recording</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 controller is currently recording input. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Components/Controllers/Controller.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_controller.html">Controller</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>
|