PSF-LoginServer/net/psforever/objects/locker/index.html

15 lines
27 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.locker</title><meta content="PSF - LoginServer - master - net.psforever.objects.locker" name="description"/><meta content="PSF LoginServer master net.psforever.objects.locker" 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></
masquerading as their sixth <code>EquipmentSlot</code> object and a sub-inventory item.</p><div class="fullcomment"><div class="comment cmt"><p>The companion of a <code>Locker</code> that is carried with a player
masquerading as their sixth <code>EquipmentSlot</code> object and a sub-inventory item.
The inventory of this object is accessed indirectly using a game world <code>Locker</code> object (<code>mb_locker</code>) as a proxy.
The <code>Player</code> class refers to it as the "fifth slot".
</p></div></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerContainerControl" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LockerContainerControlextendsActorwithContainableBehavior"></a><a id="LockerContainerControl:LockerContainerControl"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerContainerControl.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="LockerContainerControl.html" title="A control agency mainly for manipulating the equipment stowed by a player in a LockerContainer and reporting back to a specific xchannel in the event system about these changes."><span class="name">LockerContainerControl</span></a><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span> with <a href="../serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></span></span><p class="shortcomment cmt">A control agency mainly for manipulating the equipment stowed by a player in a <code>LockerContainer</code>
and reporting back to a specific xchannel in the event system about these changes.</p></li><li class="indented0 " name="net.psforever.objects.locker.LockerContainerDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LockerContainerDefinitionextendsEquipmentDefinition"></a><a id="LockerContainerDefinition:LockerContainerDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerContainerDefinition.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="LockerContainerDefinition.html" title=""><span class="name">LockerContainerDefinition</span></a><span class="result"> extends <a href="../definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LockerEquipmentextendsEquipmentwithContainer"></a><a id="LockerEquipment:LockerEquipment"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="LockerEquipment.html" title="A wrapper class that allows a player-facing locker component to be treated like a standard Equipment object in the player's fifth (sixth) slot."><span class="name">LockerEquipment</span></a><span class="result"> extends <a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a> with <a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span></span><p class="shortcomment cmt">A wrapper class that allows a player-facing locker component
to be treated like a standard <code>Equipment</code> object in the player's fifth (sixth) slot.</p><div class="fullcomment"><div class="comment cmt"><p>A wrapper class that allows a player-facing locker component
to be treated like a standard <code>Equipment</code> object in the player's fifth (sixth) slot.
(The opposite is not true - the equipment does not get treated as a locker component.)
During packet conversion and registration and general access in terms of holsters or "equipment slots",
the component may be be treated the same as other existing objects at the same level.
The entity's ability to be utilized like an inventory-stowable entity is not compromised.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>EquipmentSlot</code></p></span><span class="cmt"><p><code>IdentifiableEntity</code></p></span><span class="cmt"><p><code>LockerContainer</code></p></span></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.locker.LockerContainer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LockerContainer"></a><a id="LockerContainer:LockerContainer"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerContainer$.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="LockerContainer$.html" title=""><span class="name">LockerContainer</span></a></span></li><li class="indented0 " name="net.psforever.objects.locker.LockerContainerDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LockerContainerDefinition"></a><a id="LockerContainerDefinition:LockerContainerDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerContainerDefinition$.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="LockerContainerDefinition$.html" title=""><span class="name">LockerContainerDefinition</span></a></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>