PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-10 16:00:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/Vehicle.html

95 lines
280 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.Vehicle</title><meta content="PSF - LoginServer - master - net.psforever.objects.Vehicle" name="description"/><meta content="PSF LoginServer master net.psforever.objects.Vehicle" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
Deploying to gh-pages from @ psforever/PSF-LoginServer@0d8c717b73596f10a572598980c09db2fec647c7 🚀
2022-03-28 00:01:38 +00:00
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></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="
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<br>
All infantry seating, all mounted weapons, and the trunk space are considered part of the same index hierarchy.
Generally, all seating is declared first - the driver and passengers and and gunners.
Following that are the mounted weapons and other utilities.
Trunk space starts being indexed afterwards.
To keep it simple, infantry seating, mounted weapons, and utilities are stored separately herein.
The <code>Map</code> of <code>Utility</code> objects is given using the same inventory index positions.
Positive indices and zero are considered "represented" and must be assigned a globally unique identifier
and must be present in the containing vehicle's <code>ObjectCreateMessage</code> packet.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
The index is the mount position, reflecting the position in the zero-index inventory.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Negative indices are expected to be excluded from this conversion.
The value of the negative index does not have a specific meaning.<br>
<br>
The importance of a vehicle's owner can not be overlooked.
The owner is someone who can control who can sit in the vehicle's seats
either through broad categorization or discriminating selection ("kicking")
and who has access to and can allow access to the vehicle's trunk capacity.
The driver is the only player that can access a vehicle's saved loadouts through a repair/rearm silo
and can procure equipment from the said silo.
The owner of a vehicle and the driver of a vehicle as mostly interchangeable terms for this reason
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
and it can be summarized that the player who has access to the driver mount meets the qualifications for the "owner"
so long as that player is the last person to have sat in that mount.
All previous ownership information is replaced just as soon as someone else sits in the driver's mount.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Ownership is also transferred as players die and respawn (from and to the same client)
and when they leave a continent without taking the vehicle they currently own with them.
(They also lose ownership when they leave the game, of course.)<br>
<br>
All seats have vehicle-level properties on top of their own internal properties.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
A mount has a glyph projected onto the ground when the vehicle is not moving
that is used to mark where the mount can be accessed, as well as broadcasting the current access condition of the mount.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
As indicated previously, seats are composed into categories and the categories used to control access.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
The "driver" group has already been mentioned and is usually composed of a single mount, the "first" one.
The driver mount is typically locked to the person who can sit in it - the owner - unless manually unlocked.
Any mount besides the "driver" that has a weapon controlled from the mount is called a "gunner" seats.
Any other mount besides the "driver" mount and "gunner" seats is called a "passenger" mount.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
All of these seats are typically unlocked normally.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
The "trunk" also counts as an access group even though it is not directly attached to a mount and starts as "locked."
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
The categories all have their own glyphs,
sharing a red cross glyph as a "can not access" state,
and may also use their lack of visibility to express state.
Deploying to gh-pages from @ psforever/PSF-LoginServer@1e5e11be6b3a5e6980efc447e9b224d3223cdca5 🚀
2021-10-05 19:25:42 +00:00
In terms of individual access, each mount can have its current occupant ejected, save for the driver's mount.</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/Vehicle.scala" target="_blank">Vehicle.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>Vehicle.EquipmentUtilities</code></p></span></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="serverobject/mount/MountableEntity.html" name="net.psforever.objects.serverobject.mount.MountableEntity" id="net.psforever.objects.serverobject.mount.MountableEntity" class="extype">MountableEntity</a>, <a href="serverobject/aura/AuraContainer.html" name="net.psforever.objects.serverobject.aura.AuraContainer" id="net.psforever.objects.serverobject.aura.AuraContainer" class="extype">AuraContainer</a>, <a href="inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a>, <a href="CommonNtuContainer.html" name="net.psforever.objects.CommonNtuContainer" id="net.psforever.objects.CommonNtuContainer" class="extype">CommonNtuContainer</a>, <a href="NtuContainer.html" name="net.psforever.objects.NtuContainer" id="net.psforever.objects.NtuContainer" class="extype">NtuContainer</a>, <a href="serverobject/transfer/TransferContainer.html" name="net.psforever.objects.serverobject.transfer.TransferContainer" id="net.psforever.objects.serverobject.transfer.TransferContainer" class="extype">TransferContainer</a>, <a href="equipment/JammableUnit.html" name="net.psforever.objects.equipment.JammableUnit" id="net.psforever.objects.equipment.JammableUnit" class="extype">JammableUnit</a>, <a href="vital/resistance/StandardResistanceProfile.html" name="net.psforever.objects.vital.resistance.StandardResistanceProfile" id="net.psforever.objects.vital.resistance.StandardResistanceProfile" class="extype">StandardResistanceProfile</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>, <a href="OwnableByPlayer.html" name="net.psforever.objects.OwnableByPlayer" id="net.psforever.objects.OwnableByPlayer" class="extype">OwnableByPlayer</a>, <a href="vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a>, <a href="vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a>, <a href="serverobject/deploy/Deployment.html" name="net.psforever.objects.serverobject.deploy.Deployment" id="net.psforever.objects.serverobject.deploy.Deployment" class="extype">Deployment</a>, <a href="serverobject/hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a>, <a href="zones/InteractsWithZone.html" name="net.psforever.objects.zones.InteractsWithZone" id="net.psforever.objects.zones.InteractsWithZone" class="extype">InteractsWithZone</a>, <a href="vehicles/MountableWeapons.html" name="net.psforever.objects.vehicles.MountableWeapons" id="net.psforever.objects.vehicles.MountableWeapons" class="extype">MountableWeapons</a>, <a href="serverobject/mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a>, <a href="vehicles/MountedWeapons.html" name="net.psforever.objects.vehicles.MountedWeapons" id="net.psforever.objects.vehicles.MountedWeapons" class="extype">MountedWeapons</a>, <a href="zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" clas
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
stores and unloads pertinent information about the <code>Vehicle</code>'s configuration;
used in the initialization process (<code>loadVehicleDefinition</code>)</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/Vehicle.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/Vehicle.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/Vehicle.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.Vehicle#AccessingTrunk" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AccessingTrunk:Option[net.psforever.types.PlanetSideGUID]"></a><a id="AccessingTrunk:Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#AccessingTrunk: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">AccessingTrunk</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.Vehicle#AccessingTrunk_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AccessingTrunk_=(guid:Option[net.psforever.types.PlanetSideGUID]):Option[net.psforever.types.PlanetSideGUID]"></a><a id="AccessingTrunk_=(Option[PlanetSideGUID]):Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#AccessingTrunk_=(guid:Option[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="na
A player may only gain access to the trunk if no one else has access to the trunk 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 trunk</p></dd><dt>returns</dt><dd class="cmt"><p>the player who is currently allowed to access the trunk</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Vehicle#AccessingTrunk_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AccessingTrunk_=(guid:net.psforever.types.PlanetSideGUID):Option[net.psforever.types.PlanetSideGUID]"></a><a id="AccessingTrunk_=(PlanetSideGUID):Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#AccessingTrunk_=(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: AccessingTrunk_$eq">AccessingTrunk_=</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/Vehicle.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/Vehicle.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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@1e5e11be6b3a5e6980efc447e9b224d3223cdca5 🚀
2021-10-05 19:25:42 +00:00
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.serverobject.aura.AuraContainer#AddEffectToAura" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AddEffectToAura(effect:net.psforever.objects.serverobject.aura.Aura):Set[net.psforever.objects.serverobject.aura.Aura]"></a><a id="AddEffectToAura(Aura):Set[Aura]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#AddEffectToAura(effect:net.psforever.objects.serverobject.aura.Aura):Set[net.psforever.objects.serverobject.aura.Aura]" 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">AddEffectToAura</span><span class="params">(<span name="effect">effect: <a href="serverobject/aura/Aura.html" name="net.psforever.objects.serverobject.aura.Aura" id="net.psforever.objects.serverobject.aura.Aura" class="extype">Aura</a></span>)</span><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="serverobject/aura/Aura.html" name="net.psforever.objects.serverobject.aura.Aura" id="net.psforever.objects.serverobject.aura.Aura" class="extype">Aura</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/aura/AuraContainer.html" name="net.psforever.objects.serverobject.aura.AuraContainer" id="net.psforever.objects.serverobject.aura.AuraContainer" class="extype">AuraContainer</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.AmenityOwner#Amenities" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Amenities:List[net.psforever.objects.serverobject.structures.Amenity]"></a><a id="Amenities:List[Amenity]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#Amenities:List[net.psforever.objects.serverobject.structures.Amenity]" 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">Amenities</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="serverobject/structures/Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/structures/AmenityOwner.html" name="net.psforever.objects.serverobject.structures.AmenityOwner" id="net.psforever.objects.serverobject.structures.AmenityOwner" class="extype">AmenityOwner</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.AmenityOwner#Amenities_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Amenities_=(obj:net.psforever.objects.serverobject.structures.Amenity):List[net.psforever.objects.serverobject.structures.Amenity]"></a><a id="Amenities_=(Amenity):List[Amenity]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#Amenities_=(obj:net.psforever.objects.serverobject.structures.Amenity):List[net.psforever.objects.serverobject.structures.Amenity]" title="Permalink
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
(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.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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/Vehicle.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/Vehicle.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.vehicles.MountableWeapons#ControlledWeapon" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ControlledWeapon(wepNumber:Int):Set[net.psforever.objects.equipment.Equipment]"></a><a id="ControlledWeapon(Int):Set[Equipment]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#ControlledWeapon(wepNumber:Int):Set[net.psforever.objects.equipment.Equipment]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">ControlledWeapon</span><span class="params">(<span name="wepNumber">wepNumber: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="equipment/Equipment.html"
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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/Vehicle.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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
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.Vehicle#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/Vehicle.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.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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/Vehicle.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.Vehicle#Flying" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Flying:Option[Int]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#Flying: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">Flying</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.Vehicle#Flying_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Flying_=(isFlying:Option[Int]):Option[Int]"></a><a id="Flying_=(Option[Int]):Option[Int]"></a> <span class="permalink"><a href="../../../net/psforev
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Set the hack state if there is no current hack state.
Deploying to gh-pages from @ 151b201f06266558e243c0fbc17b311e39167dc8 🚀
2020-12-08 19:37:03 +00:00
Override the hack state with a new hack state if the new user has different faction affiliation.</p></div><dl class="paramcmts block"><dt class="param">agent</dt><dd class="cmt"><p>a <code>Player</code>, or no player</p></dd><dt>returns</dt><dd class="cmt"><p>the player hack entry</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.hackable.Hackable#HackedBy_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HackedBy_=(agent:net.psforever.objects.Player):Option[net.psforever.objects.serverobject.hackable.Hackable.HackInfo]"></a><a id="HackedBy_=(Player):Option[HackInfo]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#HackedBy_=(agent:net.psforever.objects.Player):Option[net.psforever.objects.serverobject.hackable.Hackable.HackInfo]" 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: HackedBy_$eq">HackedBy_=</span><span class="params">(<span name="agent">agent: <a href="Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="serverobject/hackable/Hackable$$HackInfo.html" name="net.psforever.objects.serverobject.hackable.Hackable.HackInfo" id="net.psforever.objects.serverobject.hackable.Hackable.HackInfo" class="extype">HackInfo</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.IdentifiableEntity#HasGUID" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HasGUID:Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.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="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.vital.Vitality#Health" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Health:Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#Health: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">Health</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><a href="vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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/Vehicle.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/Vehicle.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.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/Vehicle.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.Vehicle#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/Vehicle.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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
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.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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.Vehicle#JackingDuration" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="JackingDuration:Array[Int]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#JackingDuration:Array[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">JackingDuration</span><span class="result">: <span name="scala.Array" class="extype">Array</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">How long it takes to jack the vehicle in seconds, based on the hacker's certification level</p></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/Vehicle.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/Vehicle.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.vital.VitalsHistory#LastDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LastDamage:Option[net.psforever.objects.vital.interaction.DamageResult]"></a><a id="LastDamage:Option[DamageResult]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#LastDamage:Option[net.psforever.objects.vital.interaction.DamageResult]" 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">LastDamage</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="vital/interaction/DamageResult.html" name="net.psforever.objects.vital.interaction.DamageResult" id="net.psf
Deploying to gh-pages from @ psforever/PSF-LoginServer@9ce60e7effe6de7da7c62398ce93400ed7fe110a 🚀
2021-04-02 16:24:16 +00:00
<code>None</code>, if the group does not exist or the level of permission was not changed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Vehicle#PermissionGroup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PermissionGroup(group:Int):Option[net.psforever.objects.vehicles.VehicleLockState.Value]"></a><a id="PermissionGroup(Int):Option[vehicles.VehicleLockState.Value]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#PermissionGroup(group:Int):Option[net.psforever.objects.vehicles.VehicleLockState.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">PermissionGroup</span><span class="params">(<span name="group">group: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="vehicles/VehicleLockState$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.vehicles.VehicleLockState.Value" id="net.psforever.objects.vehicles.VehicleLockState.Value" class="extmbr">vehicles.VehicleLockState.Value</a>]</span></span><p class="shortcomment cmt">What are the access permissions for a position on this vehicle, seats or trunk?</p><div class="fullcomment"><div class="comment cmt"><p>What are the access permissions for a position on this vehicle, seats or trunk?</p></div><dl class="paramcmts block"><dt class="param">group</dt><dd class="cmt"><p>the group index</p></dd><dt>returns</dt><dd class="cmt"><p>what sort of access permission exist for this group</p></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/Vehicle.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/Vehicle.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.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
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="" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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.Vehicle#SlotMapResolution" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SlotMapResolution(slot:Int):Int"></a><a id="SlotMapResolution(Int):Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#SlotMapResolution(slot: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">SlotMapResolution</span><span class="params">(<span name="slot">slot: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">When the slot reported is not the slot requested, change the slot.</p><div class="fullcomment"><div class="comment cmt"><p>When the slot reported is not the slot requested, change the slot.</p></div><dl class="paramcmts block"><dt class="param">slot</dt><dd class="cmt"><p>the original slot index</p></dd><dt>returns</dt><dd class="cmt"><p>the modified slot index</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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.Vehicle#SubsystemMessages" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SubsystemMessages():List[net.psforever.packet.PlanetSideGamePacket]"></a><a id="SubsystemMessages():List[PlanetSideGamePacket]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#SubsystemMessages():List[net.psforever.packet.PlanetSideGamePacket]" 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">SubsystemMessages</span><span class="params">()</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../packet/PlanetSideGamePacket.html" name="net.psforever.packet.PlanetSideGamePacket" id="net.psforever.packet.PlanetSideGamePacket" class="extype">PlanetSideGamePacket</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.Vehicle#SubsystemStatus" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SubsystemStatus(sys:String):Option[Boolean]"></a><a id="SubsystemStatus(String):Option[Boolean]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#SubsystemStatus(sys:String):Option[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">SubsystemStatus</span><span class="params">(<span name="sys">sys: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Boolean" class="extype">Boolean</spa
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
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.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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.vehicles.MountableWeapons#WeaponControlledFromSeat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WeaponControlledFromSeat(seatNumber:Int):Set[net.psforever.objects.equipment.Equipment]"></a><a id="WeaponControlledFromSeat(Int):Set[Equipment]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#WeaponControlledFromSeat(seatNumber:Int):Set[net.psforever.objects.equipment.Equipment]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">WeaponControlledFromSeat</span><span class="params">(<span name="seatNumber">seatNumber: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a>]</span></span><p class="shortcomment cmt">Given a valid mount number, retrieve an index where the weapon controlled from this mount is mounted.</p><div class="fullcomment"><div class="comment cmt"><p>Given a valid mount number, retrieve an index where the weapon controlled from this mount is mounted.</p></div><dl class="paramcmts block"><dt class="param">seatNumber</dt><dd class="cmt"><p>the mount number</p></dd><dt>returns</dt><dd class="cmt"><p>a mounted weapon by index, or <code>None</code> if either the mount doesn't exist or there is no controlled weapon</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="vehicles/MountableWeapons.html" name="net.psforever.objects.vehicles.MountableWeapons" id="net.psforever.objects.vehicles.MountableWeapons" class="extype">MountableWeapons</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.MountedWeapons#Weapons" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Weapons:Map[Int,net.psforever.objects.equipment.EquipmentSlot]"></a><a id="Weapons:Map[Int,EquipmentSlot]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#Weapons:Map[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">Weapons</span><span class="result">: <span name="scala.Predef.Map" class="extype">Map</span>[<span name="scala.Int" class="extype">Int</span>, <a href="equipment/EquipmentSlot.html" name="net.psforever.objects.equipment.EquipmentSlot" id="net.psforever.objects.equipment.EquipmentSlot" class="extype">EquipmentSlot</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="vehicles/MountedWeapons.html" name="net.psforever.objects.vehicles.MountedWeapons" id="net.psforever.objects.vehicles.MountedWeapons" class="extype">MountedWeapons</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:net.psforever.objects.zones.Zone"></a><a id="Zone:Zone"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#Zone:net.psforever.objec
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="zones/InteractsWithZone.html" name="net.psforever.objects.zones.InteractsWithZone" id="net.psforever.objects.zones.InteractsWithZone" class="extype">InteractsWithZone</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.InteractsWithZone#allowInteraction_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="allowInteraction_=(permit:Boolean):Boolean"></a><a id="allowInteraction_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#allowInteraction_=(permit: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: allowInteraction_$eq">allowInteraction_=</span><span class="params">(<span name="permit">permit: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">If the interactive permissions of this entity change,
trigger a formal change to the interaction methodology.</p><div class="fullcomment"><div class="comment cmt"><p>If the interactive permissions of this entity change,
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
trigger a formal change to the interaction methodology.</p></div><dl class="paramcmts block"><dt class="param">permit</dt><dd class="cmt"><p>whether or not interaction is permitted</p></dd><dt>returns</dt><dd class="cmt"><p>whether or not interaction is permitted</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="zones/InteractsWithZone.html" name="net.psforever.objects.zones.InteractsWithZone" id="net.psforever.objects.zones.InteractsWithZone" class="extype">InteractsWithZone</a></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/Vehicle.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/Vehicle.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/Vehicle.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.obj
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
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/Vehicle.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.Vehicle#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.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><p class="shortcomment cmt">Override the string representation to provide additional information.</p><div class="fullcomment"><div class="comment cmt"><p>Override the string representation to provide additional information.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the string output</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</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/Vehicle.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
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;
Deploying to gh-pages from @ psforever/PSF-LoginServer@1e5e11be6b3a5e6980efc447e9b224d3223cdca5 🚀
2021-10-05 19:25:42 +00:00
<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/Vehicle.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/Vehicle.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/Vehicle.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><li class="indented0 " name="net.psforever.objects.vehicles.MountedWeapons#weapons" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="weapons:Map[Int,net.psforever.objects.equipment.EquipmentSlot]"></a><a id="weapons:Map[Int,EquipmentSlot]"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle.html#weapons:Map[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">val</span></span> <span class="symbol"><span class="name">weapons</span><span class="result">: <span name="scala.Predef.Map" class="extype">Map</span>[<span name="scala.Int" class="extype">Int</span>, <a href="equipment/EquipmentSlot.html" name="net.psforever.objects
Reference in a new issue Copy permalink