PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-01-19 18:44:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
PSF-LoginServer/net/psforever/objects/locker/LockerEquipment.html

47 lines
89 KiB
HTML
Raw Blame 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.LockerEquipment</title><meta content="PSF - LoginServer - master - net.psforever.objects.locker.LockerEquipment" name="description"/><meta content="PSF LoginServer master net.psforever.objects.locker.LockerEquipment" 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.locker" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="locker"></a><a id="locker:locker"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/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">locker</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="current-entities indented4"><a href="LockerContainer$.html" title="" class="object"></a> <a href="LockerContainer.html" title="The companion of a Locker that is carried with a player masquerading as their sixth EquipmentSlot object and a sub-inventory item." class="class"></a><a href="LockerContainer.html" title="The companion of a Locker that is carried with a player masquerading as their sixth EquipmentSlot object and a sub-inventory item.">LockerContainer</a></li><li class="current-entities indented4"><span class="separator"></span> <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." class="class"></a><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.">LockerContainerControl</a></li><li class="current-entities indented4"><a href="LockerContainerDefinition$.html" title="" class="object"></a> <a href="LockerContainerDefinition.html" title="" class="class"></a><a href="LockerContainerDefinition.html" title="">LockerContainerDefinition</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="" 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." class="class"></a><a href="" 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.">LockerEquipment</a></li></ul></div></div><div id="content"><body class="class type"><div id="definition"><div class="big-circle class">c</div><p id="owner"><a href="../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a>.<a href="index.html" name="net.psforever.objects.locker" id="net.psforever.objects.locker" class="extype">locker</a></p><h1>LockerEquipment<span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html" title="Permalink"><i class="material-icons"></i></a></span></h1><h3><span class="morelinks"></span></h3></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><span class="name">LockerEquipment</span><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></h4><div id="comment" class="fullcommenttop"><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>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/locker/LockerEquipment.scala" target="_blank">LockerEquipment.scala</a></dd><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 class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a>, <a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a>, <a href="../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a>, <a href="../serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a>, <a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>, <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a>, <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a>, <a href="../entity/Identifiable.html" name="net.psforever.objects.entity.Identifiable" id="net.psforever.objects.entity.Identifiable" class="extype">Identifiable</a>, <span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></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.locker.LockerEquipment"><span>LockerEquipment</span></li><li class="in" name="net.psforever.objects.inventory.Container"><span>Container</span></li><li class="in" name="net.psforever.objects.equipment.Equipment"><span>Equipment</span></li><li class="in" name="net.psforever.objects.zones.blockmap.BlockMapEntity"><span>BlockMapEntity</span></li><li class="in" name="net.psforever.objects.serverobject.affinity.FactionAffinity"><span>FactionAffinity</span></li><li class="in" name="net.psforever.objects.PlanetSideGameObject"><span>PlanetSideGameObject</span></li><li class="in" name="net.psforever.objects.entity.WorldEntity"><span>WorldEntity</span></li><li class="in" name="net.psforever.objects.entity.IdentifiableEntity"><span>IdentifiableEntity</span></li><li class="in" name="net.psforever.objects.entity.Identifiable"><span>Identifiable</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.locker.LockerEquipment#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(locker:net.psforever.objects.locker.LockerContainer):net.psforever.objects.locker.LockerEquipment"></a><a id="&lt;init&gt;:LockerEquipment"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#&lt;init&gt;(locker:net.psforever.objects.locker.LockerContainer):net.psforever.objects.locker.LockerEquipment" 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">LockerEquipment</span><span class="params">(<span name="locker">locker: <a href="LockerContainer.html" name="net.psforever.objects.locker.LockerContainer" id="net.psforever.objects.locker.LockerContainer" class="extype">LockerContainer</a></span>)</span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">locker</dt><dd class="cmt"><p>the player-facing locker</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#!=(x$1:Any):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" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html###:Int" 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" title="gt4s: $hash$hash">##</span><span class="result">: <span name="scala.Int" class="extype">Int</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#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#==(x$1:Any):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" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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="net.psforever.objects.inventory.Container#Collisions" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Collisions(index:Int,width:Int,height:Int):scala.util.Try[List[net.psforever.objects.inventory.InventoryItem]]"></a><a id="Collisions(Int,Int,Int):Try[List[InventoryItem]]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Collisions(index:Int,width:Int,height:Int):scala.util.Try[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">Collisions</span><span class="params">(<span name="index">index: <span name="scala.Int" class="extype">Int</span></span>, <span name="width">width: <span name="scala.Int" class="extype">Int</span></span>, <span name="height">height: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</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">Given a region of "searchable unit positions" considered as stowable,
determine if any previously stowed items are contained within that region.<br>
<br>
Default usage, and recommended the continued inclusion of that use,
is defined in terms of <code>Equipment</code> being stowed in a <code>GridInventory</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Given a region of "searchable unit positions" considered as stowable,
determine if any previously stowed items are contained within that region.<br>
<br>
Default usage, and recommended the continued inclusion of that use,
is defined in terms of <code>Equipment</code> being stowed in a <code>GridInventory</code>.
Where the <code>Equipment</code> object is defined by the dimensions <code>width</code> and <code>height</code>,
starting a search at <code>index</code> will search all positions within a grid-like range of numbers.
Under certain searching conditions, this range may be meaningless,
such as is the case when searching individual positions that are normal <code>EquipmentSlot</code> objects.
Regardless, the value collected indicates the potential of multiple objects being discovered and
maintains a reference to the object itself and the slot position where the object is located.
(As any object can be discovered within the range, that is important.)</p></div><dl class="paramcmts block"><dt class="param">index</dt><dd class="cmt"><p>the position to start searching</p></dd><dt class="param">width</dt><dd class="cmt"><p>the width of the searchable space</p></dd><dt class="param">height</dt><dd class="cmt"><p>the height of the serachable space</p></dd><dt>returns</dt><dd class="cmt"><p>a list of objects that have been encountered within the searchable space</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>GridInventory.CheckCollisionsVar</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#Definition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Definition:net.psforever.objects.definition.EquipmentDefinition"></a><a id="Definition:EquipmentDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Definition:net.psforever.objects.definition.EquipmentDefinition" 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">Definition</span><span class="result">: <a href="../definition/EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a> → <a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Destroyed" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Destroyed:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Destroyed: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">Destroyed</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><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Destroyed_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Destroyed_=(state:Boolean):Boolean"></a><a id="Destroyed_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Destroyed_=(state:Boolean):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" title="gt4s: Destroyed_$eq">Destroyed_=</span><span class="params">(<span name="state">state: <span name="scala.Boolean" class="extype">Boolean</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><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Entity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Entity:net.psforever.objects.entity.WorldEntity"></a><a id="Entity:WorldEntity"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Entity:net.psforever.objects.entity.WorldEntity" 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">Entity</span><span class="result">: <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Entity_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Entity_=(newEntity:net.psforever.objects.entity.WorldEntity):Unit"></a><a id="Entity_=(WorldEntity):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Entity_=(newEntity:net.psforever.objects.entity.WorldEntity):Unit" 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" title="gt4s: Entity_$eq">Entity_=</span><span class="params">(<span name="newEntity">newEntity: <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#Faction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Faction:net.psforever.types.PlanetSideEmpire.Value"></a><a id="Faction:types.PlanetSideEmpire.Value"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Faction:net.psforever.types.PlanetSideEmpire.Value" 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">Faction</span><span class="result">: <a href="../../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a> → <a href="../serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.Equipment#Faction_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Faction_=(fact:net.psforever.types.PlanetSideEmpire.Value):net.psforever.types.PlanetSideEmpire.Value"></a><a id="Faction_=(types.PlanetSideEmpire.Value):types.PlanetSideEmpire.Value"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Faction_=(fact:net.psforever.types.PlanetSideEmpire.Value):net.psforever.types.PlanetSideEmpire.Value" 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" title="gt4s: Faction_$eq">Faction_=</span><span class="params">(<span name="fact">fact: <a href="../../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <a href="../../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a> → <a href="../serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.inventory.Container#Find" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Find(guid:net.psforever.types.PlanetSideGUID):Option[Int]"></a><a id="Find(PlanetSideGUID):Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Find(guid:net.psforever.types.PlanetSideGUID):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">Find</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</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">Given globally unique identifier, if the object using it is stowed, attempt to locate its slot.</p><div class="fullcomment"><div class="comment cmt"><p>Given globally unique identifier, if the object using it is stowed, attempt to locate its slot.
All positions, <code>VisibleSlot</code> and <code>Inventory</code>, and wherever else, should be searchable.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the GUID of the <code>Equipment</code></p></dd><dt>returns</dt><dd class="cmt"><p>the index of the <code>EquipmentSlot</code>, or <code>None</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.inventory.Container#Find" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Find(obj:net.psforever.objects.equipment.Equipment):Option[Int]"></a><a id="Find(Equipment):Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Find(obj: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">Find</span><span class="params">(<span name="obj">obj: <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">Given an object, attempt to locate its slot.</p><div class="fullcomment"><div class="comment cmt"><p>Given an object, attempt to locate its slot.
All positions, <code>VisibleSlot</code> and <code>Inventory</code>, and wherever else, should be searchable.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>Equipment</code> object</p></dd><dt>returns</dt><dd class="cmt"><p>the index of the <code>EquipmentSlot</code>, or <code>None</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.inventory.Container#Fit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Fit(tile:net.psforever.objects.inventory.InventoryTile):Option[Int]"></a><a id="Fit(InventoryTile):Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Fit(tile:net.psforever.objects.inventory.InventoryTile):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">Fit</span><span class="params">(<span name="tile">tile: <a href="../inventory/InventoryTile.html" name="net.psforever.objects.inventory.InventoryTile" id="net.psforever.objects.inventory.InventoryTile" class="extype">InventoryTile</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.inventory.Container#Fit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Fit(obj:net.psforever.objects.equipment.Equipment):Option[Int]"></a><a id="Fit(Equipment):Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Fit(obj: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">Fit</span><span class="params">(<span name="obj">obj: <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><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#GUID" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GUID:net.psforever.types.PlanetSideGUID"></a><a id="GUID:PlanetSideGUID"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#GUID:net.psforever.types.PlanetSideGUID" 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">GUID</span><span class="result">: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a> → <a href="../entity/Identifiable.html" name="net.psforever.objects.entity.Identifiable" id="net.psforever.objects.entity.Identifiable" class="extype">Identifiable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#GUID_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GUID_=(guid:net.psforever.types.PlanetSideGUID):net.psforever.types.PlanetSideGUID"></a><a id="GUID_=(PlanetSideGUID):PlanetSideGUID"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#GUID_=(guid:net.psforever.types.PlanetSideGUID):net.psforever.types.PlanetSideGUID" 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" title="gt4s: GUID_$eq">GUID_=</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a> → <a href="../entity/Identifiable.html" name="net.psforever.objects.entity.Identifiable" id="net.psforever.objects.entity.Identifiable" class="extype">Identifiable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.IdentifiableEntity#GUID_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GUID_=(guid:net.psforever.types.StalePlanetSideGUID):net.psforever.types.PlanetSideGUID"></a><a id="GUID_=(StalePlanetSideGUID):PlanetSideGUID"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#GUID_=(guid:net.psforever.types.StalePlanetSideGUID):net.psforever.types.PlanetSideGUID" 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" title="gt4s: GUID_$eq">GUID_=</span><span class="params">(<span name="guid">guid: <a href="../../types/StalePlanetSideGUID.html" name="net.psforever.types.StalePlanetSideGUID" id="net.psforever.types.StalePlanetSideGUID" class="extype">StalePlanetSideGUID</a></span>)</span><span class="result">: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span></span><p class="shortcomment cmt">Always intercept <code>StalePlanetSideGUID</code> references when attempting to mutate the GUID value.</p><div class="fullcomment"><div class="comment cmt"><p>Always intercept <code>StalePlanetSideGUID</code> references when attempting to mutate the GUID value.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the valid GUID to assign</p></dd><dt>returns</dt><dd class="cmt"><p>never returns</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></dd><dt>Exceptions thrown</dt><dd><span class="cmt"><p><span name="`AssigningGUIDException`" class="extype"><code>`AssigningGUIDException`</code></span> always</p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#HasGUID" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HasGUID:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#HasGUID: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">HasGUID</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Flag when the object has no GUID (initial condition) or is considered stale.</p><div class="fullcomment"><div class="comment cmt"><p>Flag when the object has no GUID (initial condition) or is considered stale.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>whether the value of the GUID is a valid representation for this object</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#Invalidate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Invalidate():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Invalidate():Unit" 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">Invalidate</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Indicate that the current GUID is no longer a valid representation of the object.</p><div class="fullcomment"><div class="comment cmt"><p>Indicate that the current GUID is no longer a valid representation of the object.
Transforms whatever the current GUID is into a <code>StalePlanetSideGUID</code> entity with the same value.
Doing this restores the object to its default mutation option ("the ability to set a new valid GUID").
The current GUID will still be accessed as if it were valid, but it will be wrapped in the new stale object.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#Inventory" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Inventory:net.psforever.objects.inventory.GridInventory"></a><a id="Inventory:GridInventory"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Inventory:net.psforever.objects.inventory.GridInventory" 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">Inventory</span><span class="result">: <a href="../inventory/GridInventory.html" name="net.psforever.objects.inventory.GridInventory" id="net.psforever.objects.inventory.GridInventory" class="extype">GridInventory</a></span></span><p class="shortcomment cmt">A(n imperfect) reference to a generalized pool of the contained objects.</p><div class="fullcomment"><div class="comment cmt"><p>A(n imperfect) reference to a generalized pool of the contained objects.
Having access to all of the available positions is not required.
The entries in this reference should definitely include all unseen positions.
The <code>GridInventory</code> returned by this accessor is also an implementation of <code>Container</code>.</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>VisibleSlots</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Orientation" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Orientation:net.psforever.types.Vector3"></a><a id="Orientation:Vector3"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Orientation:net.psforever.types.Vector3" 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">Orientation</span><span class="result">: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Orientation_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Orientation_=(vec:net.psforever.types.Vector3):net.psforever.types.Vector3"></a><a id="Orientation_=(Vector3):Vector3"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Orientation_=(vec:net.psforever.types.Vector3):net.psforever.types.Vector3" 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" title="gt4s: Orientation_$eq">Orientation_=</span><span class="params">(<span name="vec">vec: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Position" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Position:net.psforever.types.Vector3"></a><a id="Position:Vector3"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Position:net.psforever.types.Vector3" 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">Position</span><span class="result">: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Position_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Position_=(vec:net.psforever.types.Vector3):net.psforever.types.Vector3"></a><a id="Position_=(Vector3):Vector3"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Position_=(vec:net.psforever.types.Vector3):net.psforever.types.Vector3" 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" title="gt4s: Position_$eq">Position_=</span><span class="params">(<span name="vec">vec: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.Equipment#Size" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Size:net.psforever.objects.equipment.EquipmentSize.Value"></a><a id="Size:equipment.EquipmentSize.Value"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Size:net.psforever.objects.equipment.EquipmentSize.Value" 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">Size</span><span class="result">: <a href="../equipment/EquipmentSize$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.equipment.EquipmentSize.Value" id="net.psforever.objects.equipment.EquipmentSize.Value" class="extmbr">equipment.EquipmentSize.Value</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.inventory.Container#Slot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Slot(slotNum:Int):net.psforever.objects.equipment.EquipmentSlot"></a><a id="Slot(Int):EquipmentSlot"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Slot(slotNum:Int):net.psforever.objects.equipment.EquipmentSlot" 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">Slot</span><span class="params">(<span name="slotNum">slotNum: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <a href="../equipment/EquipmentSlot.html" name="net.psforever.objects.equipment.EquipmentSlot" id="net.psforever.objects.equipment.EquipmentSlot" class="extype">EquipmentSlot</a></span></span><p class="shortcomment cmt">Access to all stowable positions on this object by index.<br>
<br>
All positions, <code>VisibleSlot</code> and <code>Inventory</code>, and wherever else, should be reachable.</p><div class="fullcomment"><div class="comment cmt"><p>Access to all stowable positions on this object by index.<br>
<br>
All positions, <code>VisibleSlot</code> and <code>Inventory</code>, and wherever else, should be reachable.
Regardless of the internal storage medium, the format of return is expected to be the same structure of object
as the most basic storage component for <code>Equipment</code>, namely, <code>EquipmentSlot</code> objects.
By default, it is expected to return an <code>EquipmentSlot</code> that can not be manipulated because it is <code>Blocked</code>.</p></div><dl class="paramcmts block"><dt class="param">slotNum</dt><dd class="cmt"><p>an index</p></dd><dt>returns</dt><dd class="cmt"><p>the searchable position identified by that index</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>OffhandEquipmentSlot</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.Equipment#Tile" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Tile:net.psforever.objects.inventory.InventoryTile"></a><a id="Tile:InventoryTile"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Tile:net.psforever.objects.inventory.InventoryTile" 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">Tile</span><span class="result">: <a href="../inventory/InventoryTile.html" name="net.psforever.objects.inventory.InventoryTile" id="net.psforever.objects.inventory.InventoryTile" class="extype">InventoryTile</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Velocity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Velocity:Option[net.psforever.types.Vector3]"></a><a id="Velocity:Option[Vector3]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Velocity:Option[net.psforever.types.Vector3]" 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">Velocity</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Velocity_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Velocity_=(vec:Option[net.psforever.types.Vector3]):Option[net.psforever.types.Vector3]"></a><a id="Velocity_=(Option[Vector3]):Option[Vector3]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Velocity_=(vec:Option[net.psforever.types.Vector3]):Option[net.psforever.types.Vector3]" 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" title="gt4s: Velocity_$eq">Velocity_=</span><span class="params">(<span name="vec">vec: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.WorldEntity#Velocity_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Velocity_=(vec:net.psforever.types.Vector3):Option[net.psforever.types.Vector3]"></a><a id="Velocity_=(Vector3):Option[Vector3]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#Velocity_=(vec:net.psforever.types.Vector3):Option[net.psforever.types.Vector3]" 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" title="gt4s: Velocity_$eq">Velocity_=</span><span class="params">(<span name="vec">vec: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.locker.LockerEquipment#VisibleSlots" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VisibleSlots:Set[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#VisibleSlots:Set[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">VisibleSlots</span><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">A(n imperfect) reference to a generalized pool of the contained objects.<br>
<br>
Having access to all of the available positions is not required.</p><div class="fullcomment"><div class="comment cmt"><p>A(n imperfect) reference to a generalized pool of the contained objects.<br>
<br>
Having access to all of the available positions is not required.
Only the positions that can be actively viewed by other clients are listed.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>all of the affected slot indices</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.locker.LockerEquipment" id="net.psforever.objects.locker.LockerEquipment" class="extype">LockerEquipment</a> → <a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>Inventory</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/locker/LockerEquipment.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="net.psforever.objects.zones.blockmap.BlockMapEntity#blockMapEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="blockMapEntry:Option[net.psforever.objects.zones.blockmap.BlockMapEntry]"></a><a id="blockMapEntry:Option[BlockMapEntry]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#blockMapEntry:Option[net.psforever.objects.zones.blockmap.BlockMapEntry]" 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">blockMapEntry</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../zones/blockmap/BlockMapEntry.html" name="net.psforever.objects.zones.blockmap.BlockMapEntry" id="net.psforever.objects.zones.blockmap.BlockMapEntry" class="extype">BlockMapEntry</a>]</span></span><p class="shortcomment cmt">internal data regarding an active representation on a blockmap</p><div class="fullcomment"><div class="comment cmt"><p>internal data regarding an active representation on a blockmap</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntity#blockMapEntry_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="blockMapEntry_=(entry:Option[net.psforever.objects.zones.blockmap.BlockMapEntry]):Option[net.psforever.objects.zones.blockmap.BlockMapEntry]"></a><a id="blockMapEntry_=(Option[BlockMapEntry]):Option[BlockMapEntry]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#blockMapEntry_=(entry:Option[net.psforever.objects.zones.blockmap.BlockMapEntry]):Option[net.psforever.objects.zones.blockmap.BlockMapEntry]" 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" title="gt4s: blockMapEntry_$eq">blockMapEntry_=</span><span class="params">(<span name="entry">entry: <span name="scala.Option" class="extype">Option</span>[<a href="../zones/blockmap/BlockMapEntry.html" name="net.psforever.objects.zones.blockmap.BlockMapEntry" id="net.psforever.objects.zones.blockmap.BlockMapEntry" class="extype">BlockMapEntry</a>]</span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../zones/blockmap/BlockMapEntry.html" name="net.psforever.objects.zones.blockmap.BlockMapEntry" id="net.psforever.objects.zones.blockmap.BlockMapEntry" class="extype">BlockMapEntry</a>]</span></span><p class="shortcomment cmt">internal data regarding an active representation on a blockmap</p><div class="fullcomment"><div class="comment cmt"><p>internal data regarding an active representation on a blockmap</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></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/locker/LockerEquipment.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/locker/LockerEquipment.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/locker/LockerEquipment.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/locker/LockerEquipment.html#finalize():Unit" 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">finalize</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</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="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_&lt;:AnyRef]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#getClass():Class[_]" 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">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ &lt;: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#hashCode():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">hashCode</span><span class="params">()</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#isInstanceOf[T0]: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">isInstanceOf</span><span class="tparams">[<span name="T0">T0</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>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.WorldEntity#isMoving" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isMoving(test:Float):Boolean"></a><a id="isMoving(Float):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#isMoving(test:Float):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">isMoving</span><span class="params">(<span name="test">test: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">This object is not considered moving unless it is moving at least as fast as a certain velocity.</p><div class="fullcomment"><div class="comment cmt"><p>This object is not considered moving unless it is moving at least as fast as a certain velocity.</p></div><dl class="paramcmts block"><dt class="param">test</dt><dd class="cmt"><p>the (squared) velocity to test against</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if we are moving; <code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.WorldEntity#isMoving" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isMoving(test:net.psforever.types.Vector3):Boolean"></a><a id="isMoving(Vector3):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#isMoving(test:net.psforever.types.Vector3):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">isMoving</span><span class="params">(<span name="test">test: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">This object is not considered moving unless it is moving at least as fast as a certain velocity.</p><div class="fullcomment"><div class="comment cmt"><p>This object is not considered moving unless it is moving at least as fast as a certain velocity.</p></div><dl class="paramcmts block"><dt class="param">test</dt><dd class="cmt"><p>the velocity to test against</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if we are moving; <code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.WorldEntity#isMoving" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isMoving:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#isMoving: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">isMoving</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">A velocity of non-zero is the same as moving.</p><div class="fullcomment"><div class="comment cmt"><p>A velocity of non-zero is the same as moving.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p><code>true</code>, if we are moving; <code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#ne(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">ne</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#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#notify():Unit" 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">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#notifyAll():Unit" 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">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntity#sector" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sector(zone:net.psforever.objects.zones.Zone,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="sector(Zone,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#sector(zone:net.psforever.objects.zones.Zone,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation" 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">sector</span><span class="params">(<span name="zone">zone: <a href="../zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>, <span name="range">range: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result">: <a href="../zones/blockmap/SectorPopulation.html" name="net.psforever.objects.zones.blockmap.SectorPopulation" id="net.psforever.objects.zones.blockmap.SectorPopulation" class="extype">SectorPopulation</a></span></span><p class="shortcomment cmt">Buckets in the blockmap are called "sectors".</p><div class="fullcomment"><div class="comment cmt"><p>Buckets in the blockmap are called "sectors".
Find the sectors in a given blockmap in which the entity would be represented within a given range.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>what region the blockmap represents</p></dd><dt class="param">range</dt><dd class="cmt"><p>the custom distance from the central sector along the major axes</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#synchronized[T0](x$1:=&gt;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">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: =&gt; <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.Equipment#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#toString():String" 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">toString</span><span class="params">()</span><span class="result">: <span name="scala.Predef.String" class="extype">String</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a> → AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntity#updateBlockMapEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="updateBlockMapEntry(newCoords:net.psforever.types.Vector3):Boolean"></a><a id="updateBlockMapEntry(Vector3):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#updateBlockMapEntry(newCoords:net.psforever.types.Vector3):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">updateBlockMapEntry</span><span class="params">(<span name="newCoords">newCoords: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Update the internal data's known coordinate position without changing representation on whatever blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Update the internal data's known coordinate position without changing representation on whatever blockmap.
Has the potential to cause major issues with the blockmap if used without external checks.</p></div><dl class="paramcmts block"><dt class="param">newCoords</dt><dd class="cmt"><p>the coordinate position</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the coordinates were updated;
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#wait():Unit" 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">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><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.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#wait(x$1:Long,x$2:Int):Unit" 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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><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.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/locker/LockerEquipment.html#wait(x$1:Long):Unit" 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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><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.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="net.psforever.objects.inventory.Container" class="parent"><h3>Inherited from <a href="../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></h3></div><div name="net.psforever.objects.equipment.Equipment" class="parent"><h3>Inherited from <a href="../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></h3></div><div name="net.psforever.objects.zones.blockmap.BlockMapEntity" class="parent"><h3>Inherited from <a href="../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></h3></div><div name="net.psforever.objects.serverobject.affinity.FactionAffinity" class="parent"><h3>Inherited from <a href="../serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a></h3></div><div name="net.psforever.objects.PlanetSideGameObject" class="parent"><h3>Inherited from <a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></h3></div><div name="net.psforever.objects.entity.WorldEntity" class="parent"><h3>Inherited from <a href="../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></h3></div><div name="net.psforever.objects.entity.IdentifiableEntity" class="parent"><h3>Inherited from <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></h3></div><div name="net.psforever.objects.entity.Identifiable" class="parent"><h3>Inherited from <a href="../entity/Identifiable.html" name="net.psforever.objects.entity.Identifiable" id="net.psforever.objects.entity.Identifiable" class="extype">Identifiable</a></h3></div><div name="scala.AnyRef" class="parent"><h3>Inherited from <span name="scala.AnyRef" class="extype">AnyRef</span></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3></div></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 View git blame Copy permalink