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

452 lines
20 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::Beam 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_1Beam.html">Beam</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_1Beam-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">godot::Beam Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Area3D with a MeshInstance3D that resizes itself based on a from and to position and damages any objects that enter it. Requires a child collision shape and mesh instance. Both with Capsule primitive shapes.
<a href="classgodot_1_1Beam.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="beam_8hpp_source.html">beam.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for godot::Beam:</div>
<div class="dyncontent">
<div class="center">
<img src="classgodot_1_1Beam.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:a909a3ba8a1e834ab3fa0cb22951dc5ff"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a909a3ba8a1e834ab3fa0cb22951dc5ff">_enter_tree</a> () override</td></tr>
<tr class="memdesc:a909a3ba8a1e834ab3fa0cb22951dc5ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get child collision shape and mesh instance. Assumes both have a Capsule primitive shape. Creates copies collision and mesh shapes. <br /></td></tr>
<tr class="separator:a909a3ba8a1e834ab3fa0cb22951dc5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94ee12557214e7ba36b91c19a79ddda5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a94ee12557214e7ba36b91c19a79ddda5">_process</a> (double delta_time) override</td></tr>
<tr class="memdesc:a94ee12557214e7ba36b91c19a79ddda5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy self after end time passes. <br /></td></tr>
<tr class="separator:a94ee12557214e7ba36b91c19a79ddda5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab64598eb6de4bb090663ae90cad1f6bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#ab64598eb6de4bb090663ae90cad1f6bb">body_entered</a> (Node3D *node)</td></tr>
<tr class="memdesc:ab64598eb6de4bb090663ae90cad1f6bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deal damage on whatever enters this node. Configure what to damage using collision mask. <br /></td></tr>
<tr class="separator:ab64598eb6de4bb090663ae90cad1f6bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1eae1b4bb3a19a413773d95dd4e04dca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a1eae1b4bb3a19a413773d95dd4e04dca">set_from_to</a> (Vector3 from, Vector3 to)</td></tr>
<tr class="memdesc:a1eae1b4bb3a19a413773d95dd4e04dca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transform self and shapes to stretch from -&gt; to. <br /></td></tr>
<tr class="separator:a1eae1b4bb3a19a413773d95dd4e04dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51123ac9aab395351a00060b7ca432d2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a51123ac9aab395351a00060b7ca432d2">set_end_time</a> (float time_from_now)</td></tr>
<tr class="memdesc:a51123ac9aab395351a00060b7ca432d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass in a duration and set the destroy timer for this object. <br /></td></tr>
<tr class="separator:a51123ac9aab395351a00060b7ca432d2"><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:afcc24c41c61e2bd71a223da9a62b36e0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#afcc24c41c61e2bd71a223da9a62b36e0">GDCLASS</a> (<a class="el" href="classgodot_1_1Beam.html">Beam</a>, Area3D)</td></tr>
<tr class="separator:afcc24c41c61e2bd71a223da9a62b36e0"><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:a495c2b79141f3c9a63625fc3e10acb25"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a495c2b79141f3c9a63625fc3e10acb25">_bind_methods</a> ()</td></tr>
<tr class="memdesc:a495c2b79141f3c9a63625fc3e10acb25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Required to be a valid godot class. <br /></td></tr>
<tr class="separator:a495c2b79141f3c9a63625fc3e10acb25"><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:abbdd7849b1262ed325250efa65415661"><td class="memItemLeft" align="right" valign="top">MeshInstance3D *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#abbdd7849b1262ed325250efa65415661">mesh_instance</a> {nullptr}</td></tr>
<tr class="separator:abbdd7849b1262ed325250efa65415661"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa634d18b108d67ae6cb1e2210b454338"><td class="memItemLeft" align="right" valign="top">Ref&lt; CapsuleMesh &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#aa634d18b108d67ae6cb1e2210b454338">mesh</a> {}</td></tr>
<tr class="separator:aa634d18b108d67ae6cb1e2210b454338"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a998f1b81d6acd7cae1dd53c7708ea36e"><td class="memItemLeft" align="right" valign="top">CollisionShape3D *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a998f1b81d6acd7cae1dd53c7708ea36e">collision_shape</a> {nullptr}</td></tr>
<tr class="separator:a998f1b81d6acd7cae1dd53c7708ea36e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f61848e9cc5676fdd11ea07176495d6"><td class="memItemLeft" align="right" valign="top">Ref&lt; CapsuleShape3D &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a4f61848e9cc5676fdd11ea07176495d6">shape</a> {}</td></tr>
<tr class="separator:a4f61848e9cc5676fdd11ea07176495d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a322890a50d98e6124543028f40c85a29"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgodot_1_1Beam.html#a322890a50d98e6124543028f40c85a29">end_time</a> {0.f}</td></tr>
<tr class="separator:a322890a50d98e6124543028f40c85a29"><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>Area3D with a MeshInstance3D that resizes itself based on a from and to position and damages any objects that enter it. Requires a child collision shape and mesh instance. Both with Capsule primitive shapes. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a495c2b79141f3c9a63625fc3e10acb25" name="a495c2b79141f3c9a63625fc3e10acb25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a495c2b79141f3c9a63625fc3e10acb25">&#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::Beam::_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="a909a3ba8a1e834ab3fa0cb22951dc5ff" name="a909a3ba8a1e834ab3fa0cb22951dc5ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a909a3ba8a1e834ab3fa0cb22951dc5ff">&#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::Beam::_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>Get child collision shape and mesh instance. Assumes both have a Capsule primitive shape. Creates copies collision and mesh shapes. </p>
</div>
</div>
<a id="a94ee12557214e7ba36b91c19a79ddda5" name="a94ee12557214e7ba36b91c19a79ddda5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94ee12557214e7ba36b91c19a79ddda5">&#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::Beam::_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>Destroy self after end time passes. </p>
</div>
</div>
<a id="ab64598eb6de4bb090663ae90cad1f6bb" name="ab64598eb6de4bb090663ae90cad1f6bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab64598eb6de4bb090663ae90cad1f6bb">&#9670;&#160;</a></span>body_entered()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::Beam::body_entered </td>
<td>(</td>
<td class="paramtype">Node3D *&#160;</td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deal damage on whatever enters this node. Configure what to damage using collision mask. </p>
</div>
</div>
<a id="afcc24c41c61e2bd71a223da9a62b36e0" name="afcc24c41c61e2bd71a223da9a62b36e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcc24c41c61e2bd71a223da9a62b36e0">&#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::Beam::GDCLASS </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgodot_1_1Beam.html">Beam</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="a51123ac9aab395351a00060b7ca432d2" name="a51123ac9aab395351a00060b7ca432d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51123ac9aab395351a00060b7ca432d2">&#9670;&#160;</a></span>set_end_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::Beam::set_end_time </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>time_from_now</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pass in a duration and set the destroy timer for this object. </p>
</div>
</div>
<a id="a1eae1b4bb3a19a413773d95dd4e04dca" name="a1eae1b4bb3a19a413773d95dd4e04dca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eae1b4bb3a19a413773d95dd4e04dca">&#9670;&#160;</a></span>set_from_to()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void godot::Beam::set_from_to </td>
<td>(</td>
<td class="paramtype">Vector3&#160;</td>
<td class="paramname"><em>from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Vector3&#160;</td>
<td class="paramname"><em>to</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transform self and shapes to stretch from -&gt; to. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a998f1b81d6acd7cae1dd53c7708ea36e" name="a998f1b81d6acd7cae1dd53c7708ea36e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a998f1b81d6acd7cae1dd53c7708ea36e">&#9670;&#160;</a></span>collision_shape</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CollisionShape3D* godot::Beam::collision_shape {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="a322890a50d98e6124543028f40c85a29" name="a322890a50d98e6124543028f40c85a29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a322890a50d98e6124543028f40c85a29">&#9670;&#160;</a></span>end_time</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float godot::Beam::end_time {0.f}</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="aa634d18b108d67ae6cb1e2210b454338" name="aa634d18b108d67ae6cb1e2210b454338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa634d18b108d67ae6cb1e2210b454338">&#9670;&#160;</a></span>mesh</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Ref&lt;CapsuleMesh&gt; godot::Beam::mesh {}</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="abbdd7849b1262ed325250efa65415661" name="abbdd7849b1262ed325250efa65415661"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbdd7849b1262ed325250efa65415661">&#9670;&#160;</a></span>mesh_instance</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">MeshInstance3D* godot::Beam::mesh_instance {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="a4f61848e9cc5676fdd11ea07176495d6" name="a4f61848e9cc5676fdd11ea07176495d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f61848e9cc5676fdd11ea07176495d6">&#9670;&#160;</a></span>shape</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Ref&lt;CapsuleShape3D&gt; godot::Beam::shape {}</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="beam_8hpp_source.html">beam.hpp</a></li>
<li>src/<a class="el" href="beam_8cpp.html">beam.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