PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-01-20 02:54:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
PSF-LoginServer/net/psforever/objects/GlobalDefinitions$.html

35 lines
667 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<!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.GlobalDefinitions</title><meta content="PSF - LoginServer - master - net.psforever.objects.GlobalDefinitions" name="description"/><meta content="PSF LoginServer master net.psforever.objects.GlobalDefinitions" 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 */
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
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="
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
The ammunition value here must work with the result of obtaining the anti-vehicular launcher using the faction.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>thr <code>AmmoBoxDefinition</code> for the launcher's ammo</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GlobalDefinitions.AntiVehicular</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#AntiVehicularLauncher" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AntiVehicularLauncher(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition"></a><a id="AntiVehicularLauncher(types.PlanetSideEmpire.Value):ToolDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#AntiVehicularLauncher(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition" 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">AntiVehicularLauncher</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span></span><p class="shortcomment cmt">For a given faction, provide the anti-vehicular launcher.</p><div class="fullcomment"><div class="comment cmt"><p>For a given faction, provide the anti-vehicular launcher.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>the <code>ToolDefinition</code> for the launcher</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#HeavyRifle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HeavyRifle(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition"></a><a id="HeavyRifle(types.PlanetSideEmpire.Value):ToolDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#HeavyRifle(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition" 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">HeavyRifle</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span></span><p class="shortcomment cmt">For a given faction, provide the heavy assault rifle.</p><div class="fullcomment"><div class="comment cmt"><p>For a given faction, provide the heavy assault rifle.
For <code>Neutral</code> or <code>Black Ops</code>, just return a Suppressor.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>the <code>ToolDefinition</code> for the rifle</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#HeavyRifleAPAmmo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HeavyRifleAPAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition"></a><a id="HeavyRifleAPAmmo(types.PlanetSideEmpire.Value):AmmoBoxDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#HeavyRifleAPAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition" 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">HeavyRifleAPAmmo</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a></span></span><p class="shortcomment cmt">For a given faction, provide the AP ammunition for the heavy assault rifle.</p><div class="fullcomment"><div class="comment cmt"><p>For a given faction, provide the AP ammunition for the heavy assault rifle.
The ammunition value here must work with the result of obtaining the rifle using the faction.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>thr <code>AmmoBoxDefinition</code> for the rifle's ammo</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GlobalDefinitions.HeavyRifle</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#HeavyRifleAmmo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HeavyRifleAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition"></a><a id="HeavyRifleAmmo(types.PlanetSideEmpire.Value):AmmoBoxDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#HeavyRifleAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition" 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">HeavyRifleAmmo</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a></span></span><p class="shortcomment cmt">For a given faction, provide the ammunition for the heavy assault rifle.</p><div class="fullcomment"><div class="comment cmt"><p>For a given faction, provide the ammunition for the heavy assault rifle.
Deploying to gh-pages from @ 1a6beba335b41caf128caaae7b2ea9fbad4a71f8 🚀
2020-12-24 13:08:10 +00:00
The ammunition value here must work with the result of obtaining the rifle using the faction.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>thr <code>AmmoBoxDefinition</code> for the rifle's ammo</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GlobalDefinitions.HeavyRifle</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#Infiltration" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Infiltration:net.psforever.objects.definition.ExoSuitDefinition"></a><a id="Infiltration:ExoSuitDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#Infiltration:net.psforever.objects.definition.ExoSuitDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">Infiltration</span><span class="result">: <a href="definition/ExoSuitDefinition.html" name="net.psforever.objects.definition.ExoSuitDefinition" id="net.psforever.objects.definition.ExoSuitDefinition" class="extype">ExoSuitDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#MAXArms" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="MAXArms(subtype:Int,faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition"></a><a id="MAXArms(Int,types.PlanetSideEmpire.Value):ToolDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#MAXArms(subtype:Int,faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition" 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">MAXArms</span><span class="params">(<span name="subtype">subtype: <span name="scala.Int" class="extype">Int</span></span>, <span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#MaxDepth" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="MaxDepth(obj:net.psforever.objects.PlanetSideGameObject):Float"></a><a id="MaxDepth(PlanetSideGameObject):Float"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#MaxDepth(obj:net.psforever.objects.PlanetSideGameObject):Float" 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">MaxDepth</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">: <span name="scala.Float" class="extype">Float</span></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#MediumPistol" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MediumPistol(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition"></a><a id="MediumPistol(types.PlanetSideEmpire.Value):ToolDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/Global
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
The medium assault pistols all use the same ammunition so there is no point for a separate selection function.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>the <code>ToolDefinition</code> for the pistol</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#MediumRifle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MediumRifle(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition"></a><a id="MediumRifle(types.PlanetSideEmpire.Value):ToolDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#MediumRifle(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.ToolDefinition" 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">MediumRifle</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span></span><p class="shortcomment cmt">For a given faction, provide the medium assault rifle.</p><div class="fullcomment"><div class="comment cmt"><p>For a given faction, provide the medium assault rifle.
For <code>Neutral</code> or <code>Black Ops</code>, just return a Suppressor.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>the <code>ToolDefinition</code> for the rifle</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#MediumRifleAPAmmo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MediumRifleAPAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition"></a><a id="MediumRifleAPAmmo(types.PlanetSideEmpire.Value):AmmoBoxDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#MediumRifleAPAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition" 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">MediumRifleAPAmmo</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a></span></span><p class="shortcomment cmt">For a given faction, provide the AP ammunition for the medium assault rifle.</p><div class="fullcomment"><div class="comment cmt"><p>For a given faction, provide the AP ammunition for the medium assault rifle.
The ammunition value here must work with the result of obtaining the rifle using the faction.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>thr <code>AmmoBoxDefinition</code> for the rifle's ammo</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GlobalDefinitions.MediumRifle</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#MediumRifleAmmo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MediumRifleAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition"></a><a id="MediumRifleAmmo(types.PlanetSideEmpire.Value):AmmoBoxDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#MediumRifleAmmo(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.definition.AmmoBoxDefinition" 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">MediumRifleAmmo</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="definition/AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a></span></span><p class="shortcomment cmt">For a given faction, provide the ammunition for the medium assault rifle.</p><div class="fullcomment"><div class="comment cmt"><p>For a given faction, provide the ammunition for the medium assault rifle.
The ammunition value here must work with the result of obtaining the rifle using the faction.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>thr <code>AmmoBoxDefinition</code> for the rifle's ammo</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GlobalDefinitions.MediumRifle</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#NCMAX" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NCMAX:net.psforever.objects.definition.SpecialExoSuitDefinition"></a><a id="NCMAX:SpecialExoSuitDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#NCMAX:net.psforever.objects.definition.SpecialExoSuitDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">NCMAX</span><span class="result">: <a href="definition/SpecialExoSuitDefinition.html" name="net.psforever.objects.definition.SpecialExoSuitDefinition" id="net.psforever.objects.definition.SpecialExoSuitDefinition" class="extype">SpecialExoSuitDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#PortableMannedTurret" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PortableMannedTurret(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.TurretDeployableDefinition"></a><a id="PortableMannedTurret(types.PlanetSideEmpire.Value):TurretDeployableDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#PortableMannedTurret(faction:net.psforever.types.PlanetSideEmpire.Value):net.psforever.objects.TurretDeployableDefinition" 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">PortableMannedTurret</span><span class="params">(<span name="faction">faction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="TurretDeployableDefinition.html" name="net.psforever.objects.TurretDeployableDefinition" id="net.psforever.objects.TurretDeployableDefinition" class="extype">TurretDeployableDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#Reinforced" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Reinforced:net.psforever.objects.definition.ExoSuitDefinition"></a><a id="Reinforced:ExoSuitDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#Reinforced:net.psforever.objects.definition.ExoSuitDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">Reinforced</span><span class="result">: <a href="definition/ExoSuitDefinition.html" name="net.psforever.objects.definition.ExoSuitDefinition" id="net.psforever.objects.definition.ExoSuitDefinition" class="extype">ExoSuitDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#Standard" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Standard:net.psforever.objects.definition.ExoSuitDefinition"></a><a id="Standard:ExoSuitDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#Standard:net.psforever.objects.definition.ExoSuitDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
The ammunition value here must work with the result of obtaining the pistol using the faction.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction</p></dd><dt>returns</dt><dd class="cmt"><p>thr <code>AmmoBoxDefinition</code> for the pistol's ammo</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GlobalDefinitions.StandardPistol</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#TRMAX" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="TRMAX:net.psforever.objects.definition.SpecialExoSuitDefinition"></a><a id="TRMAX:SpecialExoSuitDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#TRMAX:net.psforever.objects.definition.SpecialExoSuitDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">TRMAX</span><span class="result">: <a href="definition/SpecialExoSuitDefinition.html" name="net.psforever.objects.definition.SpecialExoSuitDefinition" id="net.psforever.objects.definition.SpecialExoSuitDefinition" class="extype">SpecialExoSuitDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#VSMAX" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VSMAX:net.psforever.objects.definition.SpecialExoSuitDefinition"></a><a id="VSMAX:SpecialExoSuitDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#VSMAX:net.psforever.objects.definition.SpecialExoSuitDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">VSMAX</span><span class="result">: <a href="definition/SpecialExoSuitDefinition.html" name="net.psforever.objects.definition.SpecialExoSuitDefinition" id="net.psforever.objects.definition.SpecialExoSuitDefinition" class="extype">SpecialExoSuitDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#VT_building_nc" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VT_building_nc:net.psforever.objects.serverobject.structures.BuildingDefinition"></a><a id="VT_building_nc:BuildingDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#VT_building_nc:net.psforever.objects.serverobject.structures.BuildingDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">VT_building_nc</span><span class="result">: <a href="serverobject/structures/BuildingDefinition.html" name="net.psforever.objects.serverobject.structures.BuildingDefinition" id="net.psforever.objects.serverobject.structures.BuildingDefinition" class="extype">BuildingDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#VT_building_tr" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VT_building_tr:net.psforever.objects.serverobject.structures.BuildingDefinition"></a><a id="VT_building_tr:BuildingDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#VT_building_tr:net.psforever.objects.serverobject.structures.BuildingDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">VT_building_tr</span><span class="result">: <a href="serverobject/structures/BuildingDefinition.html" name="net.psforever.objects.serverobject.structures.BuildingDefinition" id="net.psforever.objects.serverobject.structures.BuildingDefinition" c
if such a damage proxy is defined in the appropriate field by its unique object identifier.</p><div class="fullcomment"><div class="comment cmt"><p>Return a projectile that is the damage proxy of another projectile,
if such a damage proxy is defined in the appropriate field by its unique object identifier.</p></div><dl class="paramcmts block"><dt class="param">projectile</dt><dd class="cmt"><p>the original projectile</p></dd><dt>returns</dt><dd class="cmt"><p>the damage proxy projectile definition, if that can be produced</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ProjectileDefinition.DamageProxy</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#gr_door_mb_orb" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="gr_door_mb_orb:net.psforever.objects.serverobject.doors.DoorDefinition"></a><a id="gr_door_mb_orb:DoorDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#gr_door_mb_orb:net.psforever.objects.serverobject.doors.DoorDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">gr_door_mb_orb</span><span class="result">: <a href="serverobject/doors/DoorDefinition.html" name="net.psforever.objects.serverobject.doors.DoorDefinition" id="net.psforever.objects.serverobject.doors.DoorDefinition" class="extype">DoorDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#grenade_launcher_marauder" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="grenade_launcher_marauder:net.psforever.objects.definition.ToolDefinition"></a><a id="grenade_launcher_marauder:ToolDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#grenade_launcher_marauder:net.psforever.objects.definition.ToolDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">grenade_launcher_marauder</span><span class="result">: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#grenade_projectile" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="grenade_projectile:net.psforever.objects.definition.ProjectileDefinition"></a><a id="grenade_projectile:ProjectileDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#grenade_projectile:net.psforever.objects.definition.ProjectileDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">grenade_projectile</span><span class="result">: <a href="definition/ProjectileDefinition.html" name="net.psforever.objects.definition.ProjectileDefinition" id="net.psforever.objects.definition.ProjectileDefinition" class="extype">ProjectileDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#ground_bldg_a" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ground_bldg_a:net.psforever.objects.serverobject.structures.BuildingDefinition"></a><a id="ground_bldg_a:BuildingDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#ground_bldg_a:net.psforever.objects.serverobject.structures.BuildingDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">ground_bldg_a</span><span class="result">: <a href="serverobject/structures/BuildingDefinition.html" name="net.psforever.objects.serverobject.structures.BuildingDefinition" id="net.psforever.objects.serverobject.stru
primarily a flight-variant battleframe vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a <code>Vehicle</code> determine whether it is a frame vehicle,
primarily a flight-variant battleframe vehicle.</p></div><dl class="paramcmts block"><dt class="param">vdef</dt><dd class="cmt"><p>the <code>VehicleDefinition</code> of the vehicle</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameGunnerVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isBattleFrameGunnerVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):Boolean"></a><a id="isBattleFrameGunnerVehicle(VehicleDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameGunnerVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):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">isBattleFrameGunnerVehicle</span><span class="params">(<span name="vdef">vdef: <a href="definition/VehicleDefinition.html" name="net.psforever.objects.definition.VehicleDefinition" id="net.psforever.objects.definition.VehicleDefinition" class="extype">VehicleDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a <code>Vehicle</code> determine whether it is a frame vehicle,
primarily a gunner-variant battleframe vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a <code>Vehicle</code> determine whether it is a frame vehicle,
primarily a gunner-variant battleframe vehicle.</p></div><dl class="paramcmts block"><dt class="param">vdef</dt><dd class="cmt"><p>the <code>VehicleDefinition</code> of the vehicle</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameNTUSiphon" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="isBattleFrameNTUSiphon(edef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isBattleFrameNTUSiphon(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameNTUSiphon(edef:net.psforever.objects.definition.EquipmentDefinition):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">isBattleFrameNTUSiphon</span><span class="params">(<span name="edef">edef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isBattleFrameVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):Boolean"></a><a id="isBattleFrameVehicle(VehicleDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):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">isBattleFrameVehicle</span><span class="params">(<span name="vdef">vdef: <a href="definition/VehicleDefinition.html" name="net.psforever.objects.definition.VehicleDefinition" id="net.psforever.objects.definition.VehicleDefinition" class="extype">VehicleDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a <code>Vehicle</code> determine whether it is a frame vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a <code>Vehicle</code> determine whether it is a frame vehicle.</p></div><dl class="paramcmts block"><dt class="param">vdef</dt><dd class="cmt"><p>the <code>VehicleDefinition</code> of the vehicle</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameWeapon" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isBattleFrameWeapon(tdef:net.psforever.objects.definition.EquipmentDefinition,faction:net.psforever.types.PlanetSideEmpire.Value):Boolean"></a><a id="isBattleFrameWeapon(EquipmentDefinition,types.PlanetSideEmpire.Value):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameWeapon(tdef:net.psforever.objects.definition.EquipmentDefinition,faction:net.psforever.types.PlanetSideEmpire.Value):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">isBattleFrameWeapon</span><span class="params">(<span name="tdef">tdef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>,
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameWeapon" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isBattleFrameWeapon(tdef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isBattleFrameWeapon(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameWeapon(tdef:net.psforever.objects.definition.EquipmentDefinition):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">isBattleFrameWeapon</span><span class="params">(<span name="tdef">tdef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Given the the definition of a piece of equipment,
determine whether it is a weapon to be installed on battle frame robotics units.</p><div class="fullcomment"><div class="comment cmt"><p>Given the the definition of a piece of equipment,
determine whether it is a weapon to be installed on battle frame robotics units.</p></div><dl class="paramcmts block"><dt class="param">tdef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the alleged weapon</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the definition represents a battle frame robotics weapon;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameWeaponForNC" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isBattleFrameWeaponForNC(tdef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isBattleFrameWeaponForNC(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameWeaponForNC(tdef:net.psforever.objects.definition.EquipmentDefinition):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">isBattleFrameWeaponForNC</span><span class="params">(<span name="tdef">tdef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Given the the definition of a battle frame robotics weapon, determine whether it is used by the New Conglomerate.</p><div class="fullcomment"><div class="comment cmt"><p>Given the the definition of a battle frame robotics weapon, determine whether it is used by the New Conglomerate.</p></div><dl class="paramcmts block"><dt class="param">tdef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the alleged weapon</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if a battle frame robotics weapon and associated with the given faction;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameWeaponForTR" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isBattleFrameWeaponForTR(tdef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isBattleFrameWeaponForTR(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameWeaponForTR(tdef:net.psforever.objects.definition.EquipmentDefinition):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">isBattleFrameWeaponForTR</span><span class="params">(<span name="tdef">tdef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Given the the definition of a battle frame robotics weapon, determine whether it is used by the Terran Republic.</p><div class="fullcomment"><div class="comment cmt"><p>Given the the definition of a battle frame robotics weapon, determine whether it is used by the Terran Republic.</p></div><dl class="paramcmts block"><dt class="param">tdef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the alleged weapon</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if a battle frame robotics weapon and associated with the given faction;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isBattleFrameWeaponForVS" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isBattleFrameWeaponForVS(tdef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isBattleFrameWeaponForVS(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isBattleFrameWeaponForVS(tdef:net.psforever.objects.definition.EquipmentDefinition):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">isBattleFrameWeaponForVS</span><span class="params">(<span name="tdef">tdef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Given the the definition of a battle frame robotics weapon, determine whether it is used by the Vanu Sovereignty.</p><div class="fullcomment"><div class="comment cmt"><p>Given the the definition of a battle frame robotics weapon, determine whether it is used by the Vanu Sovereignty.</p></div><dl class="paramcmts block"><dt class="param">tdef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the alleged weapon</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if a battle frame robotics weapon and associated with the given faction;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isCavernEquipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isCavernEquipment(edef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isCavernEquipment(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isCavernEquipment(edef:net.psforever.objects.definition.EquipmentDefinition):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">isCavernEquipment</span><span class="params">(<span name="edef">edef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a piece of <code>Equipment</code> determine whether it is "cavern equipment."</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a piece of <code>Equipment</code> determine whether it is "cavern equipment."</p></div><dl class="paramcmts block"><dt class="param">edef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; otherwise, <code>false</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isCavernVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isCavernVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):Boolean"></a><a id="isCavernVehicle(VehicleDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isCavernVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):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">isCavernVehicle</span><span class="params">(<span name="vdef">vdef: <a href="definition/VehicleDefinition.html" name="net.psforever.objects.definition.VehicleDefinition" id="net.psforever.objects.definition.VehicleDefinition" class="extype">VehicleDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a <code>Vehicle</code> determine whether it is a "cavern Vehicle."</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a <code>Vehicle</code> determine whether it is a "cavern Vehicle."</p></div><dl class="paramcmts block"><dt class="param">vdef</dt><dd class="cmt"><p>the <code>VehicleDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; otherwise, <code>false</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isCavernWeapon" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isCavernWeapon(edef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isCavernWeapon(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isCavernWeapon(edef:net.psforever.objects.definition.EquipmentDefinition):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">isCavernWeapon</span><span class="params">(<span name="edef">edef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.p
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Useful for determining if some item has to be dropped during an activity like <code>Loadout</code> switching.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a piece of <code>Equipment</code> determine whether it is a "cavern weapon."
Useful for determining if some item has to be dropped during an activity like <code>Loadout</code> switching.</p></div><dl class="paramcmts block"><dt class="param">edef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; otherwise, <code>false</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isFactionEquipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isFactionEquipment(edef:net.psforever.objects.definition.EquipmentDefinition):net.psforever.types.PlanetSideEmpire.Value"></a><a id="isFactionEquipment(EquipmentDefinition):types.PlanetSideEmpire.Value"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isFactionEquipment(edef:net.psforever.objects.definition.EquipmentDefinition):net.psforever.types.PlanetSideEmpire.Value" 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">isFactionEquipment</span><span class="params">(<span name="edef">edef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span></span><p class="shortcomment cmt">Using the definition for a piece of <code>Equipment</code> determine with which faction it aligns.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a piece of <code>Equipment</code> determine with which faction it aligns.
Checks both <code>Tool</code> objects and unique <code>AmmoBox</code> objects.</p></div><dl class="paramcmts block"><dt class="param">edef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p>the faction alignment, or <code>Neutral</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isFactionWeapon" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isFactionWeapon(edef:net.psforever.objects.definition.EquipmentDefinition):net.psforever.types.PlanetSideEmpire.Value"></a><a id="isFactionWeapon(EquipmentDefinition):types.PlanetSideEmpire.Value"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isFactionWeapon(edef:net.psforever.objects.definition.EquipmentDefinition):net.psforever.types.PlanetSideEmpire.Value" 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">isFactionWeapon</span><span class="params">(<span name="edef">edef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span></span><p class="shortcomment cmt">Using the definition for a piece of <code>Equipment</code> determine with which faction it aligns if it is a weapon.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a piece of <code>Equipment</code> determine with which faction it aligns if it is a weapon.
Only checks <code>Tool</code> objects.
Useful for determining if some item has to be dropped during an activity like <code>Loadout</code> switching.</p></div><dl class="paramcmts block"><dt class="param">edef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p>the faction alignment, or <code>Neutral</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isFlightVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isFlightVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):Boolean"></a><a id="isFlightVehicle(VehicleDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isFlightVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):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">isFlightVehicle</span><span class="params">(<span name="vdef">vdef: <a href="definition/VehicleDefinition.html" name="net.psforever.objects.definition.VehicleDefinition" id="net.psforever.objects.definition.VehicleDefinition" class="extype">VehicleDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a <code>Vehicle</code> determine whether it can fly.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a <code>Vehicle</code> determine whether it can fly.</p></div><dl class="paramcmts block"><dt class="param">vdef</dt><dd class="cmt"><p>the <code>VehicleDefinition</code> of the vehicle</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isGrenade" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isGrenade(edef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isGrenade(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isGrenade(edef:net.psforever.objects.definition.EquipmentDefinition):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">isGrenade</span><span class="params">(<span name="edef">edef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a piece of <code>Equipment</code> determine if it is a grenade-type weapon.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a piece of <code>Equipment</code> determine if it is a grenade-type weapon.
Only the normal grenades count; the grenade packs are excluded.</p></div><dl class="paramcmts block"><dt class="param">edef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is a grenade-type weapon; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isGrenadePack" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isGrenadePack(edef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isGrenadePack(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isGrenadePack(edef:net.psforever.objects.definition.EquipmentDefinition):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">isGrenadePack</span><span class="params">(<span name="edef">edef: <a href="definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a piece of <code>Equipment</code> determine if it is a grenade-type weapon.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a piece of <code>Equipment</code> determine if it is a grenade-type weapon.
Only the grenade packs count; the normal grenades are excluded.</p></div><dl class="paramcmts block"><dt class="param">edef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is a grenade-type weapon; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isHoverVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isHoverVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):Boolean"></a><a id="isHoverVehicle(VehicleDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isHoverVehicle(vdef:net.psforever.objects.definition.VehicleDefinition):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">isHoverVehicle</span><span class="params">(<span name="vdef">vdef: <a href="definition/VehicleDefinition.html" name="net.psforever.objects.definition.VehicleDefinition" id="net.psforever.objects.definition.VehicleDefinition" class="extype">VehicleDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Using the definition for a <code>Vehicle</code> determine whether it hovers.</p><div class="fullcomment"><div class="comment cmt"><p>Using the definition for a <code>Vehicle</code> determine whether it hovers.</p></div><dl class="paramcmts block"><dt class="param">vdef</dt><dd class="cmt"><p>the <code>VehicleDefinition</code> of the vehicle</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it can; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isInstanceOf[T0]: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">isInstanceOf</span><span class="tparams">[<span name="T0">T0</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>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isMaxArms" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="isMaxArms(tdef:net.psforever.objects.definition.ToolDefinition):Boolean"></a><a id="isMaxArms(ToolDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isMaxArms(tdef:net.psforever.objects.definition.ToolDefinition):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">isMaxArms</span><span class="params">(<span name="tdef">tdef: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isSpecialEquipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isSpecialEquipment(edef:net.psforever.objects.definition.EquipmentDefinition):Boolean"></a><a id="isSpecialEquipment(EquipmentDefinition):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isSpecialEquipment(edef:net.psforever.objects.definition.Equipment
"Special equipment" is any non-standard <code>Equipment</code> that, while it can be obtained from a <code>Terminal</code>, has artificial prerequisites.</p><div class="fullcomment"><div class="comment cmt"><p> Using the definition for a piece of <code>Equipment</code> determine whether it is "special."
"Special equipment" is any non-standard <code>Equipment</code> that, while it can be obtained from a <code>Terminal</code>, has artificial prerequisites.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
For example, the Kits are unlocked as rewards for holiday events and require possessing a specific <code>MeritCommendation</code>.</p></div><dl class="paramcmts block"><dt class="param">edef</dt><dd class="cmt"><p>the <code>EquipmentDefinition</code> of the item</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if it is; otherwise, <code>false</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#isp" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="isp:net.psforever.objects.definition.ToolDefinition"></a><a id="isp:ToolDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#isp:net.psforever.objects.definition.ToolDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">isp</span><span class="result">: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#jammer_cartridge" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="jammer_cartridge:net.psforever.objects.definition.AmmoBoxDefinition"></a><a id="jammer_cartridge:AmmoBoxDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#jammer_cartridge:net.psforever.objects.definition.AmmoBoxDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">jammer_cartridge</span><span class="result">: <a href="definition/AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#jammer_cartridge_projectile" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="jammer_cartridge_projectile:net.psforever.objects.definition.ProjectileDefinition"></a><a id="jammer_cartridge_projectile:ProjectileDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#jammer_cartridge_projectile:net.psforever.objects.definition.ProjectileDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">jammer_cartridge_projectile</span><span class="result">: <a href="definition/ProjectileDefinition.html" name="net.psforever.objects.definition.ProjectileDefinition" id="net.psforever.objects.definition.ProjectileDefinition" class="extype">ProjectileDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.GlobalDefinitions#jammer_cartridge_projectile_b" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="jammer_cartridge_projectile_b:net.psforever.objects.definition.ProjectileDefinition"></a><a id="jammer_cartridge_projectile_b:ProjectileDefinition"></a> <span class="permalink"><a href="../../../net/psforever/objects/GlobalDefinitions$.html#jammer_cartridge_projectile_b:net.psforever.objects.definition.ProjectileDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">jammer_cartridge_projectile_b</span><span class="result">: <a href="definition/ProjectileDefinition.html" name="net.psforever.objects.definition.ProjectileDefinition" id="net.psforever.objects.definition.ProjectileDefinition" class="extype">ProjectileDefinition</a></span></span></li><li class="indented0 " name="net.psforever.obj
Reference in a new issue Copy permalink