PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-12 19:31:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/structures/WarpGate.html

32 lines
132 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.structures.WarpGate</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.structures.WarpGate" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.structures.WarpGate" 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 @ d24fefaa913cd50a6417c48b8b484e7df1ec0595 🚀
2020-11-16 12:56:43 +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
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
For transportation of faction-opposed forces, use broadcast logic for that faction.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the warp gate can be used for transport;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate#Active_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Active_=(state:Boolean):Boolean"></a><a id="Active_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Active_=(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: Active_$eq">Active_=</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><p class="shortcomment cmt">Control whether a warp gate is usable for transporting faction-affiliated forces between other gates.</p><div class="fullcomment"><div class="comment cmt"><p>Control whether a warp gate is usable for transporting faction-affiliated forces between other gates.</p></div><dl class="paramcmts block"><dt class="param">state</dt><dd class="cmt"><p><code>true</code>, to activate the gate;
<code>false</code>, otherwise</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the gate is active;
<code>false</code>, otherwise</p></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:akka.actor.ActorRef"></a><a id="Actor:ActorRef"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.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="../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/serverobject/structures/WarpGate.html#Actor_=(control:akka.actor.ActorRef):akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: Actor_$eq">Actor_=</span><span class="params">(<span name="control">control: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><p class="shortcomment cmt">Assign an <code>Actor</code> to act for this server object.</p><div class="fullcomment"><div class="comment cmt"><p>Assign an <code>Actor</code> to act for this server object.
This reference is only set once, that is, as long as the internal <code>ActorRef</code> directs to <code>ActorRef.noSender</code> (<code>null</code>).</p></div><dl class="paramcmts block"><dt class="param">control</dt><dd class="cmt"><p>the <code>Actor</code> whose functionality will govern this server object</p></dd><dt>returns</dt><dd class="cmt"><p>the current internal <code>ActorRef</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../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.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/serverobject/structures/WarpGate.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="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="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/serverobject/structures/WarpGate.html#Amenities_=(obj:net.psforever.objects.serverobject.structures.Amenity):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" title="gt4s: Amenities_$eq">Amenities_=</span><span class="params">(<span name="obj">obj: <a href="Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="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="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.WarpGate#Broadcast" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Broadcast(faction:net.psforever.types.PlanetSideEmpire.Value):Boolean"></a><a id="Broadcast(types.PlanetSideEmpire.Value):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Broadcast(faction:net.psforever.types.PlanetSideEmpire.Value):Boolean" title="Permalink"><i class="material-icons"></i></
The warp gate being <code>NEUTRAL</code> should allow for any polled faction to interact.</p><div class="fullcomment"><div class="comment cmt"><p>Determine whether a specific faction interacts with this warp gate as "broadcast."
The warp gate being <code>NEUTRAL</code> should allow for any polled faction to interact.
The gate must be active first.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the given faction interacts with this warp gate as a "broadcast gate";
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate#Broadcast" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Broadcast:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Broadcast: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">Broadcast</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Determine whether any faction interacts with this warp gate as "broadcast."
The gate must be active first.</p><div class="fullcomment"><div class="comment cmt"><p>Determine whether any faction interacts with this warp gate as "broadcast."
The gate must be active first.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p><code>true</code>, if some faction sees this warp gate as a "broadcast gate";
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate#BroadcastFor" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BroadcastFor:Set[net.psforever.types.PlanetSideEmpire.Value]"></a><a id="BroadcastFor:Set[types.PlanetSideEmpire.Value]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#BroadcastFor:Set[net.psforever.types.PlanetSideEmpire.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">BroadcastFor</span><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<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><p class="shortcomment cmt">Which factions interact with this warp gate as "broadcast?"</p><div class="fullcomment"><div class="comment cmt"><p>Which factions interact with this warp gate as "broadcast?"</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the set of all factions who interact with this warp gate as "broadcast"</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate#BroadcastFor_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BroadcastFor_=(bcast:Set[net.psforever.types.PlanetSideEmpire.Value]):Set[net.psforever.types.PlanetSideEmpire.Value]"></a><a id="BroadcastFor_=(Set[types.PlanetSideEmpire.Value]):Set[types.PlanetSideEmpire.Value]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#BroadcastFor_=(bcast:Set[net.psforever.types.PlanetSideEmpire.Value]):Set[net.psforever.types.PlanetSideEmpire.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: BroadcastFor_$eq">BroadcastFor_=</span><span class="params">(<span name="bcast">bcast: <span name="scala.Predef.Set" class="extype">Set</span>[<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><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<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><p class="shortcomment cmt">Allow some factions to interact with a given warp gate as "broadcast" if it is active.</p><div class="fullcomment"><div class="comment cmt"><p>Allow some factions to interact with a given warp gate as "broadcast" if it is active.</p></div><dl class="paramcmts block"><dt class="param">bcast</dt><dd class="cmt"><p>the factions</p></dd><dt>returns</dt><dd class="cmt"><p>the set of all factions who interact with this warp gate as "broadcast"</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate#BroadcastFor_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BroadcastFor_=(bcast:net.psforever.types.PlanetSideEmpire.Value):Set[net.psforever.types.PlanetSideEmpire.Value]"></a><a id="BroadcastFor_=(types.PlanetSideEmpire.Value):Set[types.PlanetSideEmpire.Value]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#BroadcastFor_=(bcast:net.psforever.types.PlanetSide
Other "broadcast" associations are not affected.</p><div class="fullcomment"><div class="comment cmt"><p>Toggle whether the warp gate's faction-affiliated force interacts with this warp gate as "broadcast."
Other "broadcast" associations are not affected.
The gate must be active first.</p></div><dl class="paramcmts block"><dt class="param">bcast</dt><dd class="cmt"><p><code>true</code>, if the faction-affiliated force interacts with this gate as broadcast;
Deploying to gh-pages from @ psforever/PSF-LoginServer@ab354e49dfe90f91d6f212545d68267be5dea357 🚀
2021-02-27 12:34:19 +00:00
<code>false</code>, if not</p></dd><dt>returns</dt><dd class="cmt"><p>the set of all factions who interact with this warp gate as "broadcast"</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#BuildingType" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BuildingType:net.psforever.objects.serverobject.structures.StructureType"></a><a id="BuildingType:StructureType"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#BuildingType:net.psforever.objects.serverobject.structures.StructureType" 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">BuildingType</span><span class="result">: <a href="StructureType.html" name="net.psforever.objects.serverobject.structures.StructureType" id="net.psforever.objects.serverobject.structures.StructureType" class="extype">StructureType</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#CaptureTerminal" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CaptureTerminal:Option[net.psforever.objects.serverobject.terminals.capture.CaptureTerminal]"></a><a id="CaptureTerminal:Option[CaptureTerminal]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#CaptureTerminal:Option[net.psforever.objects.serverobject.terminals.capture.CaptureTerminal]" 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">CaptureTerminal</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../terminals/capture/CaptureTerminal.html" name="net.psforever.objects.serverobject.terminals.capture.CaptureTerminal" id="net.psforever.objects.serverobject.terminals.capture.CaptureTerminal" class="extype">CaptureTerminal</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#CaptureTerminalIsHacked" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CaptureTerminalIsHacked:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#CaptureTerminalIsHacked: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">CaptureTerminalIsHacked</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="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#Continent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Continent:String"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Continent:String" title="Permalink"><i class="material-icons"></i></a></span> <span class="modi
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
but, this makes it visible to a <code>SpawnPoint</code> object without casting.</p><div class="fullcomment"><div class="comment cmt"><p>An element of the contract of <code>PlanetSideServerObject</code>;
Deploying to gh-pages from @ psforever/PSF-LoginServer@9ce60e7effe6de7da7c62398ce93400ed7fe110a 🚀
2021-04-02 16:24:16 +00:00
but, this makes it visible to a <code>SpawnPoint</code> object without casting.</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.structures.WarpGate" id="net.psforever.objects.serverobject.structures.WarpGate" class="extype">WarpGate</a> → <a href="../../SpawnPoint.html" name="net.psforever.objects.SpawnPoint" id="net.psforever.objects.SpawnPoint" class="extype">SpawnPoint</a> → <a href="../../NtuContainer.html" name="net.psforever.objects.NtuContainer" id="net.psforever.objects.NtuContainer" class="extype">NtuContainer</a> → <a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a> → <a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>PlanetSideGameObject.Definition</code></p></span><span class="cmt"><p><code>SpecificPoint</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Destroyed" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Destroyed:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Destroyed: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">Destroyed</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="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Destroyed_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Destroyed_=(state:Boolean):Boolean"></a><a id="Destroyed_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Destroyed_=(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: Destroyed_$eq">Destroyed_=</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="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Entity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Entity:net.psforever.objects.entity.WorldEntity"></a><a id="Entity:WorldEntity"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Entity:net.psforever.objects.entity.WorldEntity" 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">Entity</span><span class="result">: <a href="../../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../PlanetSide
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@9ce60e7effe6de7da7c62398ce93400ed7fe110a 🚀
2021-04-02 16:24:16 +00:00
</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.serverobject.structures.Building#IsCapitol" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="IsCapitol:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#IsCapitol: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">IsCapitol</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="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#IsCtfBase" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="IsCtfBase:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#IsCtfBase: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">IsCtfBase</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="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#IsSubCapitol" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="IsSubCapitol:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#IsSubCapitol: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">IsSubCapitol</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="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#MapId" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MapId:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#MapId: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">MapId</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">The map_id is the identifier number used in BuildingInfoUpdateMessage.</p><div class="fullcomment"><div class="comment cmt"><p>The map_id is the identifier number used in BuildingInfoUpdateMessage. This is the index that the building appears in the MPO file starting from index 1
The GUID is the identifier number used in SetEmpireMessage / Facility hacking / PlanetSideAttributeMessage.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#Name" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Name:String"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Name: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">Name</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="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#Neighbours" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Neighbours(faction:net.psforever.types.PlanetSideEmpire.Value):Option[Set[net.psforever.objects.serverobject.structures.Building]]"></a><a id="Neighbours(types.PlanetSideEmpire.Value):Option[Set[Building]]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Neighbours(faction:net.psforever.types.PlanetSideEmpire.Value):Option[Set[net.psforever.objects.serverobject.structures.Building]]" 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">Neighbours</span><span class="params">(<span name="faction">faction: <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><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Predef.Set" class="extype">Set</span>[<a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a>]]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#Neighbours" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Neighbours:Option[Set[net.psforever.objects.serverobject.structures.Building]]"></a><a id="Neighbours:Option[Set[Building]]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#Neighbours:Option[Set[net.psforever.objects.serverobject.structures.Building]]" 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">Neighbours</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Predef.Set" class="extype">Set</span>[<a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a>]]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Building.html" name="net.psforever.objects.serverobject.stru
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
While not all <code>SpawnPoint</code> objects will be <code>Amenity</code> objects, a subclass of the <code>PlanetSideServerObject</code> class,
they will all promote having an object owner, or "parent."
Deploying to gh-pages from @ psforever/PSF-LoginServer@9ce60e7effe6de7da7c62398ce93400ed7fe110a 🚀
2021-04-02 16:24:16 +00:00
This should generally be themselves.</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.structures.WarpGate" id="net.psforever.objects.serverobject.structures.WarpGate" class="extype">WarpGate</a> → <a href="../../SpawnPoint.html" name="net.psforever.objects.SpawnPoint" id="net.psforever.objects.SpawnPoint" class="extype">SpawnPoint</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>Amenity.Owner</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#PlayersInSOI" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayersInSOI:List[net.psforever.objects.Player]"></a><a id="PlayersInSOI:List[Player]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#PlayersInSOI:List[net.psforever.objects.Player]" 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">PlayersInSOI</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Building#PlayersInSOI_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayersInSOI_=(list:List[net.psforever.objects.Player]):List[net.psforever.objects.Player]"></a><a id="PlayersInSOI_=(List[Player]):List[Player]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#PlayersInSOI_=(list:List[net.psforever.objects.Player]):List[net.psforever.objects.Player]" 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: PlayersInSOI_$eq">PlayersInSOI_=</span><span class="params">(<span name="list">list: <span name="scala.List" class="extype">List</span>[<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.List" class="extype">List</span>[<a href="../../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</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:net.psforever.types.Vector3"></a><a id="Position:Vector3"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.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.psfor
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
the first represents the game world position of spawning;
Deploying to gh-pages from @ d24fefaa913cd50a6417c48b8b484e7df1ec0595 🚀
2020-11-16 12:56:43 +00:00
the second represents the game world direction of spawning</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../SpawnPoint.html" name="net.psforever.objects.SpawnPoint" id="net.psforever.objects.SpawnPoint" class="extype">SpawnPoint</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate#StopBroadcastFor_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StopBroadcastFor_=(bcast:Set[net.psforever.types.PlanetSideEmpire.Value]):Set[net.psforever.types.PlanetSideEmpire.Value]"></a><a id="StopBroadcastFor_=(Set[types.PlanetSideEmpire.Value]):Set[types.PlanetSideEmpire.Value]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#StopBroadcastFor_=(bcast:Set[net.psforever.types.PlanetSideEmpire.Value]):Set[net.psforever.types.PlanetSideEmpire.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: StopBroadcastFor_$eq">StopBroadcastFor_=</span><span class="params">(<span name="bcast">bcast: <span name="scala.Predef.Set" class="extype">Set</span>[<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><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<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><p class="shortcomment cmt">Disallow some factions to interact with a given warp gate as "broadcast."</p><div class="fullcomment"><div class="comment cmt"><p>Disallow some factions to interact with a given warp gate as "broadcast."</p></div><dl class="paramcmts block"><dt class="param">bcast</dt><dd class="cmt"><p>the factions</p></dd><dt>returns</dt><dd class="cmt"><p>the set of all factions who interact with this warp gate as "broadcast"</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.WarpGate#StopBroadcastFor_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StopBroadcastFor_=(bcast:net.psforever.types.PlanetSideEmpire.Value):Set[net.psforever.types.PlanetSideEmpire.Value]"></a><a id="StopBroadcastFor_=(types.PlanetSideEmpire.Value):Set[types.PlanetSideEmpire.Value]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/WarpGate.html#StopBroadcastFor_=(bcast:net.psforever.types.PlanetSideEmpire.Value):Set[net.psforever.types.PlanetSideEmpire.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: StopBroadcastFor_$eq">StopBroadcastFor_=</span><span class="params">(<span name="bcast">bcast: <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><span class="result">: <span name="scala.Predef.Set" class="extype">Set</span>[<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><p class="shortcomment cmt">Disallow a faction to interact with a given warp gate as "broadcast."</p><div class="fullcomment"><div class="comment cmt"><p>Disallow a fa
Reference in a new issue Copy permalink