334 lines
15 KiB
HTML
334 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Rally Rush: godot::GameUI 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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">Rally Rush
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacegodot.html">godot</a></li><li class="navelem"><a class="el" href="classgodot_1_1GameUI.html">GameUI</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classgodot_1_1GameUI-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">godot::GameUI Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The in-game HUD.
|
|
<a href="classgodot_1_1GameUI.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="game__ui_8hpp_source.html">game_ui.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for godot::GameUI:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classgodot_1_1GameUI.png" alt=""/>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a445510c004c3202757ca006952493ab1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1GameUI.html#a445510c004c3202757ca006952493ab1">_enter_tree</a> () override</td></tr>
|
|
<tr class="memdesc:a445510c004c3202757ca006952493ab1"><td class="mdescLeft"> </td><td class="mdescRight">Connect listeners and get debug info label. <br /></td></tr>
|
|
<tr class="separator:a445510c004c3202757ca006952493ab1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdb7db5e693083667e2c3f9dcc3465aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1GameUI.html#afdb7db5e693083667e2c3f9dcc3465aa">append_debug_info</a> (String string)</td></tr>
|
|
<tr class="memdesc:afdb7db5e693083667e2c3f9dcc3465aa"><td class="mdescLeft"> </td><td class="mdescRight">Update the debug info label with new information. <br /></td></tr>
|
|
<tr class="separator:afdb7db5e693083667e2c3f9dcc3465aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:acc10d740c5a4d3973be9a3bad6a75e75"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1GameUI.html#acc10d740c5a4d3973be9a3bad6a75e75">on_key_found</a> (int total_found)</td></tr>
|
|
<tr class="memdesc:acc10d740c5a4d3973be9a3bad6a75e75"><td class="mdescLeft"> </td><td class="mdescRight">Listener for key_found observer on <a class="el" href="classgodot_1_1RallyRushGameMode.html" title="Game mode for Rally Rush. Mainly serves as a scorekeeper and patchbay for Observers....">RallyRushGameMode</a>. <br /></td></tr>
|
|
<tr class="separator:acc10d740c5a4d3973be9a3bad6a75e75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad380c7e2a7aa9911bc21ec7f727f1f9e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1GameUI.html#ad380c7e2a7aa9911bc21ec7f727f1f9e">on_all_keys_found</a> ()</td></tr>
|
|
<tr class="memdesc:ad380c7e2a7aa9911bc21ec7f727f1f9e"><td class="mdescLeft"> </td><td class="mdescRight">Listener for all_keys_found observer on <a class="el" href="classgodot_1_1RallyRushGameMode.html" title="Game mode for Rally Rush. Mainly serves as a scorekeeper and patchbay for Observers....">RallyRushGameMode</a>. <br /></td></tr>
|
|
<tr class="separator:ad380c7e2a7aa9911bc21ec7f727f1f9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a5d540331ad7bc3791bfa0de86fd21d9b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1GameUI.html#a5d540331ad7bc3791bfa0de86fd21d9b">GDCLASS</a> (<a class="el" href="classgodot_1_1GameUI.html">GameUI</a>, CanvasLayer)</td></tr>
|
|
<tr class="separator:a5d540331ad7bc3791bfa0de86fd21d9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3d92eb79557f1a854cef673a66c7c0ab"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1GameUI.html#a3d92eb79557f1a854cef673a66c7c0ab">_bind_methods</a> ()</td></tr>
|
|
<tr class="memdesc:a3d92eb79557f1a854cef673a66c7c0ab"><td class="mdescLeft"> </td><td class="mdescRight">Required to be a valid godot class. <br /></td></tr>
|
|
<tr class="separator:a3d92eb79557f1a854cef673a66c7c0ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:afb4ba2f3d1e075d2d35308639ea8aea7"><td class="memItemLeft" align="right" valign="top">Label * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1GameUI.html#afb4ba2f3d1e075d2d35308639ea8aea7">debug_info_label</a> {nullptr}</td></tr>
|
|
<tr class="separator:afb4ba2f3d1e075d2d35308639ea8aea7"><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 in-game HUD. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3d92eb79557f1a854cef673a66c7c0ab" name="a3d92eb79557f1a854cef673a66c7c0ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d92eb79557f1a854cef673a66c7c0ab">◆ </a></span>_bind_methods()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::GameUI::_bind_methods </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Required to be a valid godot class. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a445510c004c3202757ca006952493ab1" name="a445510c004c3202757ca006952493ab1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a445510c004c3202757ca006952493ab1">◆ </a></span>_enter_tree()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::GameUI::_enter_tree </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Connect listeners and get debug info label. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afdb7db5e693083667e2c3f9dcc3465aa" name="afdb7db5e693083667e2c3f9dcc3465aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdb7db5e693083667e2c3f9dcc3465aa">◆ </a></span>append_debug_info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::GameUI::append_debug_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">String </td>
|
|
<td class="paramname"><em>string</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the debug info label with new information. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d540331ad7bc3791bfa0de86fd21d9b" name="a5d540331ad7bc3791bfa0de86fd21d9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d540331ad7bc3791bfa0de86fd21d9b">◆ </a></span>GDCLASS()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">godot::GameUI::GDCLASS </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgodot_1_1GameUI.html">GameUI</a> </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">CanvasLayer </td>
|
|
<td class="paramname"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad380c7e2a7aa9911bc21ec7f727f1f9e" name="ad380c7e2a7aa9911bc21ec7f727f1f9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad380c7e2a7aa9911bc21ec7f727f1f9e">◆ </a></span>on_all_keys_found()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::GameUI::on_all_keys_found </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Listener for all_keys_found observer on <a class="el" href="classgodot_1_1RallyRushGameMode.html" title="Game mode for Rally Rush. Mainly serves as a scorekeeper and patchbay for Observers....">RallyRushGameMode</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acc10d740c5a4d3973be9a3bad6a75e75" name="acc10d740c5a4d3973be9a3bad6a75e75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc10d740c5a4d3973be9a3bad6a75e75">◆ </a></span>on_key_found()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::GameUI::on_key_found </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>total_found</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Listener for key_found observer on <a class="el" href="classgodot_1_1RallyRushGameMode.html" title="Game mode for Rally Rush. Mainly serves as a scorekeeper and patchbay for Observers....">RallyRushGameMode</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="afb4ba2f3d1e075d2d35308639ea8aea7" name="afb4ba2f3d1e075d2d35308639ea8aea7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb4ba2f3d1e075d2d35308639ea8aea7">◆ </a></span>debug_info_label</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Label* godot::GameUI::debug_info_label {nullptr}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="game__ui_8hpp_source.html">game_ui.hpp</a></li>
|
|
<li>src/<a class="el" href="game__ui_8cpp.html">game_ui.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
|
|
</small></address>
|
|
</body>
|
|
</html>
|