PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-04-27 23:35:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/loadouts/index.html

40 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.loadouts</title><meta content="PSF - LoginServer - master - net.psforever.objects.loadouts" name="description"/><meta content="PSF LoginServer master net.psforever.objects.loadouts" 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 */
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
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_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></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" class="anchorToMember"></a><a id="net:net" class="anchorToMember"></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" class="anchorToMember"></a><a id="psforever:psforever" class="anchorToMember"></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" class="anchorToMember"></a><a id="objects:objects" class="anchorToMember"></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" class="anchorToMember"></a><a id="avatar:avatar" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
Specific entries are loaded or removed using <code>FavoritesRequest</code> packets.</p></div></div></li><li class="indented0 " name="net.psforever.objects.loadouts.InfantryLoadout" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InfantryLoadoutextendsEquipmentLoadoutwithProductwithSerializable" class="anchorToMember"></a><a id="InfantryLoadout:InfantryLoadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/InfantryLoadout.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="InfantryLoadout.html" title="A blueprint of a player's uniform, their holster items, and their inventory items, saved in a specific state."><span class="name">InfantryLoadout</span></a><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" name="net.psforever.objects.loadouts.Loadout.SimplifiedEntry" id="net.psforever.objects.loadouts.Loadout.SimplifiedEntry" class="extype">SimplifiedEntry</a>]</span>, <span name="exosuit">exosuit: <a href="../../types/ExoSuitType$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.ExoSuitType.Value" id="net.psforever.types.ExoSuitType.Value" class="extmbr">types.ExoSuitType.Value</a></span>, <span name="subtype">subtype: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="EquipmentLoadout.html" name="net.psforever.objects.loadouts.EquipmentLoadout" id="net.psforever.objects.loadouts.EquipmentLoadout" class="extype">EquipmentLoadout</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">A blueprint of a player's uniform, their holster items, and their inventory items, saved in a specific state.</p><div class="fullcomment"><div class="comment cmt"><p>A blueprint of a player's uniform, their holster items, and their inventory items, saved in a specific state.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
This previous state can be restored on any given player template
by reconstructing the items (if permitted) and re-assigning the uniform (if available).<br>
<br>
The fifth tab on an <code>order_terminal</code> window is occupied by the list of "Favorite" <code>Loadout</code> blueprints.
The ten-long list is initialized with <code>FavoritesMessage</code> packets assigned to the "Infantry" list.
Specific entries are added or removed using <code>FavoritesRequest</code> packets,
re-established using other conventional game packets.
</p></div><dl class="paramcmts block"><dt class="param">label</dt><dd class="cmt"><p>the name by which this inventory will be known when displayed in a Favorites list;
field gets inherited</p></dd><dt class="param">visible_slots</dt><dd class="cmt"><p>simplified representation of the <code>Equipment</code> that can see "seen" on the target;
field gets inherited</p></dd><dt class="param">inventory</dt><dd class="cmt"><p>simplified representation of the <code>Equipment</code> in the target's inventory or trunk;
field gets inherited</p></dd><dt class="param">exosuit</dt><dd class="cmt"><p>the exo-suit in which the avatar will be dressed;
may be restricted</p></dd><dt class="param">subtype</dt><dd class="cmt"><p>the mechanized assault exo-suit specialization number that indicates whether the MAX performs:
anti-infantry (1), anti-vehicular (2), or anti-air work (3);
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
the default value is 0</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="LoadoutextendsAnyRef" class="anchorToMember"></a><a id="Loadout:Loadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="Loadout.html" title="The base of all specific kinds of blueprint containers."><span class="name">Loadout</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">The base of all specific kinds of blueprint containers.</p><div class="fullcomment"><div class="comment cmt"><p>The base of all specific kinds of blueprint containers.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
This previous state can be restored on any appropriate template from which the loadout was copied
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
by reconstructing any items (if warranted and permitted) or restoring any appropriate fields.</p></div></div></li><li class="indented0 " name="net.psforever.objects.loadouts.SquadLoadout" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadLoadoutextendsLoadoutwithProductwithSerializable" class="anchorToMember"></a><a id="SquadLoadout:SquadLoadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/SquadLoadout.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="SquadLoadout.html" title=""><span class="name">SquadLoadout</span></a><span class="params">(<span name="task">task: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="zone_id">zone_id: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span>, <span name="members">members: <span name="scala.List" class="extype">List</span>[<a href="SquadPositionLoadout.html" name="net.psforever.objects.loadouts.SquadPositionLoadout" id="net.psforever.objects.loadouts.SquadPositionLoadout" class="extype">SquadPositionLoadout</a>]</span>)</span><span class="result"> extends <a href="Loadout.html" name="net.psforever.objects.loadouts.Loadout" id="net.psforever.objects.loadouts.Loadout" class="extype">Loadout</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.objects.loadouts.SquadPositionLoadout" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadPositionLoadoutextendsProductwithSerializable" class="anchorToMember"></a><a id="SquadPositionLoadout:SquadPositionLoadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/SquadPositionLoadout.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="SquadPositionLoadout.html" title=""><span class="name">SquadPositionLoadout</span></a><span class="params">(<span name="index">index: <span name="scala.Int" class="extype">Int</span></span>, <span name="role">role: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="orders">orders: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="requirements">requirements: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="../avatar/Certification.html" name="net.psforever.objects.avatar.Certification" id="net.psforever.objects.avatar.Certification" class="extype">Certification</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></li><li class="indented0 " name="net.psforever.objects.loadouts.VehicleLoadout" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleLoadoutextendsEquipmentLoadoutwithProductwithSerializable" class="anchorToMember"></a><a id="VehicleLoadout:VehicleLoadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/VehicleLoadout.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="VehicleLoadout.html" title="A blueprint of a vehicle's mounted weapons and its inventory items, saved in a specific state."><span class="name">VehicleLoadout</span></a><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="
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
This previous state can be restored on an apporpriate vehicle template
by reconstructing the items (if permitted).
Mismatched vehicles may produce no loadout or an imperfect loadout depending on specifications.<br>
<br>
The second tab on an <code>repair_silo</code> window is occupied by the list of "Favorite" <code>Loadout</code> blueprints.
The five-long list is initialized with <code>FavoritesMessage</code> packets assigned to the "Vehicle" list.
Specific entries are added or removed using <code>FavoritesRequest</code> packets,
re-established using other conventional game packets.</p></div><dl class="paramcmts block"><dt class="param">label</dt><dd class="cmt"><p>the name by which this inventory will be known when displayed in a Favorites list;
field gets inherited</p></dd><dt class="param">visible_slots</dt><dd class="cmt"><p>simplified representation of the <code>Equipment</code> that can see "seen" on the target;
field gets inherited</p></dd><dt class="param">inventory</dt><dd class="cmt"><p>simplified representation of the <code>Equipment</code> in the target's inventory or trunk;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
field gets inherited</p></dd><dt class="param">vehicle_definition</dt><dd class="cmt"><p>the original type of vehicle whose state is being populated</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.loadouts.InfantryLoadout" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InfantryLoadout" class="anchorToMember"></a><a id="InfantryLoadout:InfantryLoadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/InfantryLoadout$.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="InfantryLoadout$.html" title=""><span class="name">InfantryLoadout</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.loadouts.Loadout" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Loadout" class="anchorToMember"></a><a id="Loadout:Loadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/Loadout$.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="Loadout$.html" title=""><span class="name">Loadout</span></a></span></li><li class="indented0 " name="net.psforever.objects.loadouts.VehicleLoadout" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VehicleLoadout" class="anchorToMember"></a><a id="VehicleLoadout:VehicleLoadout" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/loadouts/VehicleLoadout$.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="VehicleLoadout$.html" title=""><span class="name">VehicleLoadout</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
Reference in a new issue Copy permalink