PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-13 09:20:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/Player.html

43 lines
181 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.Player</title><meta content="PSF - LoginServer - master - net.psforever.objects.Player" name="description"/><meta content="PSF LoginServer master net.psforever.objects.Player" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
A player may only access to the backpack of a dead released player, and only if no one else has access at the moment.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the player who wishes to access the backpack</p></dd><dt>returns</dt><dd class="cmt"><p>the player who is currently allowed to access the backpack</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Player#AccessingBackpack_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AccessingBackpack_=(guid:net.psforever.types.PlanetSideGUID):Option[net.psforever.types.PlanetSideGUID]"></a><a id="AccessingBackpack_=(PlanetSideGUID):Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#AccessingBackpack_=(guid:net.psforever.types.PlanetSideGUID):Option[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: AccessingBackpack_$eq">AccessingBackpack_=</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>[<a href="../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.PlanetSideServerObject#Actor" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Actor:akka.actor.ActorRef"></a><a id="Actor:ActorRef"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Actor:akka.actor.ActorRef" 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">Actor</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><p class="shortcomment cmt">Retrieve a reference to the internal <code>Actor</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Retrieve a reference to the internal <code>Actor</code>.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the internal <code>ActorRef</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.PlanetSideServerObject#Actor_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Actor_=(control:akka.actor.ActorRef):akka.actor.ActorRef"></a><a id="Actor_=(ActorRef):ActorRef"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Actor_=(control:akka.actor.ActorRef):akka.actor.ActorRef" 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: Actor_$eq">Actor_=</span><span class="params">(<span name="control">control: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><p class="shortcomment cmt">Assign an <code>Actor</code> to act for this server object.</p><div class="fullcomment"><div class="comment cmt"><p>Assign an <code>Actor</code> to act for this server object.
This reference is only set once, that is, as long as the internal <code>ActorRef</code> directs to <code>ActorRef.noSender</code> (<code>null</code>).</p></div><dl class="paramcmts block"><dt class="param">control</dt><dd class="cmt"><p>the <code>Actor</code> whose functionality will govern this server object</p></dd><dt>returns</dt><dd class="cmt"><p>the current internal <code>ActorRef</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Player#Armor" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Armor:Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Armor: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">Armor</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#Armor_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Armor_=(assignArmor:Int):Int"></a><a id="Armor_=(Int):Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Armor_=(assignArmor:Int):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" title="gt4s: Armor_$eq">Armor_=</span><span class="params">(<span name="assignArmor">assignArmor: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#AwayFromKeyboard" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AwayFromKeyboard:Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#AwayFromKeyboard: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">AwayFromKeyboard</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#AwayFromKeyboard_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AwayFromKeyboard_=(away:Boolean):Boolean"></a><a id="AwayFromKeyboard_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#AwayFromKeyboard_=(away: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: AwayFromKeyboard_$eq">AwayFromKeyboard_=</span><span class="params">(<span name="away">away: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#CanAccessBackpack" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CanAccessBackpack(player:net.psforever.objects.Player):Boolean"></a><a id="CanAccessBackpack(Player):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#CanAccessBackpack(player:net.psforever.objects.Player):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">CanAccessBackpack</span><span class="
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">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="" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</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>GridInventory.CheckCollisionsVar</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZoneAware#Continent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Continent:String"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Continent: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">Continent</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="zones/ZoneAware.html" name="net.psforever.objects.zones.ZoneAware" id="net.psforever.objects.zones.ZoneAware" class="extype">ZoneAware</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZoneAware#Continent_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Continent_=(zoneId:String):String"></a><a id="Continent_=(String):String"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Continent_=(zoneId:String):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" title="gt4s: Continent_$eq">Continent_=</span><span class="params">(<span name="zoneId">zoneId: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Predef.String" class="extype">String</span></span></span><p class="shortcomment cmt">Give the entity a custom <code>Zone</code> identifier.</p><div class="fullcomment"><div class="comment cmt"><p>Give the entity a custom <code>Zone</code> identifier.</p></div><dl class="paramcmts block"><dt class="param">zoneId</dt><dd class="cmt"><p>the custom identifier of the <code>Zone</code> object</p></dd><dt>returns</dt><dd class="cmt"><p>the identifier of the <code>Zone</code> object</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="zones/ZoneAware.html" name="net.psforever.objects.zones.ZoneAware" id="net.psforever.objects.zones.ZoneAware" class="extype">ZoneAware</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Player#Crouching" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Crouching:Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Crouching: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">Crouching</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#Crouching_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Crouching_=(crouched:Boolean):Boolean"></a><a id="Crouching_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Crouching_=(crouched:Boolean):Boolean" ti
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="" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a> → <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/Player.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.Player#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/Player.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="" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a> → <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/Player.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.Player#FreeHand" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="FreeHand:net.psforever.objects.equipment.EquipmentSlot"></a><a id="FreeHand:EquipmentSlot"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#FreeHand: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">FreeHand</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></li><li class="indented0 " name="net.psforever.objects.Player#FreeHand_=" group="Ungrouped" fullComment="no" data-isabs=
Add new entry to the front of the list (for recent activity).</p></div><dl class="paramcmts block"><dt class="param">action</dt><dd class="cmt"><p>the fully-informed entry</p></dd><dt>returns</dt><dd class="cmt"><p>the list of previous changes to this object's vital statistics</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.VitalsHistory#History" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="History(action:net.psforever.objects.vital.VitalsActivity):List[net.psforever.objects.vital.VitalsActivity]"></a><a id="History(VitalsActivity):List[VitalsActivity]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#History(action:net.psforever.objects.vital.VitalsActivity):List[net.psforever.objects.vital.VitalsActivity]" 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">History</span><span class="params">(<span name="action">action: <a href="vital/VitalsActivity.html" name="net.psforever.objects.vital.VitalsActivity" id="net.psforever.objects.vital.VitalsActivity" class="extype">VitalsActivity</a></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="vital/VitalsActivity.html" name="net.psforever.objects.vital.VitalsActivity" id="net.psforever.objects.vital.VitalsActivity" class="extype">VitalsActivity</a>]</span></span><p class="shortcomment cmt">A <code>VitalsActivity</code> event must be recorded.</p><div class="fullcomment"><div class="comment cmt"><p>A <code>VitalsActivity</code> event must be recorded.
Add new entry to the front of the list (for recent activity).</p></div><dl class="paramcmts block"><dt class="param">action</dt><dd class="cmt"><p>the fully-informed entry</p></dd><dt>returns</dt><dd class="cmt"><p>the list of previous changes to this object's vital statistics</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.VitalsHistory#History" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="History:List[net.psforever.objects.vital.VitalsActivity]"></a><a id="History:List[VitalsActivity]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#History:List[net.psforever.objects.vital.VitalsActivity]" 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">History</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="vital/VitalsActivity.html" name="net.psforever.objects.vital.VitalsActivity" id="net.psforever.objects.vital.VitalsActivity" class="extype">VitalsActivity</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Player#Holsters" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Holsters():Array[net.psforever.objects.equipment.EquipmentSlot]"></a><a id="Holsters():Array[EquipmentSlot]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Holsters():Array[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">Holsters</span><span class="params">()</span><span class="result">: <span name="scala.Array" class="extype">Array</span>[<a href="equipment/EquipmentSlot.html" name="net.psforever.objects.equipment.EquipmentSlot" id="net.psforever.objects.equipment.EquipmentSlot" class="extype">EquipmentSlot</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.entity.IdentifiableEntity#Invalidate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Invalidate():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.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="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.Player#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/Player.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.Player" id="net.psforever.objects.Player" class="extype">Player</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.equipment.JammableUnit#Jammed" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Jammed:Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Jammed: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">Jammed</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="equipment/JammableUnit.html" name="net.psforever.objects.equipment.JammableUnit" id="net.psforever.objects.equipment.JammableUnit" class="extype">JammableUnit</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableUnit#Jammed_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Jammed_=(state:Boolean):Boolean"></a><a id="Jammed_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Jammed_=(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: Jammed_$eq">Jammed_=</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="equipment/JammableUnit.html" name="net.psforever.objects.equipment.JammableUnit" id="net.psforever.objects.equipment.JammableUnit" class="extype">JammableUnit</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Player#Jumping" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Jumping:Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Jumping: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">Jumping</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#Jumping_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Jumping_=(jumped:Boolean):Boolean"></a><a id="Jumping_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Jumping_=(jumped: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: Jumping_$eq">Jumping_=</span><span class="params">(<span name="jumped">jumped: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#LastDrawnSlot" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LastDrawnSlot:Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#LastDrawnSlot:In
<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>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="" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</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>OffhandEquipmentSlot</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Player#Spawn" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Spawn():Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Spawn():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">Spawn</span><span class="params">()</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.Player#Subtract" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Subtract:net.psforever.objects.vital.damage.DamageProfile"></a><a id="Subtract:DamageProfile"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Subtract:net.psforever.objects.vital.damage.DamageProfile" 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">Subtract</span><span class="result">: <a href="vital/damage/DamageProfile.html" name="net.psforever.objects.vital.damage.DamageProfile" id="net.psforever.objects.vital.damage.DamageProfile" class="extype">DamageProfile</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a> → <a href="vital/resistance/ResistanceProfile.html" name="net.psforever.objects.vital.resistance.ResistanceProfile" id="net.psforever.objects.vital.resistance.ResistanceProfile" class="extype">ResistanceProfile</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Player#UsingSpecial" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UsingSpecial:net.psforever.objects.definition.SpecialExoSuitDefinition.Mode.Value"></a><a id="UsingSpecial:definition.SpecialExoSuitDefinition.Mode.Value"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#UsingSpecial:net.psforever.objects.definition.SpecialExoSuitDefinition.Mode.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">UsingSpecial</span><span class="result">: <a href="definition/SpecialExoSuitDefinition$$Mode$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.definition.SpecialExoSuitDefinition.Mode.Value" id="net.psforever.objects.definition.SpecialExoSuitDefinition.Mode.Value" class="extmbr">definition.SpecialExoSuitDefinition.Mode.Value</a></span></span></li><li class="indented0 " name="net.psforever.objects.Player#UsingSpecial_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UsingSpecial_=(state:net.psforever.objects.definition.SpecialExoSuitDefinition.Mode.Value):net.psforever.objects.definition.SpecialExoSuitDefinition.Mode.Value"></a><a id="UsingSpecial_=(definition.SpecialExoSuitDefinition.Mode.Value):definition.SpecialExoSuitDefinition.Mode.Value"></a> <span class="permalink"><a href="../../../net/psforever/objects/
<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.Player" id="net.psforever.objects.Player" class="extype">Player</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="net.psforever.objects.Player#Voice" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Voice:net.psforever.types.CharacterVoice.Value"></a><a id="Voice:types.CharacterVoice.Value"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Voice:net.psforever.types.CharacterVoice.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">Voice</span><span class="result">: <a href="../types/CharacterVoice$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.CharacterVoice.Value" id="net.psforever.types.CharacterVoice.Value" class="extmbr">types.CharacterVoice.Value</a></span></span></li><li class="indented0 " name="net.psforever.objects.zones.ZoneAware#Zone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Zone:net.psforever.objects.zones.Zone"></a><a id="Zone:Zone"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Zone:net.psforever.objects.zones.Zone" 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">Zone</span><span class="result">: <a href="zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="zones/ZoneAware.html" name="net.psforever.objects.zones.ZoneAware" id="net.psforever.objects.zones.ZoneAware" class="extype">ZoneAware</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZoneAware#Zone_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Zone_=(zone:net.psforever.objects.zones.Zone):net.psforever.objects.zones.Zone"></a><a id="Zone_=(Zone):Zone"></a> <span class="permalink"><a href="../../../net/psforever/objects/Player.html#Zone_=(zone:net.psforever.objects.zones.Zone):net.psforever.objects.zones.Zone" 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: Zone_$eq">Zone_=</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><span class="result">: <a href="zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span></span><p class="shortcomment cmt">When assigning a new <code>Zone</code> object for the <code>Vehicle</code> object, eliminate</p><div class="fullcomment"><div class="comment cmt"><p>When assigning a new <code>Zone</code> object for the <code>Vehicle</code> object, eliminate</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>a reference to the <code>Zone</code> object</p></dd><dt>returns</dt><dd class="cmt"><p>a reference to the <code>Zone</code> object</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="zones/ZoneAware.html" name="net.psforever.objects.zones.ZoneAware" id="net.psforever.objec
Reference in a new issue Copy permalink