PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-20 15:13:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/containable/Containable$.html

8 lines
47 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.serverobject.containable.Containable</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.containable.Containable" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.containable.Containable" 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.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject" class="anchorToMember"></a><a id="serverobject:serverobject" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net
<code>-1</code> if no insertion slot was reported in the original message or discovered in the process of inserting</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.Containable.ItemFromSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ItemFromSlotextendsProductwithSerializable" class="anchorToMember"></a><a id="ItemFromSlot:ItemFromSlot" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/Containable$$ItemFromSlot.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="Containable$$ItemFromSlot.html" title="A response for the RemoveItemFromSlot message."><span class="name">ItemFromSlot</span></a><span class="params">(<span name="obj">obj: <a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</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 name="item">item: <span name="scala.Option" class="extype">Option</span>[<a href="../../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a>]</span>, <span name="slot">slot: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</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><p class="shortcomment cmt">A response for the <code>RemoveItemFromSlot</code> message.</p><div class="fullcomment"><div class="comment cmt"><p>A response for the <code>RemoveItemFromSlot</code> message.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
It serves the dual purpose of reporting a missing item (by not reporting any slot information)
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
and reporting no item at a given position (by not reporting any item information).</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the equipment that was removed</p></dd><dt class="param">slot</dt><dd class="cmt"><p>the index position from which any item was removed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.Containable.ItemPutInSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ItemPutInSlotextendsProductwithSerializable" class="anchorToMember"></a><a id="ItemPutInSlot:ItemPutInSlot" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/Containable$$ItemPutInSlot.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="Containable$$ItemPutInSlot.html" title="A &quot;successful insertion&quot; response for the variety message of messages that attempt to insert an item into a container."><span class="name">ItemPutInSlot</span></a><span class="params">(<span name="obj">obj: <a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</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 name="item">item: <a href="../../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>, <span name="slot">slot: <span name="scala.Int" class="extype">Int</span></span>, <span name="swapped_item">swapped_item: <span name="scala.Option" class="extype">Option</span>[<a href="../../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</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><p class="shortcomment cmt">A "successful insertion" response for the variety message of messages that attempt to insert an item into a container.</p><div class="fullcomment"><div class="comment cmt"><p>A "successful insertion" response for the variety message of messages that attempt to insert an item into a container.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the equipment that was inserted</p></dd><dt class="param">slot</dt><dd class="cmt"><p>the slot position into which the item was inserted</p></dd><dt class="param">swapped_item</dt><dd class="cmt"><p>any other item, previously in the container, that was displaced to make room for this insertion</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.Containable.MoveItem" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MoveItemextendsDeferrableMsgwithProductwithSerializable" class="anchorToMember"></a><a id="MoveItem:MoveItem" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/Containable$$MoveItem.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="Containable$$MoveItem.html" title="The item should already be contained by us."><span class="name">MoveItem</span></a><span class="params">(<span name="destination">destination: <a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
The item is being removed from our containment and placed into a fixed slot position in another container.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
<code>MoveItem</code> is a process that may be complicated and is one reason why <code>DeferrableMsg</code>s are employed.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container into which the item is being placed</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item</p></dd><dt class="param">destination_slot</dt><dd class="cmt"><p>where in the destination container the item is being placed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.Containable.PutItemAway" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PutItemAwayextendsDeferrableMsgwithProductwithSerializable" class="anchorToMember"></a><a id="PutItemAway:PutItemAway" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/Containable$$PutItemAway.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="Containable$$PutItemAway.html" title=""><span class="name">PutItemAway</span></a><span class="params">(<span name="item">item: <a href="../../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>)</span><span class="result"> extends <a href="DeferrableMsg.html" name="net.psforever.objects.serverobject.containable.DeferrableMsg" id="net.psforever.objects.serverobject.containable.DeferrableMsg" class="extype">DeferrableMsg</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.serverobject.containable.Containable.PutItemInSlot" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PutItemInSlotextendsDeferrableMsgwithProductwithSerializable" class="anchorToMember"></a><a id="PutItemInSlot:PutItemInSlot" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/Containable$$PutItemInSlot.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="Containable$$PutItemInSlot.html" title=""><span class="name">PutItemInSlot</span></a><span class="params">(<span name="item">item: <a href="../../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>, <span name="slot">slot: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="DeferrableMsg.html" name="net.psforever.objects.serverobject.containable.DeferrableMsg" id="net.psforever.objects.serverobject.containable.DeferrableMsg" class="extype">DeferrableMsg</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.serverobject.containable.Containable.PutItemInSlotOnly" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PutItemInSlotOnlyextendsDeferrableMsgwithProductwithSerializable" class="anchorToMember"></a><a id="PutItemInSlotOnly:PutItemInSlotOnly" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/Containable$$PutItemInSlotOnly.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="Containable$$PutItemInSlotOnly.html" title=""><span class="name">PutItemInSlotOnly</span></a><span class="params">(<span name="item">item: <a href="../../equipment/Equipment.htm
Reference in a new issue Copy permalink