PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-09 15:30:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/Tool$$FireModeSlot.html

16 lines
38 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.Tool.FireModeSlot</title><meta content="PSF - LoginServer - master - net.psforever.objects.Tool.FireModeSlot" name="description"/><meta content="PSF LoginServer master net.psforever.objects.Tool.FireModeSlot" 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.Tool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Tool"></a><a id="Tool:Tool"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="Tool$.html" title=""><span class="name">Tool</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Def
Most weapons will have only one ammunition slot and swap different ammunition into it as needed.
In general to swap ammunition means to unload the onld ammunition and load the new ammunition.
Many weapons also have one ammunition slot and multiple fire modes using the same list of ammunition
This slot manages either of two ammunitions where one does not need to unload to be swapped to the other;
however, the fire mod has most likely been changed.
The Punisher -
six ammunition types in total,
two uniquely different types without unloading,
two exclusive groups of ammunition divided into 2 cycled types and 4 cycled types -
is an example of a weapon that benefits from this implementation.
</p></div><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/objects/Tool.scala" target="_blank">Tool.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.objects.Tool.FireModeSlot"><span>FireModeSlot</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.objects.Tool.FireModeSlot#&lt;init&gt;" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(tdef:net.psforever.objects.definition.ToolDefinition,fdef:net.psforever.objects.equipment.FireModeDefinition):net.psforever.objects.Tool.FireModeSlot"></a><a id="&lt;init&gt;:FireModeSlot"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$$FireModeSlot.html#&lt;init&gt;(tdef:net.psforever.objects.definition.ToolDefinition,fdef:net.psforever.objects.equipment.FireModeDefinition):net.psforever.objects.Tool.FireModeSlot" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">FireModeSlot</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 name="fdef">fdef: <a href="equipment/FireModeDefinition.html" name="net.psforever.objects.equipment.FireModeDefinition" id="net.psforever.objects.equipment.FireModeDefinition" class="extype">FireModeDefinition</a></span>)</span></span></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/Tool$$FireModeSlot.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">
It may not be the correct <code>Ammo.Value</code> whose <code>AmmoBoxDefinition</code> is loaded into <code>box</code> such as is the case during ammunition swaps.
Generally, convert from this index, to the index in the fire mode's ammunition list, to the index in the <code>ToolDefinition</code>'s ammunition list.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the <code>Ammo</code> type that should be loaded into the magazine right now</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Tool.FireModeSlot#AmmoTypeIndex" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AmmoTypeIndex:Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$$FireModeSlot.html#AmmoTypeIndex: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">AmmoTypeIndex</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.objects.Tool.FireModeSlot#AmmoTypeIndex_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AmmoTypeIndex_=(index:Int):Int"></a><a id="AmmoTypeIndex_=(Int):Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$$FireModeSlot.html#AmmoTypeIndex_=(index:Int):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" title="gt4s: AmmoTypeIndex_$eq">AmmoTypeIndex_=</span><span class="params">(<span name="index">index: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.objects.Tool.FireModeSlot#Box" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Box:net.psforever.objects.AmmoBox"></a><a id="Box:AmmoBox"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$$FireModeSlot.html#Box: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">Box</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.Tool.FireModeSlot#Box_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Box_=(toBox:net.psforever.objects.AmmoBox):Option[net.psforever.objects.AmmoBox]"></a><a id="Box_=(AmmoBox):Option[AmmoBox]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$$FireModeSlot.html#Box_=(toBox:net.psforever.objects.AmmoBox):Option[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" title="gt4s: Box_$eq">Box_=</span><span class="params">(<span name="toBox">toBox: <a href="AmmoBox.html" name="net.psforever.objects.AmmoBox" id="net.psforever.objects.AmmoBox" class="extype">AmmoBox</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<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.Tool.FireModeSlot#Chamber" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Chamber:Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$$FireModeSlot.html#Chamber: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">Chamber</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><l
Reference in a new issue Copy permalink