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

252 lines
11 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::ShieldPowerup 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_1ShieldPowerup.html">ShieldPowerup</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected 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="classgodot_1_1ShieldPowerup-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">godot::ShieldPowerup Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Object for the player's "shield" powerup. Collision area that destroys all cars that hit it.
<a href="classgodot_1_1ShieldPowerup.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="shield__powerup_8hpp_source.html">shield_powerup.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for godot::ShieldPowerup:</div>
<div class="dyncontent">
<div class="center">
<img src="classgodot_1_1ShieldPowerup.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:a5e8bb5adc0b33d9fb1690fd86b71b091"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1ShieldPowerup.html#a5e8bb5adc0b33d9fb1690fd86b71b091">_enter_tree</a> () override</td></tr>
<tr class="memdesc:a5e8bb5adc0b33d9fb1690fd86b71b091"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect the body_entered observer. <br /></td></tr>
<tr class="separator:a5e8bb5adc0b33d9fb1690fd86b71b091"><td class="memSeparator" colspan="2">&#160;</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:a1d58b5fbb1a4747b0db37285ffc8b169"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1ShieldPowerup.html#a1d58b5fbb1a4747b0db37285ffc8b169">body_entered</a> (Node3D *body)</td></tr>
<tr class="memdesc:a1d58b5fbb1a4747b0db37285ffc8b169"><td class="mdescLeft">&#160;</td><td class="mdescRight">Listener for this Area3D's body_entered observer. If the entered node is an <a class="el" href="classgodot_1_1EnemyCar.html" title="The enemy car, inherits CarPhysics subclass sandbox and uses a NavigationAgent3D to direct it.">EnemyCar</a>, damage it. <br /></td></tr>
<tr class="separator:a1d58b5fbb1a4747b0db37285ffc8b169"><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:a09b0b88783dbc30e31d0662b499995c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1ShieldPowerup.html#a09b0b88783dbc30e31d0662b499995c5">GDCLASS</a> (<a class="el" href="classgodot_1_1ShieldPowerup.html">ShieldPowerup</a>, Area3D)</td></tr>
<tr class="separator:a09b0b88783dbc30e31d0662b499995c5"><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:a217420af17563262736554df3b9bdbd3"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1ShieldPowerup.html#a217420af17563262736554df3b9bdbd3">_bind_methods</a> ()</td></tr>
<tr class="memdesc:a217420af17563262736554df3b9bdbd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Required to be a valid godot class. <br /></td></tr>
<tr class="separator:a217420af17563262736554df3b9bdbd3"><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>Object for the player's "shield" powerup. Collision area that destroys all cars that hit it. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a217420af17563262736554df3b9bdbd3" name="a217420af17563262736554df3b9bdbd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a217420af17563262736554df3b9bdbd3">&#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::ShieldPowerup::_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="a5e8bb5adc0b33d9fb1690fd86b71b091" name="a5e8bb5adc0b33d9fb1690fd86b71b091"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e8bb5adc0b33d9fb1690fd86b71b091">&#9670;&#160;</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::ShieldPowerup::_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 the body_entered observer. </p>
</div>
</div>
<a id="a1d58b5fbb1a4747b0db37285ffc8b169" name="a1d58b5fbb1a4747b0db37285ffc8b169"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d58b5fbb1a4747b0db37285ffc8b169">&#9670;&#160;</a></span>body_entered()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void godot::ShieldPowerup::body_entered </td>
<td>(</td>
<td class="paramtype">Node3D *&#160;</td>
<td class="paramname"><em>body</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 this Area3D's body_entered observer. If the entered node is an <a class="el" href="classgodot_1_1EnemyCar.html" title="The enemy car, inherits CarPhysics subclass sandbox and uses a NavigationAgent3D to direct it.">EnemyCar</a>, damage it. </p>
</div>
</div>
<a id="a09b0b88783dbc30e31d0662b499995c5" name="a09b0b88783dbc30e31d0662b499995c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09b0b88783dbc30e31d0662b499995c5">&#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::ShieldPowerup::GDCLASS </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgodot_1_1ShieldPowerup.html">ShieldPowerup</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Area3D&#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>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="shield__powerup_8hpp_source.html">shield_powerup.hpp</a></li>
<li>src/<a class="el" href="shield__powerup_8cpp.html">shield_powerup.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>