PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-07-16 00:44:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/services/hart/HartEvent.html

15 lines
40 KiB
HTML
Raw Permalink 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.HartEvent</title><meta content="PSF - LoginServer - master - net.psforever.services.hart.HartEvent" name="description"/><meta content="PSF LoginServer master net.psforever.services.hart.HartEvent" 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 @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +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_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></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" class="anchorToMember"></a><a id="net:net" class="anchorToMember"></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" class="anchorToMember"></a><a id="psforever:psforever" class="anchorToMember"></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" class="anchorToMember"></a><a id="services:services" class="anchorToMember"></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" class="anchorToMember"></a><a id="hart:hart" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/index.html" title="Permalink"><i class="ma
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
encompassing both ground facility conditions and conditions of the orbital shuttle.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
</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/hart/HartEvent.scala" target="_blank">HartEvent.scala</a></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 class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="HartEvent$$Arrival$.html" name="net.psforever.services.hart.HartEvent.Arrival" id="net.psforever.services.hart.HartEvent.Arrival" class="extype">Arrival</a>, <a href="HartEvent$$Blanking$.html" name="net.psforever.services.hart.HartEvent.Blanking" id="net.psforever.services.hart.HartEvent.Blanking" class="extype">Blanking</a>, <a href="HartEvent$$Boarding.html" name="net.psforever.services.hart.HartEvent.Boarding" id="net.psforever.services.hart.HartEvent.Boarding" class="extype">Boarding</a>, <a href="HartEvent$$InTransit.html" name="net.psforever.services.hart.HartEvent.InTransit" id="net.psforever.services.hart.HartEvent.InTransit" class="extype">InTransit</a>, <a href="HartEvent$$ShuttleDockingOps$.html" name="net.psforever.services.hart.HartEvent.ShuttleDockingOps" id="net.psforever.services.hart.HartEvent.ShuttleDockingOps" class="extype">ShuttleDockingOps</a>, <a href="HartEvent$$ShuttleTakeoffOps.html" name="net.psforever.services.hart.HartEvent.ShuttleTakeoffOps" id="net.psforever.services.hart.HartEvent.ShuttleTakeoffOps" class="extype">ShuttleTakeoffOps</a>, <a href="HartEvent$$Takeoff.html" name="net.psforever.services.hart.HartEvent.Takeoff" id="net.psforever.services.hart.HartEvent.Takeoff" class="extype">Takeoff</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.services.hart.HartEvent"><span>HartEvent</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 class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="net.psforever.services.hart.HartEvent#docked" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="docked:Option[Boolean]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#docked:Option[Boolean]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">docked</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Boolean" class="extype">Boolean</span>]</span></span><p class="shortcomment cmt">how the shuttle and the HART facility interact;
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
this is an active state field:
<code>Some(true)</code> - the shuttle is docked right now;
<code>Some(false)</code> - the shuttle has freed itself from the facility's dock right now;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
<code>None</code> - the shuttle is acting freely apart from its facility</p></li><li class="indented0 " name="net.psforever.services.hart.HartEvent#duration" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="duration:Long" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#duration:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">duration</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span><p class="shortcomment cmt">for how long this event goes on</p></li><li class="indented0 " name="net.psforever.services.hart.HartEvent#prerequisiteUpdate" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="prerequisiteUpdate:Option[net.psforever.services.hart.HartEventStateFields]" class="anchorToMember"></a><a id="prerequisiteUpdate:Option[HartEventStateFields]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#prerequisiteUpdate:Option[net.psforever.services.hart.HartEventStateFields]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">prerequisiteUpdate</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="HartEventStateFields.html" name="net.psforever.services.hart.HartEventStateFields" id="net.psforever.services.hart.HartEventStateFields" class="extype">HartEventStateFields</a>]</span></span><p class="shortcomment cmt">these fields must be including prior to an update if the shuttle state was not previous known;
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
the primary purpose is to place the shuttle platform at the correct elevation
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
</p></li><li class="indented0 " name="net.psforever.services.hart.HartEvent#shuttleState" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="shuttleState:Option[net.psforever.services.hart.ShuttleState.Value]" class="anchorToMember"></a><a id="shuttleState:Option[ShuttleState.Value]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#shuttleState:Option[net.psforever.services.hart.ShuttleState.Value]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">shuttleState</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="ShuttleState$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.services.hart.ShuttleState.Value" id="net.psforever.services.hart.ShuttleState.Value" class="extmbr">ShuttleState.Value</a>]</span></span><p class="shortcomment cmt">the shuttle has a unique state to expose to the zone;
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
the state is related to a value in the <code>Flying</code> field of a <code>VehicleStateMessage</code> packet
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
</p></li><li class="indented0 " name="net.psforever.services.hart.HartEvent#timeOnClock" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="timeOnClock:Long" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#timeOnClock:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">timeOnClock</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span><p class="shortcomment cmt">starting time on the clock; typically seen on the display</p></li><li class="indented0 " name="net.psforever.services.hart.HartEvent#u1" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="u1:net.psforever.types.HartSequence" class="anchorToMember"></a><a id="u1:HartSequence" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#u1:net.psforever.types.HartSequence" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">u1</span><span class="result">: <a href="../../types/HartSequence.html" name="net.psforever.types.HartSequence" id="net.psforever.types.HartSequence" class="extype">HartSequence</a></span></span><p class="shortcomment cmt">HART facility and shuttle animation</p></li><li class="indented0 " name="net.psforever.services.hart.HartEvent#u2" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="u2:Int" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#u2:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">u2</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">counter?</p></li></ol></div><div class="values members"><h3>Concrete 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" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.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" class="anchorToMember"></a><a id="==(Any):Boolean" class="anchorToMember"></a> <span class="per
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
this is an active state field: <code>true</code> - locked right now and <code>false</code> - unlocked right now
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
</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" class="anchorToMember"></a><a id="ne(AnyRef):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.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="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.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#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#notifyAll():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">notifyAll</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="net.psforever.services.hart.HartEvent#stateFields" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="stateFields(time:Option[Long]):net.psforever.services.hart.HartEventStateFields" class="anchorToMember"></a><a id="stateFields(Option[Long]):HartEventStateFields" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent.html#stateFields(time:Option[Long]):net.psforever.services.hart.HartEventStateFields" 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">stateFields</span><span class="params">(<span name="time">time: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Long" class="extype">Long</span>] = <span class="symbol">None</span></span>)</span><span class="result">: <a href="HartEventStateFields.html" name="net.psforever.services.hart.HartEventStateFields" id="net.psforever.services.hart.HartEventStateFields" class="extype">HartEventStateFields</a></span></span><p class="shortcomment cmt">Get the animation state fields for this event.</p><div class="fullcomment"><div class="comment cmt"><p>Get the animation state fields for this event.</p></div><dl class="paramcmts block"><dt class="param">time</dt><dd class="cmt"><p>during update requests, the amount of time that has elapsed during the start of this event</p></dd><dt>returns</dt><dd class="cmt"><p>the animation state data</p></dd></d
Reference in a new issue Copy permalink