PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-23 00:23:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/vehicles/VehicleSubsystem.html

16 lines
59 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +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.objects.vehicles.VehicleSubsystem</title><meta content="PSF - LoginServer - master - net.psforever.objects.vehicles.VehicleSubsystem" name="description"/><meta content="PSF LoginServer master net.psforever.objects.vehicles.VehicleSubsystem" 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.vehicles" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="vehicles"></a><a id="vehicles:vehicles"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/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">vehicles</span>
any and all accredited statuses are considered healthy and/or
the internal field (if a primary flag) is set and
the subsystem is not jammed.</p><div class="fullcomment"><div class="comment cmt"><p>If this subsystem is activated,
any and all accredited statuses are considered healthy and/or
the internal field (if a primary flag) is set and
the subsystem is not jammed.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>whether the subsystem is activated</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.VehicleSubsystem#Enabled_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Enabled_=(state:Boolean):Boolean"></a><a id="Enabled_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#Enabled_=(state:Boolean):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" title="gt4s: Enabled_$eq">Enabled_=</span><span class="params">(<span name="state">state: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Treat this subsystem as activated or deactivated.</p><div class="fullcomment"><div class="comment cmt"><p>Treat this subsystem as activated or deactivated.
If this subsystem has specific statuses whose conditions are linked to its activation state,
the first accredited status is selected and set to the same activation state.</p></div><dl class="paramcmts block"><dt class="param">state</dt><dd class="cmt"><p>the new state of the subsystem</p></dd><dt>returns</dt><dd class="cmt"><p>the new state of the subsystem</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableUnit#Jammed" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Jammed:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#Jammed: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">Jammed</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><a href="../equipment/JammableUnit.html" name="net.psforever.objects.equipment.JammableUnit" id="net.psforever.objects.equipment.JammableUnit" class="extype">JammableUnit</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableUnit#Jammed_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Jammed_=(state:Boolean):Boolean"></a><a id="Jammed_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#Jammed_=(state:Boolean):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" title="gt4s: Jammed_$eq">Jammed_=</span><span class="params">(<span name="state">state: <span name="scala.Boolean" class="extype">Boolean</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><a href="../equipment/JammableUnit.html" name="net.psforever.objects.equipment.JammableUnit" id="net.psforever.objects.equipment.JammableUnit" class="extype">JammableUnit</a></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/objects/vehicles/VehicleSubsystem.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="net.psforever.objects.vehicles.VehicleSubsystem#changedMessages" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="changedMessages(vehicle:net.psforever.objects.Vehicle):List[net.psforever.packet.PlanetSideGamePacket]"></a><a id="changedMessages(Vehicle):List[PlanetSideGamePacket]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#changedMessages(vehicle:net.psforever.objects.Vehicle):List[net.psforever.packet.PlanetSideGamePacket]" 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">changedMessages</span><span class="params">(<span name="vehicle">vehicle: <a href="../Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../packet/PlanetSideGamePacket.
always try to produce packets that report the current situation of the subsystem.</p><div class="fullcomment"><div class="comment cmt"><p>Regardless of meta-conditions surrounding the subsystem,
always try to produce packets that report the current situation of the subsystem.
May return a condition status "update" that does not actually change anything.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle in which the subsystem module is operating</p></dd><dt>returns</dt><dd class="cmt"><p>game packets that reflect the condition</p></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/objects/vehicles/VehicleSubsystem.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/objects/vehicles/VehicleSubsystem.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/objects/vehicles/VehicleSubsystem.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</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_&lt;:AnyRef]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#getClass():Class[_]" 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">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ &lt;: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.VehicleSubsystem#getMessag
When the subsystem is jammed, report packets that reflect the jammed conditions.
When not jammed, report any condition that is not neutral / normal.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle in which the subsystem module is operating</p></dd><dt>returns</dt><dd class="cmt"><p>game packets that reflect the condition</p></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#hashCode():Int" 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">hashCode</span><span class="params">()</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><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#isInstanceOf[T0]: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">isInstanceOf</span><span class="tparams">[<span name="T0">T0</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>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.VehicleSubsystem#jam" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="jam():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#jam():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">jam</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.objects.vehicles.VehicleSubsystem#jammerMessages" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="jammerMessages(vehicle:net.psforever.objects.Vehicle):List[net.psforever.packet.PlanetSideGamePacket]"></a><a id="jammerMessages(Vehicle):List[PlanetSideGamePacket]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/VehicleSubsystem.html#jammerMessages(vehicle:net.psforever.objects.Vehicle):List[net.psforever.packet.PlanetSideGamePacket]" 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">jammerMessages</span><span class="params">(<span name="vehicle">vehicle: <a href="../Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../packet/PlanetSideGamePacket.html" name="net.psforever.packet.PlanetSideGamePacket" id="net.psforever.packet.PlanetSideGamePacket" class="extype">PlanetSideGamePacket</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.vehicles.VehicleSubsystem#messagesForStatus" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="messagesForStatus(statusName:String,vehicle:net.psforever.objects.Vehicle):List[net.psforever.packet.PlanetSideGamePacket]"></a><a id="messagesForStatus(String,Vehicle):List[PlanetSideGamePacket]"></a> <sp
Reference in a new issue Copy permalink