Sara/dirt-racer
1
0
Fork 0
Code Issues 21 Pull requests Actions Packages Projects Releases Wiki Activity
dirt-racer/docs/html/classgodot_1_1EndScreen.html
Sara c333fddeba final
2024-05-27 13:55:10 +02:00

404 lines
19 KiB
HTML
Raw Permalink Blame History

<!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::EndScreen 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&amp;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&amp;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_1EndScreen.html">EndScreen</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgodot_1_1EndScreen-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">godot::EndScreen Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The game-over screen, used both when the player has won and lost the game.
<a href="classgodot_1_1EndScreen.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="end__screen_8hpp_source.html">end_screen.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for godot::EndScreen:</div>
<div class="dyncontent">
<div class="center">
<img src="classgodot_1_1EndScreen.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:a985c977cc3bc4cd2014e39e44e2eceba"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#a985c977cc3bc4cd2014e39e44e2eceba">_ready</a> () override</td></tr>
<tr class="memdesc:a985c977cc3bc4cd2014e39e44e2eceba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetch buttons from children and register observers. <br /></td></tr>
<tr class="separator:a985c977cc3bc4cd2014e39e44e2eceba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17ea11ee84a2e402cf8e6cdfc35ce759"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#a17ea11ee84a2e402cf8e6cdfc35ce759">return_to_main</a> ()</td></tr>
<tr class="memdesc:a17ea11ee84a2e402cf8e6cdfc35ce759"><td class="mdescLeft">&#160;</td><td class="mdescRight">Listener for return to menu button "button_down" observer. Load the main menu scene. <br /></td></tr>
<tr class="separator:a17ea11ee84a2e402cf8e6cdfc35ce759"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2f281d666b7e5a960ea1d1a72364bdf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#af2f281d666b7e5a960ea1d1a72364bdf">restart</a> ()</td></tr>
<tr class="memdesc:af2f281d666b7e5a960ea1d1a72364bdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Listener for restart button "button_down" observer. Load the game scene. <br /></td></tr>
<tr class="separator:af2f281d666b7e5a960ea1d1a72364bdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a469b1e48ae5c002bb6b6fcb48678abb6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#a469b1e48ae5c002bb6b6fcb48678abb6">set_main_menu_scene</a> (Ref&lt; PackedScene &gt; scene)</td></tr>
<tr class="memdesc:a469b1e48ae5c002bb6b6fcb48678abb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scene to load when return to main menu is pressed. <br /></td></tr>
<tr class="separator:a469b1e48ae5c002bb6b6fcb48678abb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a5140ca241b708a223bcacb0cd7e19c"><td class="memItemLeft" align="right" valign="top">Ref&lt; PackedScene &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#a7a5140ca241b708a223bcacb0cd7e19c">get_main_menu_scene</a> () const</td></tr>
<tr class="memdesc:a7a5140ca241b708a223bcacb0cd7e19c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scene to load when return to main menu is pressed. <br /></td></tr>
<tr class="separator:a7a5140ca241b708a223bcacb0cd7e19c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff77ddd7ffc7e1e8b4c7f81e468fdcf6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#aff77ddd7ffc7e1e8b4c7f81e468fdcf6">set_game_scene</a> (Ref&lt; PackedScene &gt; scene)</td></tr>
<tr class="memdesc:aff77ddd7ffc7e1e8b4c7f81e468fdcf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scene to load when the restart game button is pressed. <br /></td></tr>
<tr class="separator:aff77ddd7ffc7e1e8b4c7f81e468fdcf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af86557835f7c053bd020556150b53ae5"><td class="memItemLeft" align="right" valign="top">Ref&lt; PackedScene &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#af86557835f7c053bd020556150b53ae5">get_game_scene</a> () const</td></tr>
<tr class="memdesc:af86557835f7c053bd020556150b53ae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scene to load when the restart game button is pressed. <br /></td></tr>
<tr class="separator:af86557835f7c053bd020556150b53ae5"><td class="memSeparator" colspan="2">&#160;</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:ab3808da1ef0377b4f9f78ebb9368e06b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#ab3808da1ef0377b4f9f78ebb9368e06b">GDCLASS</a> (<a class="el" href="classgodot_1_1EndScreen.html">EndScreen</a>, CanvasLayer)</td></tr>
<tr class="separator:ab3808da1ef0377b4f9f78ebb9368e06b"><td class="memSeparator" colspan="2">&#160;</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:a6dede41dad7a457de442e9c79b30b9f4"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#a6dede41dad7a457de442e9c79b30b9f4">_bind_methods</a> ()</td></tr>
<tr class="memdesc:a6dede41dad7a457de442e9c79b30b9f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind editor properties. <br /></td></tr>
<tr class="separator:a6dede41dad7a457de442e9c79b30b9f4"><td class="memSeparator" colspan="2">&#160;</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:a8bf01937f57d670564f8dd7620483fc5"><td class="memItemLeft" align="right" valign="top">Ref&lt; PackedScene &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#a8bf01937f57d670564f8dd7620483fc5">game_scene</a> {}</td></tr>
<tr class="separator:a8bf01937f57d670564f8dd7620483fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b6c4a486addf06935ecfed6e408c13"><td class="memItemLeft" align="right" valign="top">Ref&lt; PackedScene &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1EndScreen.html#a25b6c4a486addf06935ecfed6e408c13">main_menu_scene</a> {}</td></tr>
<tr class="separator:a25b6c4a486addf06935ecfed6e408c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The game-over screen, used both when the player has won and lost the game. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6dede41dad7a457de442e9c79b30b9f4" name="a6dede41dad7a457de442e9c79b30b9f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dede41dad7a457de442e9c79b30b9f4">&#9670;&#160;</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::EndScreen::_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>Bind editor properties. </p>
</div>
</div>
<a id="a985c977cc3bc4cd2014e39e44e2eceba" name="a985c977cc3bc4cd2014e39e44e2eceba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a985c977cc3bc4cd2014e39e44e2eceba">&#9670;&#160;</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::EndScreen::_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>Fetch buttons from children and register observers. </p>
</div>
</div>
<a id="ab3808da1ef0377b4f9f78ebb9368e06b" name="ab3808da1ef0377b4f9f78ebb9368e06b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3808da1ef0377b4f9f78ebb9368e06b">&#9670;&#160;</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::EndScreen::GDCLASS </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgodot_1_1EndScreen.html">EndScreen</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CanvasLayer&#160;</td>
<td class="paramname">&#160;</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="af86557835f7c053bd020556150b53ae5" name="af86557835f7c053bd020556150b53ae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af86557835f7c053bd020556150b53ae5">&#9670;&#160;</a></span>get_game_scene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ref&lt; PackedScene &gt; godot::EndScreen::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 restart game button is pressed. </p>
</div>
</div>
<a id="a7a5140ca241b708a223bcacb0cd7e19c" name="a7a5140ca241b708a223bcacb0cd7e19c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a5140ca241b708a223bcacb0cd7e19c">&#9670;&#160;</a></span>get_main_menu_scene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ref&lt; PackedScene &gt; godot::EndScreen::get_main_menu_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 return to main menu is pressed. </p>
</div>
</div>
<a id="af2f281d666b7e5a960ea1d1a72364bdf" name="af2f281d666b7e5a960ea1d1a72364bdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2f281d666b7e5a960ea1d1a72364bdf">&#9670;&#160;</a></span>restart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::EndScreen::restart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Listener for restart button "button_down" observer. Load the game scene. </p>
</div>
</div>
<a id="a17ea11ee84a2e402cf8e6cdfc35ce759" name="a17ea11ee84a2e402cf8e6cdfc35ce759"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17ea11ee84a2e402cf8e6cdfc35ce759">&#9670;&#160;</a></span>return_to_main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::EndScreen::return_to_main </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Listener for return to menu button "button_down" observer. Load the main menu scene. </p>
</div>
</div>
<a id="aff77ddd7ffc7e1e8b4c7f81e468fdcf6" name="aff77ddd7ffc7e1e8b4c7f81e468fdcf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff77ddd7ffc7e1e8b4c7f81e468fdcf6">&#9670;&#160;</a></span>set_game_scene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::EndScreen::set_game_scene </td>
<td>(</td>
<td class="paramtype">Ref&lt; PackedScene &gt;&#160;</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 restart game button is pressed. </p>
</div>
</div>
<a id="a469b1e48ae5c002bb6b6fcb48678abb6" name="a469b1e48ae5c002bb6b6fcb48678abb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a469b1e48ae5c002bb6b6fcb48678abb6">&#9670;&#160;</a></span>set_main_menu_scene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::EndScreen::set_main_menu_scene </td>
<td>(</td>
<td class="paramtype">Ref&lt; PackedScene &gt;&#160;</td>
<td class="paramname"><em>scene</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The scene to load when return to main menu is pressed. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8bf01937f57d670564f8dd7620483fc5" name="a8bf01937f57d670564f8dd7620483fc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bf01937f57d670564f8dd7620483fc5">&#9670;&#160;</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&lt;PackedScene&gt; godot::EndScreen::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>
<a id="a25b6c4a486addf06935ecfed6e408c13" name="a25b6c4a486addf06935ecfed6e408c13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25b6c4a486addf06935ecfed6e408c13">&#9670;&#160;</a></span>main_menu_scene</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Ref&lt;PackedScene&gt; godot::EndScreen::main_menu_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="end__screen_8hpp_source.html">end_screen.hpp</a></li>
<li>src/<a class="el" href="end__screen_8cpp.html">end_screen.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in a new issue View git blame Copy permalink