PSF-LoginServer/net/psforever/objects/serverobject/structures/index.html

14 lines
48 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.serverobject.structures</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.structures" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.structures" 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.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
<br>
Normal <code>PlanetSideServerObject</code> entities (server objects) tend to have properties that are completely internalized.</p><div class="fullcomment"><div class="comment cmt"><p>Amenities are elements of the game that belong to other elements of the game.<br>
<br>
Normal <code>PlanetSideServerObject</code> entities (server objects) tend to have properties that are completely internalized.
An <code>Amenity</code> is a server object that maintains a fixed association with another server object.
This association strips away at the internalization and redirects a reference to some properties somewhere else.
An <code>Amenity</code> object belongs to its <code>Owner</code> object;
the <code>Amenity</code> objects look to its <code>Owner</code> object for some of its properties.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AmenityOwner</code></p></span><span class="cmt"><p><code>FactionAffinity</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.AmenityDefinition" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="AmenityDefinitionextendsObjectDefinitionwithResistanceProfileMutatorswithDamageResistanceModelwithVitalityDefinition"></a><a id="AmenityDefinition:AmenityDefinition"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/AmenityDefinition.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="AmenityDefinition.html" title=""><span class="name">AmenityDefinition</span></a><span class="result"> extends <a href="../../definition/ObjectDefinition.html" name="net.psforever.objects.definition.ObjectDefinition" id="net.psforever.objects.definition.ObjectDefinition" class="extype">ObjectDefinition</a> with <a href="../../vital/resistance/ResistanceProfileMutators.html" name="net.psforever.objects.vital.resistance.ResistanceProfileMutators" id="net.psforever.objects.vital.resistance.ResistanceProfileMutators" class="extype">ResistanceProfileMutators</a> with <a href="../../vital/resolution/DamageResistanceModel.html" name="net.psforever.objects.vital.resolution.DamageResistanceModel" id="net.psforever.objects.vital.resolution.DamageResistanceModel" class="extype">DamageResistanceModel</a> with <a href="../../vital/VitalityDefinition.html" name="net.psforever.objects.vital.VitalityDefinition" id="net.psforever.objects.vital.VitalityDefinition" class="extype">VitalityDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.AmenityOwner" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="AmenityOwnerextendsPlanetSideServerObject"></a><a id="AmenityOwner:AmenityOwner"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/AmenityOwner.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="AmenityOwner.html" title="Amenities are elements of the game that belong to other elements of the game."><span class="name">AmenityOwner</span></a><span class="result"> extends <a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a></span></span><p class="shortcomment cmt">Amenities are elements of the game that belong to other elements of the game.</p><div class="fullcomment"><div class="comment cmt"><p>Amenities are elements of the game that belong to other elements of the game.
Their owners are also elements of the game, ones that understand that they belong to a specific <code>Zone</code> object.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>PlanetSideServerObject</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.AutoRepairStats" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AutoRepairStatsextendsProductwithSerializable"></a><a id="AutoRepairStats:AutoRepairStats"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/AutoRepairStats.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AutoRepairStats.html" title=""><span class="name">AutoRepairStats</span></a><span class="params">(<span name="amount">amount: <span name="scala.Float" class="extype">Float</span></span>, <span name="start">start: <span name="scala.Long" class="extype">Long</span></span>, <span name="repeat">repeat: <span name="scala.Long" class="extype">Long</span></span>, <span name="drain">drain: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BuildingextendsAmenityOwnerwithBlockMapEntity"></a><a id="Building:Building"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Building.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="Building.html" title=""><span class="name">Building</span></a><span class="result"> extends <a href="AmenityOwner.html" name="net.psforever.objects.serverobject.structures.AmenityOwner" id="net.psforever.objects.serverobject.structures.AmenityOwner" class="extype">AmenityOwner</a> with <a href="../../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.BuildingDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BuildingDefinitionextendsObjectDefinitionwithNtuContainerDefinitionwithSphereOfInfluence"></a><a id="BuildingDefinition:BuildingDefinition"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/BuildingDefinition.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="BuildingDefinition.html" title=""><span class="name">BuildingDefinition</span></a><span class="result"> extends <a href="../../definition/ObjectDefinition.html" name="net.psforever.objects.definition.ObjectDefinition" id="net.psforever.objects.definition.ObjectDefinition" class="extype">ObjectDefinition</a> with <a href="../../NtuContainerDefinition.html" name="net.psforever.objects.NtuContainerDefinition" id="net.psforever.objects.NtuContainerDefinition" class="extype">NtuContainerDefinition</a> with <a href="SphereOfInfluence.html" name="net.psforever.objects.serverobject.structures.SphereOfInfluence" id="net.psforever.objects.serverobject.structures.SphereOfInfluence" class="extype">SphereOfInfluence</a></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.FoundationBuilder" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FoundationBuilderextendsAnyRef"></a><a id="Fou
and a <code>context</code> in the proper <code>Actor</code> hierarchy of that zone exists in scope.</p><div class="fullcomment"><div class="comment cmt"><p>Defer establishment of a <code>Building</code> object until the location for the object is correct (in the correct zone)
and a <code>context</code> in the proper <code>Actor</code> hierarchy of that zone exists in scope.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ServerObjectBuilder</code></p></span><span class="cmt"><p><code>Building</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.PoweredAmenityControl" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="PoweredAmenityControlextendsActor"></a><a id="PoweredAmenityControl:PoweredAmenityControl"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/PoweredAmenityControl.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="PoweredAmenityControl.html" title=""><span class="name">PoweredAmenityControl</span></a><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.SphereOfInfluence" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SphereOfInfluenceextendsAnyRef"></a><a id="SphereOfInfluence:SphereOfInfluence"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/SphereOfInfluence.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="SphereOfInfluence.html" title=""><span class="name">SphereOfInfluence</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.StructureType" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="StructureTypeextendsEnumEntry"></a><a id="StructureType:StructureType"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/StructureType.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="StructureType.html" title=""><span class="name">StructureType</span></a><span class="result"> extends <span name="enumeratum.EnumEntry" class="extype">EnumEntry</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="WarpGateextendsBuildingwithNtuContainerwithSpawnPoint"></a><a id="WarpGate:WarpGate"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="WarpGate.html" title=""><span class="name">WarpGate</span></a><span class="result"> extends <a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a> with <a href="../../NtuContainer.html" name="net.psforever.objects.NtuContainer" id="net.psforever.objects.NtuContainer" class="extype">NtuContainer</a> with <a href="../../SpawnPoint.html" name="net.psforever.objects.SpawnPoint" id="net.psforever.objects.SpawnPoint" class="extype">SpawnPoint</a></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGateDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="WarpGateDefinitionextendsBuildingDefinitionwithSpawnPointDefinition"></a><a id="WarpGateDefinition:WarpGateDefinition"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGateDefinition.html" title