PSF-LoginServer/net/psforever/objects/loadouts/EquipmentLoadout.html

13 lines
31 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.loadouts.EquipmentLoadout</title><meta content="PSF - LoginServer - master - net.psforever.objects.loadouts.EquipmentLoadout" name="description"/><meta content="PSF LoginServer master net.psforever.objects.loadouts.EquipmentLoadout" 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>
This previous state can be restored on any appropriate template from which the loadout was copied
by reconstructing any items (if warranted and permitted) or restoring any appropriate fields.
The three fields are the name assigned to the loadout,
the visible items that are created (which obey different rules depending on the source),
and the concealed items that are created and added to the source's <code>Inventory</code>.<br>
For example, the <code>visible_slots</code> on a <code>Player</code>-borne loadout will transform into the form <code>Array[EquipmentSlot]</code>;
<code>Vehicle</code>-originating loadouts transform into the form <code>Map[Int, Equipment]</code>.
<br>
The lists of user-specific loadouts are initialized with <code>FavoritesMessage</code> packets.
Specific entries are loaded or removed using <code>FavoritesRequest</code> packets.</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/loadouts/EquipmentLoadout.scala" target="_blank">EquipmentLoadout.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="Loadout.html" name="net.psforever.objects.loadouts.Loadout" id="net.psforever.objects.loadouts.Loadout" class="extype">Loadout</a>, <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="InfantryLoadout.html" name="net.psforever.objects.loadouts.InfantryLoadout" id="net.psforever.objects.loadouts.InfantryLoadout" class="extype">InfantryLoadout</a>, <a href="VehicleLoadout.html" name="net.psforever.objects.loadouts.VehicleLoadout" id="net.psforever.objects.loadouts.VehicleLoadout" class="extype">VehicleLoadout</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.loadouts.EquipmentLoadout"><span>EquipmentLoadout</span></li><li class="in" name="net.psforever.objects.loadouts.Loadout"><span>Loadout</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.loadouts.EquipmentLoadout#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(label:String,visible_slots:List[net.psforever.objects.loadouts.Loadout.SimplifiedEntry],inventory:List[net.psforever.objects.loadouts.Loadout.SimplifiedEntry]):net.psforever.objects.loadouts.EquipmentLoadout"></a><a id="&lt;init&gt;:EquipmentLoadout"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/EquipmentLoadout.html#&lt;init&gt;(label:String,visible_slots:List[net.psforever.objects.loadouts.Loadout.SimplifiedEntry],inventory:List[net.psforever.objects.loadouts.Loadout.SimplifiedEntry]):net.psforever.objects.loadouts.EquipmentLoadout" 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">EquipmentLoadout</span><span class="params">(<span name="label">label: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="visible_slots">visible_slots: <span name="scala.List" class="extype">List</span>[<a href="Loadout$$SimplifiedEntry.html" name="net.psforever.objects.loadouts.Loadout.SimplifiedEntry" id="net.psforever.objects.loadouts.Loadout.SimplifiedEntry" class="extype">SimplifiedEntry</a>]</span>, <span name="inventory">inventory: <span name="scala.List" class="extype">List</span>[<a href="Loadout$$SimplifiedEntry.html