PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-25 15:19:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/loadouts/Loadout$.html

10 lines
55 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.loadouts.Loadout</title><meta content="PSF - LoginServer - master - net.psforever.objects.loadouts.Loadout" name="description"/><meta content="PSF LoginServer master net.psforever.objects.loadouts.Loadout" 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.loadouts" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="loadouts"></a><a id="loadouts:loadouts"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/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">loadouts</span>
if <code>None</code>, then the previous <code>AmmoBoxDefinition</code> will be referenced for the amount later</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout.ShorthandAmmoSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ShorthandAmmoSlotextendsProductwithSerializable"></a><a id="ShorthandAmmoSlot:ShorthandAmmoSlot"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$$ShorthandAmmoSlot.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Loadout$$ShorthandAmmoSlot.html" title="The simplified form of a Tool FireMode"><span class="name">ShorthandAmmoSlot</span></a><span class="params">(<span name="ammoIndex">ammoIndex: <span name="scala.Int" class="extype">Int</span></span>, <span name="ammo">ammo: <a href="Loadout$$ShorthandAmmoBox.html" name="net.psforever.objects.loadouts.Loadout.ShorthandAmmoBox" id="net.psforever.objects.loadouts.Loadout.ShorthandAmmoBox" class="extype">ShorthandAmmoBox</a></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">The simplified form of a <code>Tool</code> <code>FireMode</code></p><div class="fullcomment"><div class="comment cmt"><p>The simplified form of a <code>Tool</code> <code>FireMode</code></p></div><dl class="paramcmts block"><dt class="param">ammoIndex</dt><dd class="cmt"><p>the index that points to the type of ammunition this slot currently uses</p></dd><dt class="param">ammo</dt><dd class="cmt"><p>a <code>ShorthandAmmoBox</code> object to load into that slot</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout.ShorthandConstructionItem" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ShorthandConstructionItemextendsLoadout.SimplificationwithProductwithSerializable"></a><a id="ShorthandConstructionItem:ShorthandConstructionItem"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$$ShorthandConstructionItem.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Loadout$$ShorthandConstructionItem.html" title="The simplified form of a ConstructionItem."><span class="name">ShorthandConstructionItem</span></a><span class="params">(<span name="definition">definition: <a href="../definition/ConstructionItemDefinition.html" name="net.psforever.objects.definition.ConstructionItemDefinition" id="net.psforever.objects.definition.ConstructionItemDefinition" class="extype">ConstructionItemDefinition</a></span>)</span><span class="result"> extends <a href="Loadout$$Simplification.html" name="net.psforever.objects.loadouts.Loadout.Simplification" id="net.psforever.objects.loadouts.Loadout.Simplification" class="extype">Simplification</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">The simplified form of a <code>ConstructionItem</code>.</p><div class="fullcomment"><div class="comment cmt"><p>The simplified form of a <code>ConstructionItem</code>.</p></div><dl class="paramcmts block"><dt class="param">definition</dt><dd class="cmt"><p>the <code>ConstructionItemDefinition</code> that describes this future object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout.ShorthandKit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ShorthandKitextendsLoadout.SimplificationwithProductwithSerializable"></a><a id="ShorthandKit:ShorthandKit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$$
actually ignored, but retained for function definition consistency</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout.Simplification" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SimplificationextendsAnyRef"></a><a id="Simplification:Simplification"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$$Simplification.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="Loadout$$Simplification.html" title="A basic Trait connecting all of the Equipment blueprints."><span class="name">Simplification</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">A basic <code>Trait</code> connecting all of the <code>Equipment</code> blueprints.</p></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout.SimplifiedEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SimplifiedEntryextendsProductwithSerializable"></a><a id="SimplifiedEntry:SimplifiedEntry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$$SimplifiedEntry.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Loadout$$SimplifiedEntry.html" title="An entry in the Loadout, wrapping around a slot index and what is in the slot index."><span class="name">SimplifiedEntry</span></a><span class="params">(<span name="item">item: <a href="Loadout$$Simplification.html" name="net.psforever.objects.loadouts.Loadout.Simplification" id="net.psforever.objects.loadouts.Loadout.Simplification" class="extype">Simplification</a></span>, <span name="index">index: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">An entry in the <code>Loadout</code>, wrapping around a slot index and what is in the slot index.</p><div class="fullcomment"><div class="comment cmt"><p>An entry in the <code>Loadout</code>, wrapping around a slot index and what is in the slot index.</p></div><dl class="paramcmts block"><dt class="param">item</dt><dd class="cmt"><p>the <code>Equipment</code></p></dd><dt class="param">index</dt><dd class="cmt"><p>the slot number where the <code>Equipment</code> is to be stowed</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>InventoryItem</code></p></span></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#!=(x$1:Any):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" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html###:Int" title="Permalink"><i class="material-icons"></i></a></sp
</p></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout#Create" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Create(vehicle:net.psforever.objects.Vehicle,label:String):net.psforever.objects.loadouts.Loadout"></a><a id="Create(Vehicle,String):Loadout"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#Create(vehicle:net.psforever.objects.Vehicle,label:String):net.psforever.objects.loadouts.Loadout" 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">Create</span><span class="params">(<span name="vehicle">vehicle: <a href="../Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="label">label: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="Loadout.html" name="net.psforever.objects.loadouts.Loadout" id="net.psforever.objects.loadouts.Loadout" class="extype">Loadout</a></span></span><p class="shortcomment cmt">Produce the blueprint of a vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Produce the blueprint of a vehicle.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle</p></dd><dt class="param">label</dt><dd class="cmt"><p>the name of this loadout</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>VehicleLoadout</code> object populated with appropriate information about the current state of the vehicle</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout#Create" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Create(player:net.psforever.objects.Player,label:String):net.psforever.objects.loadouts.Loadout"></a><a id="Create(Player,String):Loadout"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#Create(player:net.psforever.objects.Player,label:String):net.psforever.objects.loadouts.Loadout" 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">Create</span><span class="params">(<span name="player">player: <a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="label">label: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="Loadout.html" name="net.psforever.objects.loadouts.Loadout" id="net.psforever.objects.loadouts.Loadout" class="extype">Loadout</a></span></span><p class="shortcomment cmt">Produce the blueprint on a player.</p><div class="fullcomment"><div class="comment cmt"><p>Produce the blueprint on a player.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player</p></dd><dt class="param">label</dt><dd class="cmt"><p>the name of this loadout</p></dd><dt>returns</dt><dd class="cmt"><p>an <code>InfantryLoadout</code> object populated with appropriate information about the current state of the player</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout#Create" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Create(owner:Any,label:String):scala.util.Try[net.psforever.objects.loadouts.Loadout]"></a><a id="Create(Any,String):Try[Loadout]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#Create(owner:Any,label:String):scala.util.Try[net.psforever.objects.loadouts.Loadout]" 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">Create</span><span class="params">(<span name="owner">owner: <span name="scala.Any" c
Vehicle's have no subtype.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle</p></dd><dt>returns</dt><dd class="cmt"><p>the numeric subtype, always 0</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout#DetermineSubtype" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DetermineSubtype(player:net.psforever.objects.Player):Int"></a><a id="DetermineSubtype(Player):Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#DetermineSubtype(player:net.psforever.objects.Player):Int" 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">DetermineSubtype</span><span class="params">(<span name="player">player: <a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">The sub-type of the player's uniform.</p><div class="fullcomment"><div class="comment cmt"><p>The sub-type of the player's uniform.
Applicable to mechanized assault units, mainly.
The subtype is reported as a number but indicates the specialization - anti-infantry, ani-vehicular, anti-air - of the suit
as indicated by the arm weapon(s).</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player</p></dd><dt>returns</dt><dd class="cmt"><p>the numeric subtype</p></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#asInstanceOf[T0]:T0" 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">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#clone():Object" 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">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</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/loadouts/Loadout$.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/loadouts/Loadout$.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="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.html#finalize():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">d
Reference in a new issue Copy permalink