PSF-LoginServer/net/psforever/objects/ExplosiveDeployableControl$.html

8 lines
60 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.ExplosiveDeployableControl</title><meta content="PSF - LoginServer - master - net.psforever.objects.ExplosiveDeployableControl" name="description"/><meta content="PSF LoginServer master net.psforever.objects.ExplosiveDeployableControl" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
For explosives, targets in the damage radius in the direction of the blast (above the explosive) are valid targets.
Targets that are ~0.5916f units in the opposite direction of the blast (below the explosive) are also selected.</p></div><dl class="paramcmts block"><dt class="param">g1</dt><dd class="cmt"><p>a cached geometric representation that should belong to <code>obj1</code></p></dd><dt class="param">up</dt><dd class="cmt"><p>a cached vector in the direction of "above <code>obj1</code>'s geometric representation"</p></dd><dt class="param">obj1</dt><dd class="cmt"><p>a game entity that explodes</p></dd><dt class="param">obj2</dt><dd class="cmt"><p>a game entity that suffers the explosion</p></dd><dt class="param">maxDistance</dt><dd class="cmt"><p>the square of the maximum distance permissible between game entities
before they are no longer considered "near"</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the target entities are near enough to each other;
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ObjectDefinition.Geometry</code></p></span><span class="cmt"><p><code>PrimitiveGeometry.pointOnOutside</code></p></span><span class="cmt"><p><code>Vector3.DistanceSquared</code></p></span><span class="cmt"><p><code>Vector3.neg</code></p></span><span class="cmt"><p><code>Vector3.relativeUp</code></p></span><span class="cmt"><p><code>Vector3.ScalarProjection</code></p></span><span class="cmt"><p><code>Vector3.Unit</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ExplosiveDeployableControl#detectionForExplosiveSource" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="detectionForExplosiveSource(obj:net.psforever.objects.PlanetSideGameObject):(net.psforever.objects.PlanetSideGameObject,net.psforever.objects.PlanetSideGameObject,Float)=&gt;Boolean"></a><a id="detectionForExplosiveSource(PlanetSideGameObject):(PlanetSideGameObject,PlanetSideGameObject,Float)=&gt;Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl$.html#detectionForExplosiveSource(obj:net.psforever.objects.PlanetSideGameObject):(net.psforever.objects.PlanetSideGameObject,net.psforever.objects.PlanetSideGameObject,Float)=&gt;Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">detectionForExplosiveSource</span><span class="params">(<span name="obj">obj: <a href="PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></span>)</span><span class="result">: (<a href="PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>, <a href="PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>, <span name="scala.Float" class="extype">Float</span>) =&gt; <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Two game entities are considered "near" each other if they are within a certain distance of one another.</p><div class="fullcomment"><div class="comment cmt"><p>Two game entities are considered "near" each other if they are within a certain distance of one another.
For explosives, the source of the explosion is always typically constant.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>a game entity that explodes</p></dd><dt>returns</dt><dd class="cmt"><p>a function that resolves a potential target as detected</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>detectsTarget</code></p></span><span class="cmt"><p><code>ObjectDefinition.Geometry</code></p></span><span class="cmt"><p><code>Vector3.relativeUp</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl$.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl$.html#equals(x$1:Object):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ExplosiveDeployableControl#explodes" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="explodes(target:net.psforever.objects.serverobject.damage.Damageable.Target,cause:net.psforever.objects.vital.interaction.DamageResult):Unit"></a><a id="explodes(Target,DamageResult):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl$.html#explodes(target:net.psforever.objects.serverobject.damage.Damageable.Target,cause:net.psforever.objects.vital.interaction.DamageResult):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">explodes</span><span class="params">(<span name="target">target: <a href="serverobject/damage/Damageable$.html#Target=net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vital.Vitality" name="net.psforever.objects.serverobject.damage.Damageable.Target" id="net.psforever.objects.serverobject.damage.Damageable.Target" class="extmbr">Target</a></span>, <span name="cause">cause: <a href="vital/interaction/DamageResult.html" name="net.psforever.objects.vital.interaction.DamageResult" id="net.psforever.objects.vital.interaction.DamageResult" class="extype">DamageResult</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>na</p></dd><dt class="param">cause</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="ye