PSF-LoginServer/net/psforever/objects/ConstructionItem.html

20 lines
107 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.ConstructionItem</title><meta content="PSF - LoginServer - master - net.psforever.objects.ConstructionItem" name="description"/><meta content="PSF LoginServer master net.psforever.objects.ConstructionItem" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
<br>
Functionally, <code>ConstructionItem</code> objects resemble <code>Tool</code> objects that have fire mode state and alternate "ammunition."
Very much unlike <code>Tool</code> object counterparts, however,
the alternate "ammunition" is also a type of fire mode state
maintained in a two-dimensional grid of related states.
These states represent output products called deployables or, in the common vernacular, CE.
Also unlike <code>Tool</code> objects, whose ammunition is always available even when drawing the weapon is not permitted,
the different states are not all available if just the equipment itself is available.
Parameters along with these CE states
indicate whether the current output product is something the player is permitted to utilize.</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/ConstructionItem.scala" target="_blank">ConstructionItem.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="equipment/FireModeSwitch.html" name="net.psforever.objects.equipment.FireModeSwitch" id="net.psforever.objects.equipment.FireModeSwitch" class="extype">FireModeSwitch</a>[<a href="definition/ConstructionFireMode.html" name="net.psforever.objects.definition.ConstructionFireMode" id="net.psforever.objects.definition.ConstructionFireMode" class="extype">ConstructionFireMode</a>], <a href="equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a>, <a href="zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a>, <a href="serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a>, <a href="PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>, <a href="entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a>, <a href="entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a>, <a href="entity/Identifiable.html" name="net.psforever.objects.entity.Identifiable" id="net.psforever.objects.entity.Identifiable" class="extype">Identifiable</a>, <span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div><div class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="Telepad.html" name="net.psforever.objects.Telepad" id="net.psforever.objects.Telepad" class="extype">Telepad</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.objects.ConstructionItem"><span>ConstructionItem</span></li><li class="in" name="net.psforever.objects.equipment.FireModeSwitch"><span>FireModeSwitch</span></li><li class="in" name="net.psforever.objects.equipment.Equipment"><span>Equipment</span></li><li class="in" name="net.psforever.objects.zones.blockmap.BlockMapEntity"><span>BlockMapEntity</span></li><li class="in" name="net.psforever.objects.serverobject.affinity.FactionAffinity"><span>FactionAffinity</span></li><li class="in" name="net.psforever.objects.PlanetSideGameObject"><span>PlanetSideGameObject</span></li><li class="in" name="net.psforever.objects.entity.WorldEntity"><span>WorldEntity</span></li><li class="in" name="net.psforever.objects.entity.IdentifiableEntity"><span>IdentifiableEntity</span></li><li class="in" name="net.psforever.objects.entity.Identifiable"><span>Identifiable</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>A
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.ConstructionItem#ModePermissions" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ModePermissions:Set[net.psforever.objects.avatar.Certification]"></a><a id="ModePermissions:Set[Certification]"></a> <span class="permalink"><a href="../../../net/psforever/objects/ConstructionItem.html#ModePermissions:Set[net.psforever.objects.avatar.Certification]" 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">ModePermissions</span><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="avatar/Certification.html" name="net.psforever.objects.avatar.Certification" id="net.psforever.objects.avatar.Certification" class="extype">Certification</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.ConstructionItem#NextAmmoType" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NextAmmoType:net.psforever.objects.ce.DeployedItem.Value"></a><a id="NextAmmoType:ce.DeployedItem.Value"></a> <span class="permalink"><a href="../../../net/psforever/objects/ConstructionItem.html#NextAmmoType:net.psforever.objects.ce.DeployedItem.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">NextAmmoType</span><span class="result">: <a href="ce/DeployedItem$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.ce.DeployedItem.Value" id="net.psforever.objects.ce.DeployedItem.Value" class="extmbr">ce.DeployedItem.Value</a></span></span></li><li class="indented0 " name="net.psforever.objects.ConstructionItem#NextFireMode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NextFireMode:net.psforever.objects.definition.ConstructionFireMode"></a><a id="NextFireMode:ConstructionFireMode"></a> <span class="permalink"><a href="../../../net/psforever/objects/ConstructionItem.html#NextFireMode:net.psforever.objects.definition.ConstructionFireMode" 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">NextFireMode</span><span class="result">: <a href="definition/ConstructionFireMode.html" name="net.psforever.objects.definition.ConstructionFireMode" id="net.psforever.objects.definition.ConstructionFireMode" class="extype">ConstructionFireMode</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a><a href="equipment/FireModeSwitch.html" name="net.psforever.objects.equipment.FireModeSwitch" id="net.psforever.objects.equipment.FireModeSwitch" class="extype">FireModeSwitch</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Orientation" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Orientation:net.psforever.types.Vector3"></a><a id="Orientation:Vector3"></a> <span class="permalink"><a href="../../../net/psforever/objects/ConstructionItem.html#Orientation:net.psforever.types.Vector3" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Orientation</span><span class="result">: <a href="../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.
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/ConstructionItem.html#synchronized[T0](x$1:=&gt;T0):T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: =&gt; <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.Equipment#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../net/psforever/objects/ConstructionItem.html#toString():String" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">toString</span><span class="params">()</span><span class="result">: <span name="scala.Predef.String" class="extype">String</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a> → AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntity#updateBlockMapEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="updateBlockMapEntry(newCoords:net.psforever.types.Vector3):Boolean"></a><a id="updateBlockMapEntry(Vector3):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/ConstructionItem.html#updateBlockMapEntry(newCoords:net.psforever.types.Vector3):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">updateBlockMapEntry</span><span class="params">(<span name="newCoords">newCoords: <a href="../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Update the internal data's known coordinate position without changing representation on whatever blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Update the internal data's known coordinate position without changing representation on whatever blockmap.
Has the potential to cause major issues with the blockmap if used without external checks.</p></div><dl class="paramcmts block"><dt class="param">newCoords</dt><dd class="cmt"><p>the coordinate position</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the coordinates were updated;
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ConstructionItem.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/ConstructionItem.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/ConstructionItem.html#wait(x$1:Long):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="net.psforever.objects.equipment.FireModeSwitch" class="parent"><h3>Inherited from <a href="equipment/FireModeSwitch.html" name="net.psforever.objects.equipment.FireModeSwitch" id="net.psforever.objects.equipment.FireModeSwitch" class="extype">FireModeSwitch</a>[<a href="definition/ConstructionFireMode.html" name="net.psforever.objects.definition.ConstructionFireMode" id="net.psforever.objects.definition.ConstructionFireMode" class="extype">ConstructionFireMode</a>]</h3></div><div name="net.psforever.objects.equipment.Equipment" class="parent"><h3>Inherited from <a href="equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></h3></div