PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-01 03:23:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html

23 lines
44 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.HartEvent.ShuttleDockingOps</title><meta content="PSF - LoginServer - master - net.psforever.services.hart.HartEvent.ShuttleDockingOps" name="description"/><meta content="PSF LoginServer master net.psforever.services.hart.HartEvent.ShuttleDockingOps" 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
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;
<code>None</code> - the shuttle is acting freely apart from its facility</p><div class="fullcomment"><div class="comment cmt"><p>how the shuttle and the HART facility interact;
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;
<code>None</code> - the shuttle is acting freely apart from its facility</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.services.hart.HartEvent.ShuttleDockingOps" id="net.psforever.services.hart.HartEvent.ShuttleDockingOps" class="extype">ShuttleDockingOps</a> → <a href="HartEvent.html" name="net.psforever.services.hart.HartEvent" id="net.psforever.services.hart.HartEvent" class="extype">HartEvent</a></dd></dl></div></li><li class="indented0 " name="net.psforever.services.hart.HartEvent.ShuttleDockingOps#duration" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="duration:Long"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html#duration:Long" 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">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><div class="fullcomment"><div class="comment cmt"><p>for how long this event goes on</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.services.hart.HartEvent.ShuttleDockingOps" id="net.psforever.services.hart.HartEvent.ShuttleDockingOps" class="extype">ShuttleDockingOps</a> → <a href="HartEvent.html" name="net.psforever.services.hart.HartEvent" id="net.psforever.services.hart.HartEvent" class="extype">HartEvent</a></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/HartEvent$$ShuttleDockingOps$.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/HartEvent$$ShuttleDockingOps$.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#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html#finalize():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">finalize</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>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang
this is an active state field: <code>true</code> - locked right now and <code>false</code> - unlocked right now
</p><div class="fullcomment"><div class="comment cmt"><p>are the managed doors for the HART facility locked closed;
this is an active state field: <code>true</code> - locked right now and <code>false</code> - unlocked right now
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="HartEvent.html" name="net.psforever.services.hart.HartEvent" id="net.psforever.services.hart.HartEvent" class="extype">HartEvent</a></dd></dl></div></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/hart/HartEvent$$ShuttleDockingOps$.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"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.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"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.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.ShuttleDockingOps#prerequisiteUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="prerequisiteUpdate:Option[net.psforever.services.hart.HartEventStateFields]"></a><a id="prerequisiteUpdate:Option[HartEventStateFields]"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html#prerequisiteUpdate:Option[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">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;
the primary purpose is to place the shuttle platform at the correct elevation
</p><div class="fullcomment"><div class="comment cmt"><p>these fields must be including prior to an update if the shuttle state was not previous known;
the primary purpose is to place the shuttle platform at the correct elevation
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.services.hart.HartEvent.ShuttleDockingOps" id="net.psforever.services.hart.HartEvent.ShuttleDockingOps" class="extype">ShuttleDockingOps</a> → <a href="HartEvent.html" name="net.psforever.services.hart.HartEvent" id="net.psforever.services.hart.HartEvent" class="extype">HartEvent</a></dd></dl></div></li><li class="indented0 " name="scala.Product#productElementName" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="productElementName(n:Int):String"></a><a id="productElementName(Int):String"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html#productElementName(n:Int):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">productElementName</span><span class="params">(<span name="n">n: <span name="scala.Int" class="extype">Int</span></span>)</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>Product</dd></dl></div></li><li class="indented0 " name="scala.Product#productElementNames" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="productElementNames:Iterator[String]"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html#productElementNames:Iterator[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">productElementNames</span><span class="result">: <span name="scala.Iterator" class="extype">Iterator</span>[<span name="scala.Predef.String" class="extype">String</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Product</dd></dl></div></li><li class="indented0 " name="net.psforever.services.hart.HartEvent.ShuttleDockingOps#shuttleState" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="shuttleState:Option[net.psforever.services.hart.ShuttleState.Value]"></a><a id="shuttleState:Option[ShuttleState.Value]"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.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"></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;
the state is related to a value in the <code>Flying</code> field of a <code>VehicleStateMessage</code> packet
</p><div class="fullcomment"><div class="comment cmt"><p>the shuttle has a unique state to expose to the zone;
the state is related to a value in the <code>Flying</code> field of a <code>VehicleStateMessage</code> packet
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.services.hart.HartEvent.ShuttleDockingOps" id="net.psforever.services.hart.HartEvent.ShuttleDockingOps" class="extype">ShuttleDockingOps</a> → <a href="HartEvent.html" name="net.psforever.services.hart.HartEvent" id="net.psforever.services.hart.HartEvent" class="extype">HartEvent</a></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"></a><a id="stateFields(Option[Long]):HartEventStateFields"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.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></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="HartEvent.html" name="net.psforever.services.hart.HartEvent" id="net.psforever.services.hart.HartEvent" class="extype">HartEvent</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html#synchronized[T0](x$1:=&gt;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: =&gt; <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.hart.HartEvent#timeFields" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="timeFields(time:Option[Long]):net.psforever.services.hart.HartEventTimeFields"></a><a id="timeFields(Option[Long]):HartEventTimeFields"></a> <span class="permalink"><a href="../../../../net/psforever/services/hart/HartEvent$$ShuttleDockingOps$.html#timeFields(time:Option[Long]):net.psforever.services.hart.HartEventTimeFields" 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">timeFields</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="res
Reference in a new issue Copy permalink