mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-03-22 13:50:44 +00:00
70 lines
66 KiB
HTML
70 lines
66 KiB
HTML
|
<!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.services.CavernRotationService</title><meta content="PSF - LoginServer - master - net.psforever.services.CavernRotationService" name="description"/><meta content="PSF LoginServer master net.psforever.services.CavernRotationService" 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"><</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.services" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="services"></a><a id="services:services"></a> <span class="permalink"><a href="../../../net/psforever/services/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">services</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.services.account" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="account"></a><a id="account:account"></a> <span class="permalink"><a href="../../../net/psforever/services/account/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="account/index.html" title=""><span class="name">account</span></a></span><div class="fullcomme
|
||
|
|
through the manipulation of connections between transmit point structures.<br>
|
||
|
|
<br>
|
||
|
|
The caverns were a group of game zones that were intended to be situated underground.
|
||
|
|
Access to the caverns was only sometimes possible
|
||
|
|
through the use of special above-ground warp gates called geowarps (geowarp gates)
|
||
|
|
and those geowarps were not always functional.
|
||
|
|
Usually, two caverns were available at a time and connections to these caverns were fixed
|
||
|
|
to specific active geowarp gates.
|
||
|
|
The changing availability of the caverns through the change of geowarp gate activity
|
||
|
|
was colloquially referred to as a "rotation" since it followed a predictable cycle.
|
||
|
|
The cycle was not just one of time but one of route
|
||
|
|
as one specific geowarp gates would open to the same destination cavern.<br>
|
||
|
|
<br>
|
||
|
|
The client controls warp gate destinations.
|
||
|
|
The server can only confirm those destinations.
|
||
|
|
The connectivity of a geowarp gate to a cavern warp gate had to have been determined
|
||
|
|
by opening the cavern with an appropriate packet
|
||
|
|
and checking the map description of the cavern gates.
|
||
|
|
The description text explains which of the geowarp gates in whichever zone has been connected; and,
|
||
|
|
where usually static and inanimate, that geowarp gate will bubble online and begin to rotate
|
||
|
|
and have a complementary destination map description.
|
||
|
|
Opening different combinations of caverns changes the destination these warp gate pairs will connect
|
||
|
|
and not always being connected at all.
|
||
|
|
The warp gate pairs for the cavern connections must be re-evaluated for each combination and with each rotation
|
||
|
|
and all relevant pairings must be defined in advance.</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/services/CavernRotationService.scala" target="_blank">CavernRotationService.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>ActorContext</code></p></span><span class="cmt"><p><code>Building</code></p></span><span class="cmt"><p><code>ChatMsg</code></p></span><span class="cmt"><p><code>Config.app.game.cavernRotation</code></p></span><span class="cmt"><p><code>GalaxyService</code></p></span><span class="cmt"><p><code>GalaxyAction.LockedZoneUpdate</code></p></span><span class="cmt"><p><code>GalaxyResponse.UnlockedZoneUpdate</code></p></span><span class="cmt"><p><code>InterstellarClusterService</code></p></span><span class="cmt"><p><code>org.log4s.getLogger</code></p></span><span class="cmt"><p><code>resources/zonemaps/lattice.json</code></p></span><span class="cmt"><p><code>SessionActor</code></p></span><span class="cmt"><p><code>SessionActor.SendResponse</code></p></span><span class="cmt"><p><code>StashBuffer</code></p></span><span class="cmt"><p><code>WarpGate</code></p></span><span class="cmt"><p><code>Zone</code></p></span><span class="cmt"><p><code>ZoneForcedCavernConnectionsMessage</code></p></span><span class="cmt"><p><code>ZoneInfoMessage</code></p></span></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></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.services.CavernRotationService"><span>CavernRotationService</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.services.CavernRotationService#<init>" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="<init>(context:akka.actor.typed.scaladsl.ActorContext[net.psforever.services.CavernRotationService.Command],buffer:akka.actor.typed.scaladsl.StashBuffer[net.psforever.services.CavernRotationService.Command]):net.psforever.services.CavernRotationService"></a><a id="<init>:CavernRotationService"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#<init>(context:akka.actor.typed.scaladsl.ActorContext[net.psforever.services.CavernRotationService.Command],buffer:akka.actor.typed.scaladsl.StashBuffer[net.psforever.services.CavernRotationService.Command]):net.psforever.services.CavernRotationService" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">CavernRotationService</span><span class="params">(<span name="context">context: <span name="akka.actor.typed.scaladsl
|
||
|
|
<br>
|
||
|
|
If the time until the next rotation is greater than the time where the cavern closing warning would be displayed,
|
||
|
|
progress to that final cavern closing warning.</p><div class="fullcomment"><div class="comment cmt"><p>Progress to the next significant cavern rotation event.<br>
|
||
|
|
<br>
|
||
|
|
If the time until the next rotation is greater than the time where the cavern closing warning would be displayed,
|
||
|
|
progress to that final cavern closing warning.
|
||
|
|
Adjust the timing for that advancement.
|
||
|
|
If the final cavern closing warning was already displayed,
|
||
|
|
just perform the cavern rotation.</p></div><dl class="paramcmts block"><dt class="param">galaxyService</dt><dd class="cmt"><p>callback to update the server and clients;
|
||
|
|
should be the reference to <code>GalaxyService</code>, hence the literal name</p></dd><dt class="param">forcedRotationOverride</dt><dd class="cmt"><p>force a cavern rotation in a case where a closing warning would be displayed instead</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GalaxyService</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.CavernRotationService#hurryRotationToZoneLock" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hurryRotationToZoneLock(zoneid:String,galaxyService:akka.actor.ActorRef):Boolean"></a><a id="hurryRotationToZoneLock(String,ActorRef):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#hurryRotationToZoneLock(zoneid:String,galaxyService:akka.actor.ActorRef):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">hurryRotationToZoneLock</span><span class="params">(<span name="zoneid">zoneid: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="galaxyService">galaxyService: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">zoneid</dt><dd class="cmt"><p>zone to lock next</p></dd><dt class="param">galaxyService</dt><dd class="cmt"><p>callback to update the server and clients;
|
||
|
|
should be the reference to <code>GalaxyService</code>, hence the literal name</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the target zone is locked when complete;
|
||
|
|
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GalaxyService</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.CavernRotationService#hurryRotationToZoneUnlock" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hurryRotationToZoneUnlock(zoneid:String,galaxyService:akka.actor.ActorRef):Boolean"></a><a id="hurryRotationToZoneUnlock(String,ActorRef):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#hurryRotationToZoneUnlock(zoneid:String,galaxyService:akka.actor.ActorRef):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">hurryRotationToZoneUnlock</span><span class="params">(<span name="zoneid">zoneid: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="galaxyService">galaxyService: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">zoneid</dt><dd class="cmt"><p>zone to unlock next</p></dd><dt class="param">galaxyService</dt><dd class="cmt"><p>callback to update the server and clients;
|
||
|
|
should be the reference to <code>GalaxyService</code>, hence the literal name</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the target zone is unlocked when complete;
|
||
|
|
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GalaxyService</code></p></span></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/services/CavernRotationService.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.services.CavernRotationService#lockTimer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="lockTimer:akka.actor.Cancellable"></a><a id="lockTimer:Cancellable"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#lockTimer:akka.actor.Cancellable" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">lockTimer</span><span class="result">: <span name="akka.actor.Cancellable" class="extype">Cancellable</span></span></span><p class="shortcomment cmt">timer for cavern rotation - the cavern closing warning</p></li><li class="indented0 " name="net.psforever.services.CavernRotationService#lockTimerToDisplayWarning" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="lockTimerToDisplayWarning(duration:scala.concurrent.duration.FiniteDuration,counter:Int):Unit"></a><a id="lockTimerToDisplayWarning(FiniteDuration,Int):Unit"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#lockTimerToDisplayWarning(duration:scala.concurrent.duration.FiniteDuration,counter:Int):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">lockTimerToDisplayWarning</span><span class="params">(<span name="duration">duration: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span>, <span name="counter">counter: <span name="scala.Int" class="extype">Int</span> = <span class="symbol"><span class="name"><a href="#firstClosingWarningAtMinutes:Int">firstClosingWarningAtMinutes</a></span></span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Update the timer for the cavern closing message.</p><div class="fullcomment"><div class="comment cmt"><p>Update the timer for the cavern closing message.</p></div><dl class="paramcmts block"><dt class="param">duration</dt><dd class="cmt"><p>new time until message display</p></dd><dt class="param">counter</dt><dd class="cmt"><p>the counter that indicates the next message to display</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.CavernRotationService#manageCaverns" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="manageCaverns(zones:Seq[net.psforever.objects.zones.Zone]):Boolean"></a><a id="manageCaverns(Seq[Zone]):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#manageCaverns(zones:Seq[net.psforever.objects.zones.Zone]):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">manageCaverns</span><span class="params">(<span name="zones">zones: <span name="scala.Seq"
|
||
|
|
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.CavernRotationService#managedZones" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="managedZones:List[net.psforever.services.CavernRotationService.ZoneMonitor]"></a><a id="managedZones:List[ZoneMonitor]"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#managedZones:List[net.psforever.services.CavernRotationService.ZoneMonitor]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">managedZones</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="CavernRotationService$$ZoneMonitor.html" name="net.psforever.services.CavernRotationService.ZoneMonitor" id="net.psforever.services.CavernRotationService.ZoneMonitor" class="extype">ZoneMonitor</a>]</span></span><p class="shortcomment cmt">monitors for the cavern zones</p></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/services/CavernRotationService.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="net.psforever.services.CavernRotationService#nextToLock" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="nextToLock:Int"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#nextToLock:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">nextToLock</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">index of the next cavern that will lock</p></li><li class="indented0 " name="net.psforever.services.CavernRotationService#nextToUnlock" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="nextToUnlock:Int"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#nextToUnlock:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">nextToUnlock</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">index of the next cavern that will unlock</p></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/services/CavernRotationService.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
|
||
|
|
advance the previous start time of each zone monitor to give the impression of the hastened rotation.</p><div class="fullcomment"><div class="comment cmt"><p>If the natural process of switching between caverns is hurried,
|
||
|
|
advance the previous start time of each zone monitor to give the impression of the hastened rotation.
|
||
|
|
This does not actually affect the functional timers
|
||
|
|
nor is it in response to an actual zone rotation event.
|
||
|
|
It only affects the backup parameters of the timers that are maintained by the zone monitors.</p></div><dl class="paramcmts block"><dt class="param">advanceTimeBy</dt><dd class="cmt"><p>amount of time advancement</p></dd><dt class="param">galaxyService</dt><dd class="cmt"><p>callback to update the zone timers;
|
||
|
|
should be the reference to <code>GalaxyService</code>, hence the literal name</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GalaxyService</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.CavernRotationService#retimeZonesUponForcedRotation" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="retimeZonesUponForcedRotation(galaxyService:akka.actor.ActorRef):Unit"></a><a id="retimeZonesUponForcedRotation(ActorRef):Unit"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#retimeZonesUponForcedRotation(galaxyService:akka.actor.ActorRef):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">retimeZonesUponForcedRotation</span><span class="params">(<span name="galaxyService">galaxyService: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">If the zones are forced to rotate before the timer would normally complete,
|
||
|
|
correct all of the zone monitors to give the impression of the rotation that occurred.</p><div class="fullcomment"><div class="comment cmt"><p>If the zones are forced to rotate before the timer would normally complete,
|
||
|
|
correct all of the zone monitors to give the impression of the rotation that occurred.
|
||
|
|
Only affect the backup parameters of the timers that are maintained by the zone monitors.
|
||
|
|
Do not actually affect the functional timers.</p></div><dl class="paramcmts block"><dt class="param">galaxyService</dt><dd class="cmt"><p>callback to update the zone timers;
|
||
|
|
should be the reference to <code>GalaxyService</code>, hence the literal name</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GalaxyService</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.CavernRotationService#sendCavernRotationUpdates" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sendCavernRotationUpdates(sendToSession:akka.actor.ActorRef):Unit"></a><a id="sendCavernRotationUpdates(ActorRef):Unit"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#sendCavernRotationUpdates(sendToSession:akka.actor.ActorRef):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendCavernRotationUpdates</span><span class="params">(<span name="sendToSession">sendToSession: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">sendToSession</dt><dd class="cmt"><p>callback reference</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.CavernRotationService#simultaneousUnlockedZones" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="simultaneousUnlockedZones:Int"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#simultaneousUnlockedZones:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">simultaneousUnlockedZones</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.services.CavernRotationService#start" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="start():akka.actor.typed.Behavior[net.psforever.services.CavernRotationService.Command]"></a><a id="start():Behavior[Command]"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#start():akka.actor.typed.Behavior[net.psforever.services.CavernRotationService.Command]" 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">start</span><span class="params">()</span><span class="result">: <span name="akka.actor.typed.Behavior" class="extype">Behavior</span>[<a href="CavernRotationService$$Command.html" name="net.psforever.services.CavernRotationService.Command" id="net.psforever.services.CavernRotationService.Command" class="extype">Command</a>]</span></span></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](=>T0):T0"></a> <span class="permalink"><a href="../../../net/psforever/services/CavernRotationService.html#synchronized[T0](x$1:=>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: => <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.services.CavernRotationService#timeBetwee
|
||
|
|
<br>
|
||
|
|
The process of zone rotation occurs by having a zone that is determined to be closing
|
||
|
|
and a zone that is determied to be opening
|
||
|
|
and a potential series of zones "in between" the two that are also open.</p><div class="fullcomment"><div class="comment cmt"><p>Actually perform zone rotation as determined by the managed zone monitors and the timers.<br>
|
||
|
|
<br>
|
||
|
|
The process of zone rotation occurs by having a zone that is determined to be closing
|
||
|
|
and a zone that is determied to be opening
|
||
|
|
and a potential series of zones "in between" the two that are also open.
|
||
|
|
All of the currently opened zones are locked and the zone to be permanently closed is forgotten.
|
||
|
|
The zone that should be opening is added to the aforementioned sequence of zones
|
||
|
|
and then the zones in that sequence are opened.
|
||
|
|
The zones that would otherwise be unaffected by a single zone opening and a single cone closing must be affected
|
||
|
|
because the cavern gates will not connect to the same geowarp gates with the change in the sequence.
|
||
|
|
After the rotation, the indices to the next closing zone and next opening zone are updated.
|
||
|
|
Modifying the zone monitor timekeeping and the actual timers and the indices are the easy parts.</p></div><dl class="paramcmts block"><dt class="param">galaxyService</dt><dd class="cmt"><p>callback to update the server and clients;
|
||
|
|
should be the reference to <code>GalaxyService</code>, hence the literal name</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GalaxyService</code></p></span></dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="scala.AnyRef" class="parent"><h3>Inherited from <span name="scala.AnyRef" class="extype">AnyRef</span></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3></div></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
|