PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-02 20:10:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/turret/WeaponTurret.html

40 lines
80 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.serverobject.turret.WeaponTurret</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.turret.WeaponTurret" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.turret.WeaponTurret" 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@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +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.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject"></a><a id="serverobject:serverobject"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a
Specifically, the <code>Actor</code> should intercept the logic of <code>MountableControl.</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="../mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>MountableControl</code></p></span><span class="cmt"><p><code>PlanetSideServerObject.Actor</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.turret.WeaponTurret#Definition" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="Definition:net.psforever.objects.serverobject.turret.TurretDefinition"></a><a id="Definition:TurretDefinition"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#Definition:net.psforever.objects.serverobject.turret.TurretDefinition" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Definition</span><span class="result">: <a href="TurretDefinition.html" name="net.psforever.objects.serverobject.turret.TurretDefinition" id="net.psforever.objects.serverobject.turret.TurretDefinition" class="extype">TurretDefinition</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.turret.WeaponTurret" id="net.psforever.objects.serverobject.turret.WeaponTurret" class="extype">WeaponTurret</a> → <a href="../../vehicles/MountableWeapons.html" name="net.psforever.objects.vehicles.MountableWeapons" id="net.psforever.objects.vehicles.MountableWeapons" class="extype">MountableWeapons</a> → <a href="../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></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.affinity.FactionAffinity#Faction" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="Faction:net.psforever.types.PlanetSideEmpire.Value"></a><a id="Faction:types.PlanetSideEmpire.Value"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#Faction:net.psforever.types.PlanetSideEmpire.Value" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Faction</span><span class="result">: <a href="../../../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.turret.WeaponTurret#Health" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="Health:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#Health:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span cl
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">index</dt><dd class="cmt"><p>the position to start searching</p></dd><dt class="param">width</dt><dd class="cmt"><p>the width of the searchable space</p></dd><dt class="param">height</dt><dd class="cmt"><p>the height of the serachable space</p></dd><dt>returns</dt><dd class="cmt"><p>a list of objects that have been encountered within the searchable space</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>GridInventory.CheckCollisionsVar</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.turret.WeaponTurret#ConfirmUpgrade" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ConfirmUpgrade(upgrade:net.psforever.objects.serverobject.turret.TurretUpgrade.Value):net.psforever.objects.serverobject.turret.TurretUpgrade.Value"></a><a id="ConfirmUpgrade(TurretUpgrade.Value):TurretUpgrade.Value"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#ConfirmUpgrade(upgrade:net.psforever.objects.serverobject.turret.TurretUpgrade.Value):net.psforever.objects.serverobject.turret.TurretUpgrade.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">ConfirmUpgrade</span><span class="params">(<span name="upgrade">upgrade: <a href="TurretUpgrade$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.serverobject.turret.TurretUpgrade.Value" id="net.psforever.objects.serverobject.turret.TurretUpgrade.Value" class="extmbr">TurretUpgrade.Value</a></span>)</span><span class="result">: <a href="TurretUpgrade$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.serverobject.turret.TurretUpgrade.Value" id="net.psforever.objects.serverobject.turret.TurretUpgrade.Value" class="extmbr">TurretUpgrade.Value</a></span></span></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/serverobject/turret/WeaponTurret.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" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a>]</span></span><div class="fullcomment"><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.serverobject.affinity.FactionAffinity#Faction_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Faction_=(fac:net.psforever.types.PlanetSideEmpire.Value):net.psforever.types.PlanetSideEmpire.Value"></a><a id="Faction_=(types.PlanetSideEmpire.Value):types.PlanetSideEmpire.Valu
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="../../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/serverobject/turret/WeaponTurret.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@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +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.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/serverobject/turret/WeaponTurret.html#Fit(tile:net.psforever.objects.inventory.InventoryTile):Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Fit</span><span class="params">(<span name="tile">tile: <a href="../../inventory/InventoryTile.html" name="net.psforever.objects.inventory.InventoryTile" id="net.psforever.objects.inventory.InventoryTile" class="extype">InventoryTile</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.inventory.Container#Fit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Fit(obj:net.psforever.objects.equipment.Equipment):Option[Int]"></a><a id="Fit(Equipment):Option[Int]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#Fit(obj:net.psforever.objects.equipment.Equipment):Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Fit</span><span class="params">(<span name="obj">obj: <a href="../../equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable#GetSeatFromMountPoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetSeatFromMountPoint(mountPoint:Int):Option[Int]"></a><a id="GetSeatFromMountPoint(Int):Option[Int]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#GetSeatFromMountPoint(mountPoint:Int):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">GetSeatFromMountPoint</span><span class="params">(<span name="mountPoint">mountPoint: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +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.serverobject.turret.WeaponTurret" id="net.psforever.objects.serverobject.turret.WeaponTurret" class="extype">WeaponTurret</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.serverobject.mount.Mountable#MountPoints" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MountPoints:Map[Int,net.psforever.objects.serverobject.mount.MountInfo]"></a><a id="MountPoints:Map[Int,MountInfo]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#MountPoints:Map[Int,net.psforever.objects.serverobject.mount.MountInfo]" 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">MountPoints</span><span class="result">: <span name="scala.Predef.Map" class="extype">Map</span>[<span name="scala.Int" class="extype">Int</span>, <a href="../mount/MountInfo.html" name="net.psforever.objects.serverobject.mount.MountInfo" id="net.psforever.objects.serverobject.mount.MountInfo" class="extype">MountInfo</a>]</span></span><p class="shortcomment cmt">Retrieve a mapping of each mount from its mount point index.</p><div class="fullcomment"><div class="comment cmt"><p>Retrieve a mapping of each mount from its mount point index.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the mapping of mount point to mount</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable#PassengerInSeat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PassengerInSeat(user:net.psforever.objects.Player):Option[Int]"></a><a id="PassengerInSeat(Player):Option[Int]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#PassengerInSeat(user:net.psforever.objects.Player):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">PassengerInSeat</span><span class="params">(<span name="user">user: <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>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Given a player, determine if that player is seated.</p><div class="fullcomment"><div class="comment cmt"><p>Given a player, determine if that player is seated.</p></div><dl class="paramcmts block"><dt class="param">user</dt><dd class="cmt"><p>the player</p></dd><dt>returns</dt><dd class="cmt"><p>the mount index</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable#Seat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Seat(seatNumber:Int):Option[net.psforever.objects.serverobject.mount.Seat]"></a><a id="Seat(Int):Option[Seat]">
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="../../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.inventory.Container#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/serverobject/turret/WeaponTurret.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="../../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.serverobject.turret.WeaponTurret#Upgrade" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Upgrade:net.psforever.objects.serverobject.turret.TurretUpgrade.Value"></a><a id="Upgrade:TurretUpgrade.Value"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#Upgrade:net.psforever.objects.serverobject.turret.TurretUpgrade.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">Upgrade</span><span class="result">: <a href="TurretUpgrade$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.serverobject.turret.TurretUpgrade.Value" id="net.psforever.objects.serverobject.turret.TurretUpgrade.Value" class="extmbr">TurretUpgrade.Value</a></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.turret.WeaponTurret#Upgrade_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Upgrade_=(upgrade:net.psforever.objects.serverobject.turret.TurretUpgrade.Value):net.psforever.objects.serverobject.turret.TurretUpgrade.Value"></a><a id="Upgrade_=(TurretUpgrade.Value):TurretUpgrade.Value"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#Upgrade_=(upgrade:net.psforever.objects.serverobject.turret.TurretUpgrade.Value):net.psforever.objects.serverobject.turret.TurretUpgrade.Value" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: Upgrade_$eq">Upgrade_=</span><span class="params">(<span name="upgrade">upgrade: <a href="TurretUpgrade$.html#ValueextendsOrdered[Enumeration.this.Value]
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.serverobject.turret.WeaponTurret" id="net.psforever.objects.serverobject.turret.WeaponTurret" class="extype">WeaponTurret</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/serverobject/turret/WeaponTurret.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/serverobject/turret/WeaponTurret.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="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="p
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
see <code>ReserveAmmunition</code> in the definition
</p><div class="fullcomment"><div class="comment cmt"><p>may or may not have inaccessible inventory space
see <code>ReserveAmmunition</code> in the definition
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
</p></div><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#isInstanceOf[T0]:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.turret.WeaponTurret#isUpgrading" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="isUpgrading:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#isUpgrading: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">isUpgrading</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#ne(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#notify():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/turret/WeaponTurret.html#notifyAll():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.Mountable#seats" group="Ungrouped" fullComment="ye
Reference in a new issue Copy permalink