PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-22 05:40:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/services/hart/HartTimer$.html

11 lines
47 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +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.services.hart.HartTimer</title><meta content="PSF - LoginServer - master - net.psforever.services.hart.HartTimer" name="description"/><meta content="PSF LoginServer master net.psforever.services.hart.HartTimer" 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.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.hart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hart"></a><a id="hart:hart"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/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">hart</span></a></span><div
to relay instructions back to the individual facility amenity portions of this HART system.</p><div class="fullcomment"><div class="comment cmt"><p>Design for the envelop for the message bus
to relay instructions back to the individual facility amenity portions of this HART system.
The channel is blank because it does not need special designation.
</p></div></div></li><li class="indented0 " name="net.psforever.services.hart.HartTimer.MessageToHartInZone" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="MessageToHartInZoneextendsAnyRef"></a><a id="MessageToHartInZone:MessageToHartInZone"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$$MessageToHartInZone.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="HartTimer$$MessageToHartInZone.html" title=""><span class="name">MessageToHartInZone</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></li><li class="indented0 " name="net.psforever.services.hart.HartTimer.OrbitalShuttleEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OrbitalShuttleEventextendsProductwithSerializable"></a><a id="OrbitalShuttleEvent:OrbitalShuttleEvent"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$$OrbitalShuttleEvent.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="HartTimer$$OrbitalShuttleEvent.html" title="Data structure for passing information about the event to client-local space."><span class="name">OrbitalShuttleEvent</span></a><span class="params">(<span name="u1">u1: <a href="../../types/HartSequence.html" name="net.psforever.types.HartSequence" id="net.psforever.types.HartSequence" class="extype">HartSequence</a></span>, <span name="u2">u2: <span name="scala.Int" class="extype">Int</span></span>, <span name="t1">t1: <span name="scala.Long" class="extype">Long</span></span>, <span name="t2">t2: <span name="scala.Long" class="extype">Long</span></span>, <span name="t3">t3: <span name="scala.Long" class="extype">Long</span></span>, <span name="pairs">pairs: <span name="scala.List" class="extype">List</span>[((<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>, <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>), <span name="scala.Int" class="extype">Int</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><p class="shortcomment cmt">Data structure for passing information about the event to client-local space.</p><div class="fullcomment"><div class="comment cmt"><p>Data structure for passing information about the event to client-local space.
The fields match the <code>OrbitalShuttleTimeMsg</code> packet that is created using this data.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>OrbitalShuttleTimeMsg</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.hart.HartTimer.PairWith" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PairWithextendsProductwithSerializable"></a><a id="PairWith:PairWith"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$$PairWith.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="HartTimer$$PairWith.html" title="Append information about a building amenity and shuttle combination in this zone."><span class="name">PairWith</span></a><span class="params">(<span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>, <span name="pad">pad: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="shuttle">shuttle: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="from">from: <span name="akka.actor.ActorRef" class="extype">ActorRef</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><p class="shortcomment cmt">Append information about a building amenity and shuttle combination in this zone.</p><div class="fullcomment"><div class="comment cmt"><p>Append information about a building amenity and shuttle combination in this zone.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>the relevant zone</p></dd><dt class="param">pad</dt><dd class="cmt"><p>the orbital shuttle pad (<code>obbasemesh</code>)</p></dd><dt class="param">shuttle</dt><dd class="cmt"><p>the orbital shuttle</p></dd><dt class="param">from</dt><dd class="cmt"><p>the control agency of the pad</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.hart.HartTimer.SetEventDurations" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SetEventDurationsextendsHartTimer.MessageToHartInZonewithProductwithSerializable"></a><a id="SetEventDurations:SetEventDurations"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$$SetEventDurations.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="HartTimer$$SetEventDurations.html" title=""><span class="name">SetEventDurations</span></a><span class="params">(<span name="inZone">inZone: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="away">away: <span name="scala.Long" class="extype">Long</span></span>, <span name="boarding">boarding: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result"> extends <a href="HartTimer$$MessageToHartInZone.html" name="net.psforever.services.hart.HartTimer.MessageToHartInZone" id="net.psforever.services.hart.HartTimer.MessageToHartInZone" class="extype">MessageToHartInZone</a> with <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.services.hart.HartTimer.ShuttleDocked" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ShuttleDockedextendsHartTimer.CommandwithProductwithSerializable"></a><a id="ShuttleDocked:ShuttleDocked"></a> <span class="permalink"><
This state is to be loaded into the <code>flying</code> field.</p></div><dl class="paramcmts block"><dt class="param">state</dt><dd class="cmt"><p>shuttle state, probably more symbolic of a gvien state than anything else</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>VehicleStateMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.hart.HartTimer.Update" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateextendsHartTimer.MessageToHartInZonewithProductwithSerializable"></a><a id="Update:Update"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$$Update.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="HartTimer$$Update.html" title="Personalized messages that align the state of the shuttle to one's perspective (client)."><span class="name">Update</span></a><span class="params">(<span name="inZone">inZone: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="forChannel">forChannel: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result"> extends <a href="HartTimer$$MessageToHartInZone.html" name="net.psforever.services.hart.HartTimer.MessageToHartInZone" id="net.psforever.services.hart.HartTimer.MessageToHartInZone" class="extype">MessageToHartInZone</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Personalized messages that align the state of the shuttle to one's perspective (client).</p><div class="fullcomment"><div class="comment cmt"><p>Personalized messages that align the state of the shuttle to one's perspective (client).</p></div><dl class="paramcmts block"><dt class="param">inZone</dt><dd class="cmt"><p>the zone for which the update will be composed</p></dd><dt class="param">forChannel</dt><dd class="cmt"><p>to whom to address the reply</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$.html#!=(x$1:Any):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" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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 → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$.html###:Int" 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" title="gt4s: $hash$hash">##</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$.html#==(x$1:Any):Boolean" title="Permalink"><i cla
The former is treated as something internal.
The latter is treated as something external.</p></div><dl class="paramcmts block"><dt class="param">event</dt><dd class="cmt"><p>the <code>TimeShuttleEvent</code> data</p></dd><dt class="param">time</dt><dd class="cmt"><p>how long has the current event in th sequence been occurring</p></dd><dt>returns</dt><dd class="cmt"><p>the <code>OrbitalShuttleEvent</code> data</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>OrbitalShuttleEvent</code></p></span><span class="cmt"><p><code>HartEvent</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$.html#asInstanceOf[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">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$.html#clone():Object" 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">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$.html#eq(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">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartTimer$.html#equals(x$1:Object):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">equals</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 → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finaliz
Reference in a new issue Copy permalink