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

131 lines
14 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: src/beam.hpp Source File</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">beam.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="beam_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef BEAM_HPP</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define BEAM_HPP</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;godot_cpp/classes/area3d.hpp&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;godot_cpp/classes/capsule_mesh.hpp&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;godot_cpp/classes/capsule_shape3d.hpp&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;godot_cpp/classes/collision_shape3d.hpp&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;godot_cpp/classes/mesh.hpp&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;godot_cpp/classes/mesh_instance3d.hpp&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;godot_cpp/classes/shape3d.hpp&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegodot.html">godot</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classgodot_1_1Beam.html"> 14</a></span><span class="keyword">class </span><a class="code hl_class" href="classgodot_1_1Beam.html">Beam</a> : <span class="keyword">public</span> Area3D {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classgodot_1_1Beam.html#afcc24c41c61e2bd71a223da9a62b36e0"> 15</a></span> <a class="code hl_function" href="classgodot_1_1Beam.html#afcc24c41c61e2bd71a223da9a62b36e0">GDCLASS</a>(<a class="code hl_class" href="classgodot_1_1Beam.html">Beam</a>, Area3D);</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgodot_1_1Beam.html#a495c2b79141f3c9a63625fc3e10acb25">_bind_methods</a>();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgodot_1_1Beam.html#a909a3ba8a1e834ab3fa0cb22951dc5ff">_enter_tree</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgodot_1_1Beam.html#a94ee12557214e7ba36b91c19a79ddda5">_process</a>(<span class="keywordtype">double</span> delta_time) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgodot_1_1Beam.html#ab64598eb6de4bb090663ae90cad1f6bb">body_entered</a>(Node3D *node);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgodot_1_1Beam.html#a1eae1b4bb3a19a413773d95dd4e04dca">set_from_to</a>(Vector3 from, Vector3 to);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgodot_1_1Beam.html#a51123ac9aab395351a00060b7ca432d2">set_end_time</a>(<span class="keywordtype">float</span> time_from_now);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classgodot_1_1Beam.html#abbdd7849b1262ed325250efa65415661"> 30</a></span> MeshInstance3D *<a class="code hl_variable" href="classgodot_1_1Beam.html#abbdd7849b1262ed325250efa65415661">mesh_instance</a>{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classgodot_1_1Beam.html#aa634d18b108d67ae6cb1e2210b454338"> 31</a></span> Ref&lt;CapsuleMesh&gt; <a class="code hl_variable" href="classgodot_1_1Beam.html#aa634d18b108d67ae6cb1e2210b454338">mesh</a>{};</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classgodot_1_1Beam.html#a998f1b81d6acd7cae1dd53c7708ea36e"> 32</a></span> CollisionShape3D *<a class="code hl_variable" href="classgodot_1_1Beam.html#a998f1b81d6acd7cae1dd53c7708ea36e">collision_shape</a>{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classgodot_1_1Beam.html#a4f61848e9cc5676fdd11ea07176495d6"> 33</a></span> Ref&lt;CapsuleShape3D&gt; <a class="code hl_variable" href="classgodot_1_1Beam.html#a4f61848e9cc5676fdd11ea07176495d6">shape</a>{};</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classgodot_1_1Beam.html#a322890a50d98e6124543028f40c85a29"> 34</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="classgodot_1_1Beam.html#a322890a50d98e6124543028f40c85a29">end_time</a>{0.f};</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>};</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>}</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#endif </span><span class="comment">// !BEAM_HPP</span></div>
<div class="ttc" id="aclassgodot_1_1Beam_html"><div class="ttname"><a href="classgodot_1_1Beam.html">godot::Beam</a></div><div class="ttdoc">Area3D with a MeshInstance3D that resizes itself based on a from and to position and damages any obje...</div><div class="ttdef"><b>Definition</b> beam.hpp:14</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a1eae1b4bb3a19a413773d95dd4e04dca"><div class="ttname"><a href="classgodot_1_1Beam.html#a1eae1b4bb3a19a413773d95dd4e04dca">godot::Beam::set_from_to</a></div><div class="ttdeci">void set_from_to(Vector3 from, Vector3 to)</div><div class="ttdoc">Transform self and shapes to stretch from -&gt; to.</div><div class="ttdef"><b>Definition</b> beam.cpp:34</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a322890a50d98e6124543028f40c85a29"><div class="ttname"><a href="classgodot_1_1Beam.html#a322890a50d98e6124543028f40c85a29">godot::Beam::end_time</a></div><div class="ttdeci">float end_time</div><div class="ttdef"><b>Definition</b> beam.hpp:34</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a495c2b79141f3c9a63625fc3e10acb25"><div class="ttname"><a href="classgodot_1_1Beam.html#a495c2b79141f3c9a63625fc3e10acb25">godot::Beam::_bind_methods</a></div><div class="ttdeci">static void _bind_methods()</div><div class="ttdoc">Required to be a valid godot class.</div><div class="ttdef"><b>Definition</b> beam.cpp:6</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a4f61848e9cc5676fdd11ea07176495d6"><div class="ttname"><a href="classgodot_1_1Beam.html#a4f61848e9cc5676fdd11ea07176495d6">godot::Beam::shape</a></div><div class="ttdeci">Ref&lt; CapsuleShape3D &gt; shape</div><div class="ttdef"><b>Definition</b> beam.hpp:33</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a51123ac9aab395351a00060b7ca432d2"><div class="ttname"><a href="classgodot_1_1Beam.html#a51123ac9aab395351a00060b7ca432d2">godot::Beam::set_end_time</a></div><div class="ttdeci">void set_end_time(float time_from_now)</div><div class="ttdoc">Pass in a duration and set the destroy timer for this object.</div><div class="ttdef"><b>Definition</b> beam.cpp:47</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a909a3ba8a1e834ab3fa0cb22951dc5ff"><div class="ttname"><a href="classgodot_1_1Beam.html#a909a3ba8a1e834ab3fa0cb22951dc5ff">godot::Beam::_enter_tree</a></div><div class="ttdeci">virtual void _enter_tree() override</div><div class="ttdoc">Get child collision shape and mesh instance. Assumes both have a Capsule primitive shape....</div><div class="ttdef"><b>Definition</b> beam.cpp:10</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a94ee12557214e7ba36b91c19a79ddda5"><div class="ttname"><a href="classgodot_1_1Beam.html#a94ee12557214e7ba36b91c19a79ddda5">godot::Beam::_process</a></div><div class="ttdeci">virtual void _process(double delta_time) override</div><div class="ttdoc">Destroy self after end time passes.</div><div class="ttdef"><b>Definition</b> beam.cpp:24</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_a998f1b81d6acd7cae1dd53c7708ea36e"><div class="ttname"><a href="classgodot_1_1Beam.html#a998f1b81d6acd7cae1dd53c7708ea36e">godot::Beam::collision_shape</a></div><div class="ttdeci">CollisionShape3D * collision_shape</div><div class="ttdef"><b>Definition</b> beam.hpp:32</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_aa634d18b108d67ae6cb1e2210b454338"><div class="ttname"><a href="classgodot_1_1Beam.html#aa634d18b108d67ae6cb1e2210b454338">godot::Beam::mesh</a></div><div class="ttdeci">Ref&lt; CapsuleMesh &gt; mesh</div><div class="ttdef"><b>Definition</b> beam.hpp:31</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_ab64598eb6de4bb090663ae90cad1f6bb"><div class="ttname"><a href="classgodot_1_1Beam.html#ab64598eb6de4bb090663ae90cad1f6bb">godot::Beam::body_entered</a></div><div class="ttdeci">void body_entered(Node3D *node)</div><div class="ttdoc">Deal damage on whatever enters this node. Configure what to damage using collision mask.</div><div class="ttdef"><b>Definition</b> beam.cpp:30</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_abbdd7849b1262ed325250efa65415661"><div class="ttname"><a href="classgodot_1_1Beam.html#abbdd7849b1262ed325250efa65415661">godot::Beam::mesh_instance</a></div><div class="ttdeci">MeshInstance3D * mesh_instance</div><div class="ttdef"><b>Definition</b> beam.hpp:30</div></div>
<div class="ttc" id="aclassgodot_1_1Beam_html_afcc24c41c61e2bd71a223da9a62b36e0"><div class="ttname"><a href="classgodot_1_1Beam.html#afcc24c41c61e2bd71a223da9a62b36e0">godot::Beam::GDCLASS</a></div><div class="ttdeci">GDCLASS(Beam, Area3D)</div></div>
<div class="ttc" id="anamespacegodot_html"><div class="ttname"><a href="namespacegodot.html">godot</a></div><div class="ttdef"><b>Definition</b> beacon_powerup.cpp:6</div></div>
</div><!-- fragment --></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>