PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-12 19:31:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/containable/ContainableBehavior$.html

45 lines
57 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.ContainableBehavior</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.containable.ContainableBehavior" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.containable.ContainableBehavior" 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.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject"></a><a id="serverobject:serverobject"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/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
Used to filter through lists of object data before it is placed into a player's inventory.
Drop the item if:<br>
- the item is cavern equipment<br>
- the item is a <code>BoomerTrigger</code> type object<br>
- the item is a <code>router_telepad</code> type object<br>
- the item is another faction's exclusive equipment</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd><dt>returns</dt><dd class="cmt"><p>true if the item is to be dropped; false, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#PermitEquipmentStow" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PermitEquipmentStow(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,equipment:net.psforever.objects.equipment.Equipment):Boolean"></a><a id="PermitEquipmentStow(PlanetSideServerObjectwithContainer,Equipment):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#PermitEquipmentStow(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,equipment:net.psforever.objects.equipment.Equipment):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">PermitEquipmentStow</span><span class="params">(<span name="destination">destination: <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="equipment">equipment: <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">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Apply incontestable, arbitrary limitations
whereby certain items are denied insertion into certain containers
for vaguely documented but assuredly fantastic excuses on the part of the developer.</p><div class="fullcomment"><div class="comment cmt"><p>Apply incontestable, arbitrary limitations
whereby certain items are denied insertion into certain containers
for vaguely documented but assuredly fantastic excuses on the part of the developer.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container</p></dd><dt class="param">equipment</dt><dd class="cmt"><p>the item to be inserted</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the object is allowed to contain the type of equipment object;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TestPutItemInSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TestPutItemInSlot(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Int):Option[List[net.psforever.objects.inventory.InventoryItem]]"></a><a id="TestPutItemInSlot(PlanetSideServerObjectwithContainer,Equipment,Int):Option[List[InventoryItem]]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TestPutItemInSlot(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Int):Option[List[net.psforever.objects.inventory.InventoryItem]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TestPutItemInSlot</span><span class="params">(<span name="destination">destination: <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="dest">dest: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.List" class="extype">List</span>[<a href="../../inventory/InventoryItem.html" name="net.psforever.objects.inventory.InventoryItem" id="net.psforever.objects.inventory.InventoryItem" class="extype">InventoryItem</a>]]</span></span><p class="shortcomment cmt">Are the conditions for an item insertion acceptable?
If another item occupies the expected region of insertion (collision of bounding regions),
the insertion can still be permitted with the assumption that
the displaced item ("swap item") will have to be put somewhere else.</p><div class="fullcomment"><div class="comment cmt"><p>Are the conditions for an item insertion acceptable?
If another item occupies the expected region of insertion (collision of bounding regions),
the insertion can still be permitted with the assumption that
the displaced item ("swap item") will have to be put somewhere else.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item to be tested for insertion</p></dd><dt class="param">dest</dt><dd class="cmt"><p>the upper left corner of the insertion position</p></dd><dt>returns</dt><dd class="cmt"><p>the results of the insertion test, if an insertion can be permitted;
<code>None</code>, otherwise, and the insertion is not permitted</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ContainableBehavior.PermitEquipmentStow</code></p></span><span class="cmt"><p><code>Container.Collisions</code></p></span><span class="cmt"><p><code>InventoryTile</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TryPutItemAway" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryPutItemAway(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment):Option[Int]"></a><a id="TryPutItemAway(PlanetSideServerObjectwithContainer,Equipment):Option[Int]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TryPutItemAway(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment):Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TryPutItemAway</span><span class="params">(<span name="destination">destination: <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><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Put an item in a container in the whatever position it cleanly fits.</p><div class="fullcomment"><div class="comment cmt"><p>Put an item in a container in the whatever position it cleanly fits.
The inserted item will not swap places with another item in this case.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item to be inserted</p></dd><dt>returns</dt><dd class="cmt"><p>the slot index of the insertion point;
<code>None</code>, if a clean insertion is not possible</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TryPutItemInSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryPutItemInSlot(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Int):(Boolean,Option[net.psforever.objects.equipment.Equipment])"></a><a id="TryPutItemInSlot(PlanetSideServerObjectwithContainer,Equipment,Int):(Boolean,Option[Equipment])"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TryPutItemInSlot(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Int):(Boolean,Option[net.psforever.objects.equipment.Equipment])" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TryPutItemInSlot</span><span class="params">(<span name="destination">destination: <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="dest">dest: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: (<span name="scala.Boolean" class="extype">Boolean</span>, <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><p class="shortcomment cmt">Put an item in a container at the given position.</p><div class="fullcomment"><div class="comment cmt"><p>Put an item in a container at the given position.
The inserted item may swap places with another item.
If the new item can not be inserted, the swap item is kept in its original position.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item to be inserted</p></dd><dt class="param">dest</dt><dd class="cmt"><p>in which slot the insertion is expected to occur (upper left corner of item)</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>Tuple</code> of two values;
the first is <code>true</code> if the insertion occurred; and, <code>false</code>, otherwise
the second is an optional item that was removed from a coincidental position in the container ("swap item")</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TryPutItemInSlotOnly" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryPutItemInSlotOnly(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Int):Boolean"></a><a id="TryPutItemInSlotOnly(PlanetSideServerObjectwithContainer,Equipment,Int):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TryPutItemInSlotOnly(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Int):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TryPutItemInSlotOnly</span><span class="params">(<span name="destination">destination: <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="dest">dest: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Put an item in a container at the given position.</p><div class="fullcomment"><div class="comment cmt"><p>Put an item in a container at the given position.
The inserted item is not permitted to swap places with another item in this case.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item to be inserted</p></dd><dt class="param">dest</dt><dd class="cmt"><p>in which slot the insertion is expected to occur (upper left corner of item)</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the insertion occurred;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TryPutItemInSlotOnlyOrAway" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryPutItemInSlotOnlyOrAway(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Option[Int]):(Option[Int],Option[net.psforever.objects.equipment.Equipment])"></a><a id="TryPutItemInSlotOnlyOrAway(PlanetSideServerObjectwithContainer,Equipment,Option[Int]):(Option[Int],Option[Equipment])"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TryPutItemInSlotOnlyOrAway(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Option[Int]):(Option[Int],Option[net.psforever.objects.equipment.Equipment])" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TryPutItemInSlotOnlyOrAway</span><span class="params">(<span name="destination">destination: <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="dest">dest: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span>)</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>], <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><p class="shortcomment cmt">Attempt to put an item in a container at the given position.</p><div class="fullcomment"><div class="comment cmt"><p>Attempt to put an item in a container at the given position.
The inserted item may not swap places with another item at this time.
If the targeted insertion at this position fails,
attempt to put the item in the container in the whatever position it cleanly fits.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item to be inserted</p></dd><dt class="param">dest</dt><dd class="cmt"><p>in which specific slot the insertion is first tested (upper left corner of item)</p></dd><dt>returns</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TryPutItemInSlotOrAway" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryPutItemInSlotOrAway(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Option[Int]):(Option[Int],Option[net.psforever.objects.equipment.Equipment])"></a><a id="TryPutItemInSlotOrAway(PlanetSideServerObjectwithContainer,Equipment,Option[Int]):(Option[Int],Option[Equipment])"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TryPutItemInSlotOrAway(destination:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment,dest:Option[Int]):(Option[Int],Option[net.psforever.objects.equipment.Equipment])" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TryPutItemInSlotOrAway</span><span class="params">(<span name="destination">destination: <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="dest">dest: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span>)</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>], <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><p class="shortcomment cmt">Attempt to put an item in a container at the given position.</p><div class="fullcomment"><div class="comment cmt"><p>Attempt to put an item in a container at the given position.
The inserted item may swap places with another item at this time.
If the targeted insertion at this position fails,
attempt to put the item in the container in the whatever position it cleanly fits.</p></div><dl class="paramcmts block"><dt class="param">destination</dt><dd class="cmt"><p>the container</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item to be inserted</p></dd><dt class="param">dest</dt><dd class="cmt"><p>in which specific slot the insertion is first tested (upper left corner of item)</p></dd><dt>returns</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TryRemoveItemFromSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryRemoveItemFromSlot(source:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,slot:Int):(Option[Int],Option[net.psforever.objects.equipment.Equipment])"></a><a id="TryRemoveItemFromSlot(PlanetSideServerObjectwithContainer,Int):(Option[Int],Option[Equipment])"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TryRemoveItemFromSlot(source:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,slot:Int):(Option[Int],Option[net.psforever.objects.equipment.Equipment])" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TryRemoveItemFromSlot</span><span class="params">(<span name="source">source: <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="slot">slot: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>], <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><p class="shortcomment cmt">If the target slot of a container contains an item, remove that item from the container
fromthe upper left corner position of the item as found in the container.</p><div class="fullcomment"><div class="comment cmt"><p>If the target slot of a container contains an item, remove that item from the container
fromthe upper left corner position of the item as found in the container.
This process can fail if no item can be found or if it can not be removed for some reason.</p></div><dl class="paramcmts block"><dt class="param">source</dt><dd class="cmt"><p>the container in which the <code>slot</code> is to be searched</p></dd><dt class="param">slot</dt><dd class="cmt"><p>where the container will be searched</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>Tuple</code> of two values;
the first is from what <code>slot</code> in the container an <code>item</code> was removed, if any item removed;
the second is the item, if it has been removed;
will use <code>(None, None)</code> to report failure</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Container.Find</code></p></span><span class="cmt"><p><code>EquipmentSlot.Equipment</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#TryRemoveItemFromSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryRemoveItemFromSlot(source:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment):(Option[Int],Option[net.psforever.objects.equipment.Equipment])"></a><a id="TryRemoveItemFromSlot(PlanetSideServerObjectwithContainer,Equipment):(Option[Int],Option[Equipment])"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#TryRemoveItemFromSlot(source:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,item:net.psforever.objects.equipment.Equipment):(Option[Int],Option[net.psforever.objects.equipment.Equipment])" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">TryRemoveItemFromSlot</span><span class="params">(<span name="source">source: <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><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>], <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><p class="shortcomment cmt">If the target item can be found in a container, remove the item from the container.</p><div class="fullcomment"><div class="comment cmt"><p>If the target item can be found in a container, remove the item from the container.
This process can fail if the item can not be found or if it can not be removed for some reason.</p></div><dl class="paramcmts block"><dt class="param">source</dt><dd class="cmt"><p>the container in which the <code>item</code> is currently located</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item to be removed</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>Tuple</code> of two optional values;
the first is from what index in the container the <code>item</code> was removed, if it was removed;
the second is the item again, if it has been removed;
will use <code>(None, None)</code> to report failure</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Container.Find</code></p></span><span class="cmt"><p><code>EquipmentSlot.Equipment</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/containable/ContainableBehavior$.html#equals(x$1:Object):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/s
Reference in a new issue Copy permalink