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

397 lines
17 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::DamageArea 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_1DamageArea.html">DamageArea</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="#pri-attribs">Private Attributes</a> &#124;
<a href="classgodot_1_1DamageArea-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">godot::DamageArea Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Collision area that damages nodes of the given types when entered.
<a href="classgodot_1_1DamageArea.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="damage__area_8hpp_source.html">damage_area.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for godot::DamageArea:</div>
<div class="dyncontent">
<div class="center">
<img src="classgodot_1_1DamageArea.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:ab464463b35cf0d0e74ebd3da6cfdd433"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#ab464463b35cf0d0e74ebd3da6cfdd433">_enter_tree</a> () override</td></tr>
<tr class="memdesc:ab464463b35cf0d0e74ebd3da6cfdd433"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register body_entered observer. Get animation player if applicable. Get parent if applicable. <br /></td></tr>
<tr class="separator:ab464463b35cf0d0e74ebd3da6cfdd433"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecc5431820237b8bca01b6b9d19302cb"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#aecc5431820237b8bca01b6b9d19302cb">_process</a> (double delta_time) override</td></tr>
<tr class="memdesc:aecc5431820237b8bca01b6b9d19302cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Animate until end, destroy if animation has ended. <br /></td></tr>
<tr class="separator:aecc5431820237b8bca01b6b9d19302cb"><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:a9170a3e3b14d55d9f1c14d9e27e5324f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#a9170a3e3b14d55d9f1c14d9e27e5324f">body_entered</a> (Node3D *node)</td></tr>
<tr class="memdesc:a9170a3e3b14d55d9f1c14d9e27e5324f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the node is of a class referenced in target_classes, deal damage. <br /></td></tr>
<tr class="separator:a9170a3e3b14d55d9f1c14d9e27e5324f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad32f9bf70fdaabce7f3231a9d1c813fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#ad32f9bf70fdaabce7f3231a9d1c813fa">set_target_classes</a> (Array array)</td></tr>
<tr class="memdesc:ad32f9bf70fdaabce7f3231a9d1c813fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node classes to deal damage to. <br /></td></tr>
<tr class="separator:ad32f9bf70fdaabce7f3231a9d1c813fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a513112d77cd3a41f0f759a1339d52332"><td class="memItemLeft" align="right" valign="top">Array&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#a513112d77cd3a41f0f759a1339d52332">get_target_classes</a> () const</td></tr>
<tr class="memdesc:a513112d77cd3a41f0f759a1339d52332"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node classes to deal damage to. <br /></td></tr>
<tr class="separator:a513112d77cd3a41f0f759a1339d52332"><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:ab4acd439641737f461805a4d866e25c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#ab4acd439641737f461805a4d866e25c9">GDCLASS</a> (<a class="el" href="classgodot_1_1DamageArea.html">DamageArea</a>, Area3D)</td></tr>
<tr class="separator:ab4acd439641737f461805a4d866e25c9"><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:abea71e7a3cd83aee065e21f0feeab2a4"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#abea71e7a3cd83aee065e21f0feeab2a4">_bind_methods</a> ()</td></tr>
<tr class="memdesc:abea71e7a3cd83aee065e21f0feeab2a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind editor properties. <br /></td></tr>
<tr class="separator:abea71e7a3cd83aee065e21f0feeab2a4"><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:a56aecc952ac874926fee14948a315257"><td class="memItemLeft" align="right" valign="top">Vector&lt; StringName &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#a56aecc952ac874926fee14948a315257">target_classes</a> {}</td></tr>
<tr class="separator:a56aecc952ac874926fee14948a315257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88a50f20215e222c6dcfdc5c92d2c080"><td class="memItemLeft" align="right" valign="top">AnimationPlayer *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1DamageArea.html#a88a50f20215e222c6dcfdc5c92d2c080">anim</a> {nullptr}</td></tr>
<tr class="separator:a88a50f20215e222c6dcfdc5c92d2c080"><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>Collision area that damages nodes of the given types when entered. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abea71e7a3cd83aee065e21f0feeab2a4" name="abea71e7a3cd83aee065e21f0feeab2a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abea71e7a3cd83aee065e21f0feeab2a4">&#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::DamageArea::_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="ab464463b35cf0d0e74ebd3da6cfdd433" name="ab464463b35cf0d0e74ebd3da6cfdd433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab464463b35cf0d0e74ebd3da6cfdd433">&#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::DamageArea::_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>Register body_entered observer. Get animation player if applicable. Get parent if applicable. </p>
</div>
</div>
<a id="aecc5431820237b8bca01b6b9d19302cb" name="aecc5431820237b8bca01b6b9d19302cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecc5431820237b8bca01b6b9d19302cb">&#9670;&#160;</a></span>_process()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void godot::DamageArea::_process </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>delta_time</em></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>Animate until end, destroy if animation has ended. </p>
</div>
</div>
<a id="a9170a3e3b14d55d9f1c14d9e27e5324f" name="a9170a3e3b14d55d9f1c14d9e27e5324f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9170a3e3b14d55d9f1c14d9e27e5324f">&#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::DamageArea::body_entered </td>
<td>(</td>
<td class="paramtype">Node3D *&#160;</td>
<td class="paramname"><em>node</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>If the node is of a class referenced in target_classes, deal damage. </p>
</div>
</div>
<a id="ab4acd439641737f461805a4d866e25c9" name="ab4acd439641737f461805a4d866e25c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4acd439641737f461805a4d866e25c9">&#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::DamageArea::GDCLASS </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgodot_1_1DamageArea.html">DamageArea</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>
<a id="a513112d77cd3a41f0f759a1339d52332" name="a513112d77cd3a41f0f759a1339d52332"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a513112d77cd3a41f0f759a1339d52332">&#9670;&#160;</a></span>get_target_classes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Array godot::DamageArea::get_target_classes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Node classes to deal damage to. </p>
</div>
</div>
<a id="ad32f9bf70fdaabce7f3231a9d1c813fa" name="ad32f9bf70fdaabce7f3231a9d1c813fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad32f9bf70fdaabce7f3231a9d1c813fa">&#9670;&#160;</a></span>set_target_classes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void godot::DamageArea::set_target_classes </td>
<td>(</td>
<td class="paramtype">Array&#160;</td>
<td class="paramname"><em>array</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>Node classes to deal damage to. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a88a50f20215e222c6dcfdc5c92d2c080" name="a88a50f20215e222c6dcfdc5c92d2c080"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88a50f20215e222c6dcfdc5c92d2c080">&#9670;&#160;</a></span>anim</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AnimationPlayer* godot::DamageArea::anim {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="a56aecc952ac874926fee14948a315257" name="a56aecc952ac874926fee14948a315257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56aecc952ac874926fee14948a315257">&#9670;&#160;</a></span>target_classes</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Vector&lt;StringName&gt; godot::DamageArea::target_classes {}</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="damage__area_8hpp_source.html">damage_area.hpp</a></li>
<li>src/<a class="el" href="damage__area_8cpp.html">damage_area.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