PSF-LoginServer/net/psforever/packet/game/OrbitalShuttleTimeMsg.html

64 lines
144 KiB
HTML
Raw Permalink Normal View History

<!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.packet.game.OrbitalShuttleTimeMsg</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.OrbitalShuttleTimeMsg" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.OrbitalShuttleTimeMsg" 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_" 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.packet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="packet" class="anchorToMember"></a><a id="packet:packet" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/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">packet</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.packet.game" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="game" class="anchorToMember"></a><a id="game:game" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/index.html" title="Permalink"><i class="material-icons"><EFBFBD><EFBFBD>
and the accompanying orbital shuttle model.<br>
<br>
The animation sequence is controlled primarily by the first field and
goes through a strict cycle of boarding, lift shuttle, takeoff, land, lower shuttle.
All HART facilities (amenity <code>obbasemesh</code>) in a given zone are controlled by this packet.
Multiple systems are controlled by a single field during a given animation,
e.g., the boarding gantries are retracted or extended during the same part where the shuttle is raised or lowered.
Certain neutral animation states - <code>State0</code>, <code>State5</code>, and <code>State7</code> - all behave the same way
though denote different points in the sequence.
Animation subsequence states are coordinated by the second field,
though the specific purpose of the subsequence isn't always obvious,
and the field isn't always necessary to achieve the result of the primary sequence.<br>
<br>
The total time of the system is bound between two states:
whether the shuttle has left or whether it is boarding.
When separated ("has left"),
the shuttle will be lifted out of the bay to atop the building and will fly off into the horizon,
remaining despawned until it returns to view, perches atop the building again, and is lowered into the bay.
When boarding,
the shuttle is fixed in the bay and is accepting passengers via one of the boarding hallways.
Upon boarding the shuttle, the time until takeoff ("has left") is displayed to all waiting passengers
in the form of a progress bar.
This progress bar is fixed to a full time of 60 seconds (60000 milliseconds) in the client and
will start at fractions of completion for boarding times under 60 seconds.<br>
<br>
Pairs of globally unique identifiers for the shuttle facility and the shuttle
link the time fields to their function.
All facilities and shuttles in a given zone are paired and enumerated for a single packet.
If the HART facility identifier is missing or incorrect,
the absent facility will continue to undergo correct animation state transition,
but the door timer will not animate correctly and constantly display the time 10:37 and
the door lights will be neither locked closed (red) or openable (green).
If the shuttle identifier is missing or incorrect,
the absent shuttle will continue to undergo partially correct animation state transitions,
cycling between visible and invisible atop the HART facility,
and the aforementioned progress bars visible by shuttle passengers will not display during the boarding phase
if the shuttle is made available for boarding.</p></div><dl class="paramcmts block"><dt class="param">model_state</dt><dd class="cmt"><p>a control code that affects the over-all state of the HART system</p></dd><dt class="param">unk0</dt><dd class="cmt"><p>na</p></dd><dt class="param">arrival_time</dt><dd class="cmt"><p>the time for the orbital shuttle to return during instances when the shuttle is away;
displayed on a related time near the shuttle boarding entryways;
in milliseconds</p></dd><dt class="param">boarding_time</dt><dd class="cmt"><p>the time for the orbital shuttle to depart during instances when the shuttle is boarding;
frequently <code>8000L</code> when not in use;
in milliseconds</p></dd><dt class="param">other_time</dt><dd class="cmt"><p>time field used for a variety of things;
in most uses, the amount of time that has passed since the start of the event,
so usually <code>0</code> (at start of event);
with respects to <code>model_state</code> and <code>unk3</code>:
full departure time when <code>5</code>-<code>3</code> (variant of <code>7</code>-<code>3</code>);
occasionally, full departure time when <code>0</code>-<code>0</code>
in milliseconds</p></dd><dt class="param">pairs</dt><dd class="cmt"><p>a list of entries that pair
a paired facility pad unique identifier and shuttle unique identifier
with a control code</p></dd></dl><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/packet/game/OrbitalShuttleTimeMsg.scala" target="_blank">OrbitalShuttleTimeMsg.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.Product" class="extype">Product</span>, <span name="scala.Equals" class="extype">Equals</span>, <a href="../PlanetSideGamePacket.html" name="net.psforever.packet.PlanetSideGamePacket" id="net.psforever.packet.PlanetSideGamePacket" class="extype">PlanetSideGamePacket</a>, <a href="../PlanetSidePacket.html" name="net.psforever.packet.PlanetSidePacket" id="net.psforever.packet.PlanetSidePacket" class="extype">PlanetSidePacket</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a>, <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.packet.game.OrbitalShuttleTimeMsg"><span>OrbitalShuttleTimeMsg</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="net.psforever.packet.PlanetSideGamePacket"><span>PlanetSideGamePacket</span></li><li class="in" name="net.psforever.packet.PlanetSidePacket"><span>PlanetSidePacket</span></li><li class="in" name="java.io.Serializable"><span>Serializable</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.packet.game.OrbitalShuttleTimeMsg#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(model_state:net.psforever.types.HartSequence,unk0:Int,arrival_time:Long,boarding_time:Long,other_time:Long,pairs:List[net.psforever.packet.game.PadAndShuttlePair]):net.psforever.packet.game.OrbitalShuttleTimeMsg" class="anchorToMember"></a><a id="&lt;init&gt;:OrbitalShuttleTimeMsg" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/OrbitalShuttleTimeMsg.html#&lt;init&gt;(model_state:net.psforever.types.HartSequence,unk0:Int,arrival_time:Long,boarding_time:Long,other_time:Long,pairs:List[net.psforever.packet.game.PadAndShuttlePair]):net.psforever.packet.game.OrbitalShuttleTimeMsg" 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">OrbitalShuttleTimeMsg</span><span class="params">(<span name="model_state">model_state: <a href="../../types/HartSequence.html" name="net.psforever.types.HartSequence" id="net.psforever.types.HartSequence" class="extype">Ha
displayed on a related time near the shuttle boarding entryways;
in milliseconds</p></dd><dt class="param">boarding_time</dt><dd class="cmt"><p>the time for the orbital shuttle to depart during instances when the shuttle is boarding;
frequently <code>8000L</code> when not in use;
in milliseconds</p></dd><dt class="param">other_time</dt><dd class="cmt"><p>time field used for a variety of things;
in most uses, the amount of time that has passed since the start of the event,
so usually <code>0</code> (at start of event);
with respects to <code>model_state</code> and <code>unk3</code>:
full departure time when <code>5</code>-<code>3</code> (variant of <code>7</code>-<code>3</code>);
occasionally, full departure time when <code>0</code>-<code>0</code>
in milliseconds</p></dd><dt class="param">pairs</dt><dd class="cmt"><p>a list of entries that pair
a paired facility pad unique identifier and shuttle unique identifier
with a control code</p></dd></dl></div></li></ol></div><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="net.psforever.packet.game.OrbitalShuttleTimeMsg.Packet" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Packet=net.psforever.packet.game.OrbitalShuttleTimeMsg" class="anchorToMember"></a><a id="Packet:Packet" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/OrbitalShuttleTimeMsg.html#Packet=net.psforever.packet.game.OrbitalShuttleTimeMsg" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">type</span></span> <span class="symbol"><span class="name">Packet</span><span class="result alias"> = <a href="" name="net.psforever.packet.game.OrbitalShuttleTimeMsg" id="net.psforever.packet.game.OrbitalShuttleTimeMsg" class="extype">OrbitalShuttleTimeMsg</a></span></span></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" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/OrbitalShuttleTimeMsg.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/packet/game/OrbitalShuttleTimeMsg.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="permalink"><a href="../../../../net/psforever/packet/game/OrbitalShuttleTimeMsg.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: $eq$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="net.psforever.packet.game.OrbitalShuttleTimeMsg#arrival_time" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="arrival_time:Long" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/OrbitalShuttleTimeMsg.html#arrival_time:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">arriva