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

9 lines
56 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.AmmoBox</title><meta content="PSF - LoginServer - master - net.psforever.objects.AmmoBox" name="description"/><meta content="PSF LoginServer master net.psforever.objects.AmmoBox" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
create multiple <code>AmmoBox</code> objects where none contain more than the maximum capacity for that ammunition type,
and the sum of all objects' capacities is the original object's capacity.</p><div class="fullcomment"><div class="comment cmt"><p>Accepting an <code>AmmoBox</code> object that has an uncertain amount of ammunition in it,
create multiple <code>AmmoBox</code> objects where none contain more than the maximum capacity for that ammunition type,
and the sum of all objects' capacities is the original object's capacity.
The first element in the returned value is always the same object as the input object.
Even if the original ammo object is not split, a list comprised of that same original object is returned.</p></div><dl class="paramcmts block"><dt class="param">box</dt><dd class="cmt"><p>an <code>AmmoBox</code> object of unspecified capacity</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>List</code> of <code>AmmoBox</code> objects with correct capacities</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.AmmoBox#apply" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="apply(ammoDef:net.psforever.objects.definition.AmmoBoxDefinition,capacity:Int):net.psforever.objects.AmmoBox"></a><a id="apply(AmmoBoxDefinition,Int):AmmoBox"></a> <span class="permalink"><a href="../../../net/psforever/objects/AmmoBox$.html#apply(ammoDef:net.psforever.objects.definition.AmmoBoxDefinition,capacity:Int):net.psforever.objects.AmmoBox" 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">apply</span><span class="params">(<span name="ammoDef">ammoDef: <a href="definition/AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a></span>, <span name="capacity">capacity: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <a href="AmmoBox.html" name="net.psforever.objects.AmmoBox" id="net.psforever.objects.AmmoBox" class="extype">AmmoBox</a></span></span></li><li class="indented0 " name="net.psforever.objects.AmmoBox#apply" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="apply(ammoDef:net.psforever.objects.definition.AmmoBoxDefinition):net.psforever.objects.AmmoBox"></a><a id="apply(AmmoBoxDefinition):AmmoBox"></a> <span class="permalink"><a href="../../../net/psforever/objects/AmmoBox$.html#apply(ammoDef:net.psforever.objects.definition.AmmoBoxDefinition):net.psforever.objects.AmmoBox" 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">apply</span><span class="params">(<span name="ammoDef">ammoDef: <a href="definition/AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a></span>)</span><span class="result">: <a href="AmmoBox.html" name="net.psforever.objects.AmmoBox" id="net.psforever.objects.AmmoBox" class="extype">AmmoBox</a></span></span></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/AmmoBox$.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/AmmoBox$.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>At