PSF-LoginServer/net/psforever/objects/equipment/FireModeSwitch.html

20 lines
38 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.equipment.FireModeSwitch</title><meta content="PSF - LoginServer - master - net.psforever.objects.equipment.FireModeSwitch" name="description"/><meta content="PSF LoginServer master net.psforever.objects.equipment.FireModeSwitch" 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.equipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equipment"></a><a id="equipment:equipment"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/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">equipment<
<br>
All weapons and some support items have fire modes, though most only have one.
The number of fire modes is visually indicated by the bubbles next to the icon of the <code>Equipment</code> in a holster slot.
The specifics of how a fire mode affects the output is left to implementation and execution.
Contrast how <code>Tool</code>s deal with multiple types of ammunition.<br>
<br>
While most <code>Tools</code> - weapons and such - are known to have fire modes,
<code>ConstructionItem</code> equipment that produce deployable entities in the game world also support fire modes.
The mechanism is different, however, even while the user interactions work in a similar way.
For most weapons, the fire mode is just a modification of how the projectiles behave or the weapon behaves.
For example, the bounciness of the grenades or the number of shots fired by the Jackhammer.
One has to change tool ammo types to actual swap out different ammunitions such as, most commonly,
grey normal ammo for gold armor-piercing ammo.
For deployable-constructing entities, fire mode switches between the categories of deployables that can be built
and "changing ammunition" actually changes the subtype of deployable within that deployable category.
For example, fire modes go from "Boomers" to "Mines"
while ammo types for "Mines" goes from "HE mines" to "Disruptor Mines".</p></div><dl class="paramcmts block"><dt class="tparam">Mode</dt><dd class="cmt"><p>the type parameter representing the fire mode</p></dd></dl><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/equipment/FireModeSwitch.scala" target="_blank">FireModeSwitch.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 class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="../ConstructionItem.html" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a>, <a href="../Telepad.html" name="net.psforever.objects.Telepad" id="net.psforever.objects.Telepad" class="extype">Telepad</a>, <a href="../Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a>, <a href="../serverobject/turret/TurretWeapon.html" name="net.psforever.objects.serverobject.turret.TurretWeapon" id="net.psforever.objects.serverobject.turret.TurretWeapon" class="extype">TurretWeapon</a></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.equipment.FireModeSwitch"><span>FireModeSwitch</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 class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.equipment.FireModeSwitch#FireMode" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="FireMode:Mode"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/FireModeSwitch.html#FireMode:Mode" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">FireMode</span><span class="result">: <span name="net.psforever.objects.equipment.FireModeSwitch.Mode" class="extype">Mode</span></span></span></li><li class="indented0 " name="net.psforever.objects.equipment.FireModeSwitch#FireModeIndex" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="FireModeIndex:Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/FireModeSwitch.html#FireModeIndex:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">FireModeIndex</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.objects.equipment.FireModeSwitch#FireModeIndex_=" group="Ungr