356 lines
16 KiB
HTML
356 lines
16 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::MenuUI 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_1MenuUI.html">MenuUI</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public 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_1MenuUI-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">godot::MenuUI Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The main menu UI parent.
|
|
<a href="classgodot_1_1MenuUI.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="menu__ui_8hpp_source.html">menu_ui.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for godot::MenuUI:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classgodot_1_1MenuUI.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:aad390dfde7c1cfdf3e116db06411dc82"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#aad390dfde7c1cfdf3e116db06411dc82">_ready</a> () override</td></tr>
|
|
<tr class="memdesc:aad390dfde7c1cfdf3e116db06411dc82"><td class="mdescLeft"> </td><td class="mdescRight">Register listeners with UI action observers. Get the controls panel child and hide it. <br /></td></tr>
|
|
<tr class="separator:aad390dfde7c1cfdf3e116db06411dc82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c753ab2eb4fed8d21c8d9f8d0f073cc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#a4c753ab2eb4fed8d21c8d9f8d0f073cc">start_game</a> ()</td></tr>
|
|
<tr class="memdesc:a4c753ab2eb4fed8d21c8d9f8d0f073cc"><td class="mdescLeft"> </td><td class="mdescRight">Load the game scene. Listener for start button "button_down" observer. <br /></td></tr>
|
|
<tr class="separator:a4c753ab2eb4fed8d21c8d9f8d0f073cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6af1760f9ae97a9d33c05e7ffd1f0ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#aa6af1760f9ae97a9d33c05e7ffd1f0ee">toggle_controls</a> ()</td></tr>
|
|
<tr class="memdesc:aa6af1760f9ae97a9d33c05e7ffd1f0ee"><td class="mdescLeft"> </td><td class="mdescRight">Show the controls screen. Listener for controls button "button_down" observer. <br /></td></tr>
|
|
<tr class="separator:aa6af1760f9ae97a9d33c05e7ffd1f0ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab09830e0039038cb67673ec7a1539718"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#ab09830e0039038cb67673ec7a1539718">set_game_scene</a> (Ref< PackedScene > scene)</td></tr>
|
|
<tr class="memdesc:ab09830e0039038cb67673ec7a1539718"><td class="mdescLeft"> </td><td class="mdescRight">The scene to load when the start button is pressed. <br /></td></tr>
|
|
<tr class="separator:ab09830e0039038cb67673ec7a1539718"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a128a4c44131bb9999e2573332347829a"><td class="memItemLeft" align="right" valign="top">Ref< PackedScene > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#a128a4c44131bb9999e2573332347829a">get_game_scene</a> () const</td></tr>
|
|
<tr class="memdesc:a128a4c44131bb9999e2573332347829a"><td class="mdescLeft"> </td><td class="mdescRight">The scene to load when the start button is pressed. <br /></td></tr>
|
|
<tr class="separator:a128a4c44131bb9999e2573332347829a"><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:a66e10d67b028791c99c6dedf15513e10"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#a66e10d67b028791c99c6dedf15513e10">GDCLASS</a> (<a class="el" href="classgodot_1_1MenuUI.html">MenuUI</a>, CanvasLayer)</td></tr>
|
|
<tr class="separator:a66e10d67b028791c99c6dedf15513e10"><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:adae0b82c6c44c7eb52b9147aa9766198"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#adae0b82c6c44c7eb52b9147aa9766198">_bind_methods</a> ()</td></tr>
|
|
<tr class="separator:adae0b82c6c44c7eb52b9147aa9766198"><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:aee3349571341e0b4e54d2c28c57c6bea"><td class="memItemLeft" align="right" valign="top">Control * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#aee3349571341e0b4e54d2c28c57c6bea">controls</a> {nullptr}</td></tr>
|
|
<tr class="separator:aee3349571341e0b4e54d2c28c57c6bea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdea9ea25fb138a9cae8a59232379b4e"><td class="memItemLeft" align="right" valign="top">Ref< PackedScene > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1MenuUI.html#abdea9ea25fb138a9cae8a59232379b4e">game_scene</a> {}</td></tr>
|
|
<tr class="separator:abdea9ea25fb138a9cae8a59232379b4e"><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 main menu UI parent. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="adae0b82c6c44c7eb52b9147aa9766198" name="adae0b82c6c44c7eb52b9147aa9766198"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adae0b82c6c44c7eb52b9147aa9766198">◆ </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::MenuUI::_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">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad390dfde7c1cfdf3e116db06411dc82" name="aad390dfde7c1cfdf3e116db06411dc82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad390dfde7c1cfdf3e116db06411dc82">◆ </a></span>_ready()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::MenuUI::_ready </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>Register listeners with UI action observers. Get the controls panel child and hide it. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a66e10d67b028791c99c6dedf15513e10" name="a66e10d67b028791c99c6dedf15513e10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66e10d67b028791c99c6dedf15513e10">◆ </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::MenuUI::GDCLASS </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgodot_1_1MenuUI.html">MenuUI</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="a128a4c44131bb9999e2573332347829a" name="a128a4c44131bb9999e2573332347829a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a128a4c44131bb9999e2573332347829a">◆ </a></span>get_game_scene()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Ref< PackedScene > godot::MenuUI::get_game_scene </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The scene to load when the start button is pressed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab09830e0039038cb67673ec7a1539718" name="ab09830e0039038cb67673ec7a1539718"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab09830e0039038cb67673ec7a1539718">◆ </a></span>set_game_scene()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::MenuUI::set_game_scene </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Ref< PackedScene > </td>
|
|
<td class="paramname"><em>scene</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The scene to load when the start button is pressed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c753ab2eb4fed8d21c8d9f8d0f073cc" name="a4c753ab2eb4fed8d21c8d9f8d0f073cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c753ab2eb4fed8d21c8d9f8d0f073cc">◆ </a></span>start_game()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::MenuUI::start_game </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Load the game scene. Listener for start button "button_down" observer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6af1760f9ae97a9d33c05e7ffd1f0ee" name="aa6af1760f9ae97a9d33c05e7ffd1f0ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6af1760f9ae97a9d33c05e7ffd1f0ee">◆ </a></span>toggle_controls()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void godot::MenuUI::toggle_controls </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Show the controls screen. Listener for controls button "button_down" observer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="aee3349571341e0b4e54d2c28c57c6bea" name="aee3349571341e0b4e54d2c28c57c6bea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee3349571341e0b4e54d2c28c57c6bea">◆ </a></span>controls</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Control* godot::MenuUI::controls {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>
|
|
<a id="abdea9ea25fb138a9cae8a59232379b4e" name="abdea9ea25fb138a9cae8a59232379b4e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abdea9ea25fb138a9cae8a59232379b4e">◆ </a></span>game_scene</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Ref<PackedScene> godot::MenuUI::game_scene {}</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="menu__ui_8hpp_source.html">menu_ui.hpp</a></li>
|
|
<li>src/<a class="el" href="menu__ui_8cpp.html">menu_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>
|