PSF-LoginServer/net/psforever/objects/Vehicle$.html

7 lines
68 KiB
HTML
Raw 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.objects.Vehicle</title><meta content="PSF - LoginServer - master - net.psforever.objects.Vehicle" name="description"/><meta content="PSF LoginServer master net.psforever.objects.Vehicle" 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.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../net/psforever/objects/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">objects</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.objects.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/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="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
should initiate instantly when <code>None</code></p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>VehicleControl</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Vehicle.Exchange" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="ExchangeextendsAnyRef"></a><a id="Exchange:Exchange"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle$$Exchange.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="Vehicle$$Exchange.html" title="A basic Trait connecting all of the actionable Vehicle response messages."><span class="name">Exchange</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">A basic <code>Trait</code> connecting all of the actionable <code>Vehicle</code> response messages.</p></li><li class="indented0 " name="net.psforever.objects.Vehicle.Ownership" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OwnershipextendsProductwithSerializable"></a><a id="Ownership:Ownership"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle$$Ownership.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="Vehicle$$Ownership.html" title="Change a vehicle's internal ownership property to match that of the target player."><span class="name">Ownership</span></a><span class="params">(<span name="player">player: <span name="scala.Option" class="extype">Option</span>[<a href="Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>]</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">Change a vehicle's internal ownership property to match that of the target player.</p><div class="fullcomment"><div class="comment cmt"><p>Change a vehicle's internal ownership property to match that of the target player.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the person who will own the vehicle, or <code>None</code> if the vehicle will go unowned</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Vehicle.Reactivate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ReactivateextendsProductwithSerializable"></a><a id="Reactivate:Reactivate"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle$$Reactivate.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="Vehicle$$Reactivate.html" title="The Vehicle will resume previous unresponsiveness to player activity."><span class="name">Reactivate</span></a><span class="params">()</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">The <code>Vehicle</code> will resume previous unresponsiveness to player activity.</p><div class="fullcomment"><div class="comment cmt"><p>The <code>Vehicle</code> will resume previous unresponsiveness to player activity.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>VehicleControl</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Vehicle.UpdateShieldsCharge" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateShieldsChargeextendsProductwithSerializable"></a><a id="UpdateShieldsCharge:UpdateShields
that is a product of the <code>OxygenStateMessage</code> packet to vehicle passengers.</p><div class="fullcomment"><div class="comment cmt"><p>For vehicles, this pertains mainly to resending information needs to display the the drowning red progress bar
that is a product of the <code>OxygenStateMessage</code> packet to vehicle passengers.
It also forces passengers to update their internal understanding of their own drowning state.</p></div><dl class="paramcmts block"><dt class="param">passenger</dt><dd class="cmt"><p>a player mounted in the vehicle</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Vehicle.VehicleMessages" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleMessagesextendsProductwithSerializable"></a><a id="VehicleMessages:VehicleMessages"></a> <span class="permalink"><a href="../../../net/psforever/objects/Vehicle$$VehicleMessages.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="Vehicle$$VehicleMessages.html" title="Message that carries the result of the processed request message back to the original user (player)."><span class="name">VehicleMessages</span></a><span class="params">(<span name="player">player: <a href="Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="response">response: <a href="Vehicle$$Exchange.html" name="net.psforever.objects.Vehicle.Exchange" id="net.psforever.objects.Vehicle.Exchange" class="extype">Exchange</a></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">Message that carries the result of the processed request message back to the original user (<code>player</code>).</p><div class="fullcomment"><div class="comment cmt"><p>Message that carries the result of the processed request message back to the original user (<code>player</code>).</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player who sent this request message</p></dd><dt class="param">response</dt><dd class="cmt"><p>the result of the processed request</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/objects/Vehicle$.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/objects/Vehicle$.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/objects/Vehicle$.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 cla