dirt-racer/docs/html/classgodot_1_1RallyRushGameMode.html
2024-05-27 13:55:10 +02:00

395 lines
19 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::RallyRushGameMode 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_1RallyRushGameMode.html">RallyRushGameMode</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_1RallyRushGameMode-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">godot::RallyRushGameMode Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Game mode for Rally Rush. Mainly serves as a scorekeeper and patchbay for Observers. Inherits from GameMode so it can be referenced by a level and managed by the GameRoot3D.
<a href="classgodot_1_1RallyRushGameMode.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="rally__rush__game__mode_8hpp_source.html">rally_rush_game_mode.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for godot::RallyRushGameMode:</div>
<div class="dyncontent">
<div class="center">
<img src="classgodot_1_1RallyRushGameMode.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:a9e7dceee50644dfcf573e7a84e991837"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#a9e7dceee50644dfcf573e7a84e991837">get_num_found_keys</a> ()</td></tr>
<tr class="memdesc:a9e7dceee50644dfcf573e7a84e991837"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the number of keys picked up so far. <br /></td></tr>
<tr class="separator:a9e7dceee50644dfcf573e7a84e991837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2600dd7d4a715beb874a10db700b51ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#a2600dd7d4a715beb874a10db700b51ae">notify_key_found</a> ()</td></tr>
<tr class="memdesc:a2600dd7d4a715beb874a10db700b51ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit the "key_found" signal. <br /></td></tr>
<tr class="separator:a2600dd7d4a715beb874a10db700b51ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee17d5a7b247ad37436fde5f4f05bded"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#aee17d5a7b247ad37436fde5f4f05bded">notify_player_death</a> ()</td></tr>
<tr class="memdesc:aee17d5a7b247ad37436fde5f4f05bded"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit the "player_death" signal. <br /></td></tr>
<tr class="separator:aee17d5a7b247ad37436fde5f4f05bded"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf7a19191c4edd2c0d46e0f1c251ae68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#acf7a19191c4edd2c0d46e0f1c251ae68">notify_player_escaped</a> ()</td></tr>
<tr class="memdesc:acf7a19191c4edd2c0d46e0f1c251ae68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit the "player_escaped" signal. <br /></td></tr>
<tr class="separator:acf7a19191c4edd2c0d46e0f1c251ae68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6255d285840ebbf45acba11c9b67acfc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#a6255d285840ebbf45acba11c9b67acfc">notify_turret_pickup</a> ()</td></tr>
<tr class="memdesc:a6255d285840ebbf45acba11c9b67acfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit the "turret_pickup" signal. <br /></td></tr>
<tr class="separator:a6255d285840ebbf45acba11c9b67acfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade60aedb2170f955444b2281bb4c14c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#ade60aedb2170f955444b2281bb4c14c4">notify_end_turret_pickup</a> ()</td></tr>
<tr class="memdesc:ade60aedb2170f955444b2281bb4c14c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit the "turret_pickup_end" signal. <br /></td></tr>
<tr class="separator:ade60aedb2170f955444b2281bb4c14c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb8a6cec45311f3592c876d07811876b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#abb8a6cec45311f3592c876d07811876b">notify_shield_pickup</a> ()</td></tr>
<tr class="memdesc:abb8a6cec45311f3592c876d07811876b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit the "shield_pickup" signal. <br /></td></tr>
<tr class="separator:abb8a6cec45311f3592c876d07811876b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad40caf626da1cdce94a17d12375eff62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#ad40caf626da1cdce94a17d12375eff62">notify_end_shield_pickup</a> ()</td></tr>
<tr class="memdesc:ad40caf626da1cdce94a17d12375eff62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit the "shield_pickup_end" signal. <br /></td></tr>
<tr class="separator:ad40caf626da1cdce94a17d12375eff62"><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:ac8640dc6d91b8bdf52a9ef25eeac2ec0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#ac8640dc6d91b8bdf52a9ef25eeac2ec0">GDCLASS</a> (<a class="el" href="classgodot_1_1RallyRushGameMode.html">RallyRushGameMode</a>, GameMode)</td></tr>
<tr class="separator:ac8640dc6d91b8bdf52a9ef25eeac2ec0"><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:a72c2b18d2eb21b7f42093fce4577c5f5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#a72c2b18d2eb21b7f42093fce4577c5f5">_bind_methods</a> ()</td></tr>
<tr class="memdesc:a72c2b18d2eb21b7f42093fce4577c5f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register signals. <br /></td></tr>
<tr class="separator:a72c2b18d2eb21b7f42093fce4577c5f5"><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:aef57c461fed7ec6fae6cdc66b3367bee"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1RallyRushGameMode.html#aef57c461fed7ec6fae6cdc66b3367bee">num_keys_found</a> {0}</td></tr>
<tr class="memdesc:aef57c461fed7ec6fae6cdc66b3367bee"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of keys picked up so far. <br /></td></tr>
<tr class="separator:aef57c461fed7ec6fae6cdc66b3367bee"><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>Game mode for Rally Rush. Mainly serves as a scorekeeper and patchbay for Observers. Inherits from GameMode so it can be referenced by a level and managed by the GameRoot3D. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a72c2b18d2eb21b7f42093fce4577c5f5" name="a72c2b18d2eb21b7f42093fce4577c5f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72c2b18d2eb21b7f42093fce4577c5f5">&#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::RallyRushGameMode::_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>Register signals. </p>
</div>
</div>
<a id="ac8640dc6d91b8bdf52a9ef25eeac2ec0" name="ac8640dc6d91b8bdf52a9ef25eeac2ec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8640dc6d91b8bdf52a9ef25eeac2ec0">&#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::RallyRushGameMode::GDCLASS </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgodot_1_1RallyRushGameMode.html">RallyRushGameMode</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GameMode&#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="a9e7dceee50644dfcf573e7a84e991837" name="a9e7dceee50644dfcf573e7a84e991837"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e7dceee50644dfcf573e7a84e991837">&#9670;&#160;</a></span>get_num_found_keys()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int godot::RallyRushGameMode::get_num_found_keys </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the number of keys picked up so far. </p>
</div>
</div>
<a id="ad40caf626da1cdce94a17d12375eff62" name="ad40caf626da1cdce94a17d12375eff62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad40caf626da1cdce94a17d12375eff62">&#9670;&#160;</a></span>notify_end_shield_pickup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::RallyRushGameMode::notify_end_shield_pickup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Emit the "shield_pickup_end" signal. </p>
</div>
</div>
<a id="ade60aedb2170f955444b2281bb4c14c4" name="ade60aedb2170f955444b2281bb4c14c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade60aedb2170f955444b2281bb4c14c4">&#9670;&#160;</a></span>notify_end_turret_pickup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::RallyRushGameMode::notify_end_turret_pickup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Emit the "turret_pickup_end" signal. </p>
</div>
</div>
<a id="a2600dd7d4a715beb874a10db700b51ae" name="a2600dd7d4a715beb874a10db700b51ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2600dd7d4a715beb874a10db700b51ae">&#9670;&#160;</a></span>notify_key_found()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::RallyRushGameMode::notify_key_found </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Emit the "key_found" signal. </p>
</div>
</div>
<a id="aee17d5a7b247ad37436fde5f4f05bded" name="aee17d5a7b247ad37436fde5f4f05bded"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee17d5a7b247ad37436fde5f4f05bded">&#9670;&#160;</a></span>notify_player_death()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::RallyRushGameMode::notify_player_death </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Emit the "player_death" signal. </p>
</div>
</div>
<a id="acf7a19191c4edd2c0d46e0f1c251ae68" name="acf7a19191c4edd2c0d46e0f1c251ae68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf7a19191c4edd2c0d46e0f1c251ae68">&#9670;&#160;</a></span>notify_player_escaped()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::RallyRushGameMode::notify_player_escaped </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Emit the "player_escaped" signal. </p>
</div>
</div>
<a id="abb8a6cec45311f3592c876d07811876b" name="abb8a6cec45311f3592c876d07811876b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb8a6cec45311f3592c876d07811876b">&#9670;&#160;</a></span>notify_shield_pickup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::RallyRushGameMode::notify_shield_pickup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Emit the "shield_pickup" signal. </p>
</div>
</div>
<a id="a6255d285840ebbf45acba11c9b67acfc" name="a6255d285840ebbf45acba11c9b67acfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6255d285840ebbf45acba11c9b67acfc">&#9670;&#160;</a></span>notify_turret_pickup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::RallyRushGameMode::notify_turret_pickup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Emit the "turret_pickup" signal. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aef57c461fed7ec6fae6cdc66b3367bee" name="aef57c461fed7ec6fae6cdc66b3367bee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef57c461fed7ec6fae6cdc66b3367bee">&#9670;&#160;</a></span>num_keys_found</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int godot::RallyRushGameMode::num_keys_found {0}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of keys picked up so far. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="rally__rush__game__mode_8hpp_source.html">rally_rush_game_mode.hpp</a></li>
<li>src/<a class="el" href="rally__rush__game__mode_8cpp.html">rally_rush_game_mode.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>