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.
618 lines
30 KiB
HTML
618 lines
30 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.Debugger 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_debugger.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="#pub-static-attribs">Static Public Attributes</a> |
|
||
|
<a href="#properties">Properties</a> |
|
||
|
<a href="class_otter_1_1_debugger-members.html">List of all members</a> </div>
|
||
|
<div class="headertitle">
|
||
|
<div class="title">Otter.Debugger Class Reference</div> </div>
|
||
|
</div><!--header-->
|
||
|
<div class="contents">
|
||
|
|
||
|
<p>The debug console. Only exists when the game is built in Debug Mode. The game will handle using this class. Can be summoned by default with the ~ key.
|
||
|
<a href="class_otter_1_1_debugger.html#details">More...</a></p>
|
||
|
<table class="memberdecls">
|
||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
Public Member Functions</h2></td></tr>
|
||
|
<tr class="memitem:ac5fa12576bb1701eb8cf72776176a994"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#ac5fa12576bb1701eb8cf72776176a994">Summon</a> ()</td></tr>
|
||
|
<tr class="memdesc:ac5fa12576bb1701eb8cf72776176a994"><td class="mdescLeft"> </td><td class="mdescRight">Summons the <a class="el" href="class_otter_1_1_debugger.html" title="The debug console. Only exists when the game is built in Debug Mode. The game will handle using this ...">Debugger</a>. <a href="#ac5fa12576bb1701eb8cf72776176a994">More...</a><br/></td></tr>
|
||
|
<tr class="separator:ac5fa12576bb1701eb8cf72776176a994"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ae0b53853a32e493838d47af6686be161"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#ae0b53853a32e493838d47af6686be161">ShowPerformance</a> (int level)</td></tr>
|
||
|
<tr class="memdesc:ae0b53853a32e493838d47af6686be161"><td class="mdescLeft"> </td><td class="mdescRight">Display performance information at a specified detail level. Set to 0 to disable. 5 is the most detailed. <a href="#ae0b53853a32e493838d47af6686be161">More...</a><br/></td></tr>
|
||
|
<tr class="separator:ae0b53853a32e493838d47af6686be161"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a9f298ffb12a3603dd9b741941da5ef0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a9f298ffb12a3603dd9b741941da5ef0a">LogTag</a> (string tag)</td></tr>
|
||
|
<tr class="memdesc:a9f298ffb12a3603dd9b741941da5ef0a"><td class="mdescLeft"> </td><td class="mdescRight">Toggle the logging of a specific tag. If the tag is off, it will be turned on, and vice versa. <a href="#a9f298ffb12a3603dd9b741941da5ef0a">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a9f298ffb12a3603dd9b741941da5ef0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:aa290c4a0d72932d079bb1a4a7663e0a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#aa290c4a0d72932d079bb1a4a7663e0a9">EnableCommandGroup</a> (string group)</td></tr>
|
||
|
<tr class="memdesc:aa290c4a0d72932d079bb1a4a7663e0a9"><td class="mdescLeft"> </td><td class="mdescRight">Enables commands in a specific group to be used. <a href="#aa290c4a0d72932d079bb1a4a7663e0a9">More...</a><br/></td></tr>
|
||
|
<tr class="separator:aa290c4a0d72932d079bb1a4a7663e0a9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a6f9c5ba30d28170e5a088bbed62f16fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a6f9c5ba30d28170e5a088bbed62f16fd">DisableCommandGroup</a> (string group)</td></tr>
|
||
|
<tr class="memdesc:a6f9c5ba30d28170e5a088bbed62f16fd"><td class="mdescLeft"> </td><td class="mdescRight">Disables commands in a specific group. <a href="#a6f9c5ba30d28170e5a088bbed62f16fd">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a6f9c5ba30d28170e5a088bbed62f16fd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:af98e47dc996b616079ef0674e71f18ca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#af98e47dc996b616079ef0674e71f18ca">Log</a> (string tag, object str, bool timestamp=true)</td></tr>
|
||
|
<tr class="memdesc:af98e47dc996b616079ef0674e71f18ca"><td class="mdescLeft"> </td><td class="mdescRight">Writes log data to the console. <a href="#af98e47dc996b616079ef0674e71f18ca">More...</a><br/></td></tr>
|
||
|
<tr class="separator:af98e47dc996b616079ef0674e71f18ca"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ab280840f916c11087a7c7ab082cac02a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#ab280840f916c11087a7c7ab082cac02a">Log</a> (object str, bool timestamp=true)</td></tr>
|
||
|
<tr class="memdesc:ab280840f916c11087a7c7ab082cac02a"><td class="mdescLeft"> </td><td class="mdescRight">Writes log data to the console. <a href="#ab280840f916c11087a7c7ab082cac02a">More...</a><br/></td></tr>
|
||
|
<tr class="separator:ab280840f916c11087a7c7ab082cac02a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ad001a9a8248261c2843acd4e7889f110"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#ad001a9a8248261c2843acd4e7889f110">Error</a> (string message)</td></tr>
|
||
|
<tr class="memdesc:ad001a9a8248261c2843acd4e7889f110"><td class="mdescLeft"> </td><td class="mdescRight">Send an error message to the debugger. Only really makes sense when the debugger is currently open, so probably want to call this from an <a class="el" href="class_otter_1_1_otter_command.html">OtterCommand</a> method when something goes wrong. <a href="#ad001a9a8248261c2843acd4e7889f110">More...</a><br/></td></tr>
|
||
|
<tr class="separator:ad001a9a8248261c2843acd4e7889f110"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a603b34f82350e8c77864221bd896abcf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a603b34f82350e8c77864221bd896abcf">Watch</a> (string str, object obj)</td></tr>
|
||
|
<tr class="memdesc:a603b34f82350e8c77864221bd896abcf"><td class="mdescLeft"> </td><td class="mdescRight">Add a variable to the watch list of the debug console. This must be called on every update to see the latest value! <a href="#a603b34f82350e8c77864221bd896abcf">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a603b34f82350e8c77864221bd896abcf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a447edee66ef7942f5f910f0f3b22f4e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a447edee66ef7942f5f910f0f3b22f4e9">RegisterCommands</a> ()</td></tr>
|
||
|
<tr class="memdesc:a447edee66ef7942f5f910f0f3b22f4e9"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes the available commands by finding any methods tagged with the <a class="el" href="class_otter_1_1_otter_command.html">OtterCommand</a> attribute. Don't do this a lot. <a href="#a447edee66ef7942f5f910f0f3b22f4e9">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a447edee66ef7942f5f910f0f3b22f4e9"><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:a3782b6e8e334051b96d22a6ab670b868"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a3782b6e8e334051b96d22a6ab670b868">ToggleKey</a> = Key.Tilde</td></tr>
|
||
|
<tr class="memdesc:a3782b6e8e334051b96d22a6ab670b868"><td class="mdescLeft"> </td><td class="mdescRight">The key used to summon and dismiss the debug console. <a href="#a3782b6e8e334051b96d22a6ab670b868">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a3782b6e8e334051b96d22a6ab670b868"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
</table><table class="memberdecls">
|
||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
||
|
Static Public Attributes</h2></td></tr>
|
||
|
<tr class="memitem:a4149e0143f1ad612497d444aac33b80e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_otter_1_1_debugger.html">Debugger</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a4149e0143f1ad612497d444aac33b80e">Instance</a></td></tr>
|
||
|
<tr class="memdesc:a4149e0143f1ad612497d444aac33b80e"><td class="mdescLeft"> </td><td class="mdescRight">Reference to the active instance of the debugger. <a href="#a4149e0143f1ad612497d444aac33b80e">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a4149e0143f1ad612497d444aac33b80e"><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:a3ff0b1004dd69de41ae0b6ebc0ed2dbc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a3ff0b1004dd69de41ae0b6ebc0ed2dbc">IsOpen</a><code> [get, set]</code></td></tr>
|
||
|
<tr class="memdesc:a3ff0b1004dd69de41ae0b6ebc0ed2dbc"><td class="mdescLeft"> </td><td class="mdescRight">If the debug console is currently open. <a href="#a3ff0b1004dd69de41ae0b6ebc0ed2dbc">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a3ff0b1004dd69de41ae0b6ebc0ed2dbc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:addd66f3bed74fda70fe5e7259014b59e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#addd66f3bed74fda70fe5e7259014b59e">Visible</a><code> [get, set]</code></td></tr>
|
||
|
<tr class="memdesc:addd66f3bed74fda70fe5e7259014b59e"><td class="mdescLeft"> </td><td class="mdescRight">If the debug console is currently visible. <a href="#addd66f3bed74fda70fe5e7259014b59e">More...</a><br/></td></tr>
|
||
|
<tr class="separator:addd66f3bed74fda70fe5e7259014b59e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a4ec60a991214a7cf7214077a86ae0d52"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a4ec60a991214a7cf7214077a86ae0d52">DebugCameraX</a><code> [get, set]</code></td></tr>
|
||
|
<tr class="memdesc:a4ec60a991214a7cf7214077a86ae0d52"><td class="mdescLeft"> </td><td class="mdescRight">The offset of the camera X set by debug camera mode. <a href="#a4ec60a991214a7cf7214077a86ae0d52">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a4ec60a991214a7cf7214077a86ae0d52"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a2a46518d59f4fbd2d1ba8c70e1f1fc39"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#a2a46518d59f4fbd2d1ba8c70e1f1fc39">DebugCameraY</a><code> [get, set]</code></td></tr>
|
||
|
<tr class="memdesc:a2a46518d59f4fbd2d1ba8c70e1f1fc39"><td class="mdescLeft"> </td><td class="mdescRight">The offset of the camera Y set by debug camera mode. <a href="#a2a46518d59f4fbd2d1ba8c70e1f1fc39">More...</a><br/></td></tr>
|
||
|
<tr class="separator:a2a46518d59f4fbd2d1ba8c70e1f1fc39"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ad0483ce923818202ae5b91df0adba501"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_debugger.html#ad0483ce923818202ae5b91df0adba501">LiveConsoleSize</a><code> [get, set]</code></td></tr>
|
||
|
<tr class="memdesc:ad0483ce923818202ae5b91df0adba501"><td class="mdescLeft"> </td><td class="mdescRight">The size of the live console in lines. If 0 the live console is hidden. <a href="#ad0483ce923818202ae5b91df0adba501">More...</a><br/></td></tr>
|
||
|
<tr class="separator:ad0483ce923818202ae5b91df0adba501"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
</table>
|
||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
<div class="textblock"><p>The debug console. Only exists when the game is built in Debug Mode. The game will handle using this class. Can be summoned by default with the ~ key. </p>
|
||
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
<a class="anchor" id="a6f9c5ba30d28170e5a088bbed62f16fd"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.DisableCommandGroup </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">string </td>
|
||
|
<td class="paramname"><em>group</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Disables commands in a specific group. </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">group</td><td></td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="aa290c4a0d72932d079bb1a4a7663e0a9"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.EnableCommandGroup </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">string </td>
|
||
|
<td class="paramname"><em>group</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Enables commands in a specific group to be used. </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">group</td><td></td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ad001a9a8248261c2843acd4e7889f110"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.Error </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">string </td>
|
||
|
<td class="paramname"><em>message</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Send an error message to the debugger. Only really makes sense when the debugger is currently open, so probably want to call this from an <a class="el" href="class_otter_1_1_otter_command.html">OtterCommand</a> method when something goes wrong. </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">message</td><td>The message to show.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="af98e47dc996b616079ef0674e71f18ca"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.Log </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">string </td>
|
||
|
<td class="paramname"><em>tag</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">object </td>
|
||
|
<td class="paramname"><em>str</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">bool </td>
|
||
|
<td class="paramname"><em>timestamp</em> = <code>true</code> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Writes log data to the console. </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">tag</td><td>The tag to associate the log with.</td></tr>
|
||
|
<tr><td class="paramname">str</td><td>The string to add to the console.</td></tr>
|
||
|
<tr><td class="paramname">timestamp</td><td>Include a timestamp with the item.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ab280840f916c11087a7c7ab082cac02a"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.Log </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">object </td>
|
||
|
<td class="paramname"><em>str</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">bool </td>
|
||
|
<td class="paramname"><em>timestamp</em> = <code>true</code> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Writes log data to the console. </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">str</td><td>The string to add to the console.</td></tr>
|
||
|
<tr><td class="paramname">timestamp</td><td>Include a timestamp with the item.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a9f298ffb12a3603dd9b741941da5ef0a"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.LogTag </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">string </td>
|
||
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Toggle the logging of a specific tag. If the tag is off, it will be turned on, and vice versa. </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">tag</td><td>The tag to toggle.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a447edee66ef7942f5f910f0f3b22f4e9"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.RegisterCommands </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramname"></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Refreshes the available commands by finding any methods tagged with the <a class="el" href="class_otter_1_1_otter_command.html">OtterCommand</a> attribute. Don't do this a lot. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ae0b53853a32e493838d47af6686be161"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.ShowPerformance </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">int </td>
|
||
|
<td class="paramname"><em>level</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Display performance information at a specified detail level. Set to 0 to disable. 5 is the most detailed. </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">level</td><td>The level of detail. 0 for disabled, 5 for the most detailed.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ac5fa12576bb1701eb8cf72776176a994"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.Summon </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramname"></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Summons the <a class="el" href="class_otter_1_1_debugger.html" title="The debug console. Only exists when the game is built in Debug Mode. The game will handle using this ...">Debugger</a>. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a603b34f82350e8c77864221bd896abcf"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void Otter.Debugger.Watch </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">string </td>
|
||
|
<td class="paramname"><em>str</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">object </td>
|
||
|
<td class="paramname"><em>obj</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Add a variable to the watch list of the debug console. This must be called on every update to see the latest value! </p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">str</td><td>The label for the value.</td></tr>
|
||
|
<tr><td class="paramname">obj</td><td>The value.</td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
<a class="anchor" id="a4149e0143f1ad612497d444aac33b80e"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname"><a class="el" href="class_otter_1_1_debugger.html">Debugger</a> Otter.Debugger.Instance</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</td>
|
||
|
<td class="mlabels-right">
|
||
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Reference to the active instance of the debugger. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a3782b6e8e334051b96d22a6ab670b868"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname"><a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> Otter.Debugger.ToggleKey = Key.Tilde</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>The key used to summon and dismiss the debug console. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
<a class="anchor" id="a4ec60a991214a7cf7214077a86ae0d52"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">float Otter.Debugger.DebugCameraX</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>The offset of the camera X set by debug camera mode. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a2a46518d59f4fbd2d1ba8c70e1f1fc39"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">float Otter.Debugger.DebugCameraY</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>The offset of the camera Y set by debug camera mode. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="a3ff0b1004dd69de41ae0b6ebc0ed2dbc"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">bool Otter.Debugger.IsOpen</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 debug console is currently open. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="ad0483ce923818202ae5b91df0adba501"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">int Otter.Debugger.LiveConsoleSize</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>The size of the live console in lines. If 0 the live console is hidden. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a class="anchor" id="addd66f3bed74fda70fe5e7259014b59e"></a>
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="mlabels">
|
||
|
<tr>
|
||
|
<td class="mlabels-left">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">bool Otter.Debugger.Visible</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 debug console is currently visible. </p>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
<li>Otter/Utility/Debugger.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_debugger.html">Debugger</a></li>
|
||
|
<li class="footer">Generated on Thu May 12 2016 18:16:53 for Otter by
|
||
|
<a href="http://www.doxygen.org/index.html">
|
||
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|