PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-04-28 07:45:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/equipment/JammableBehavior.html

18 lines
50 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +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.equipment.JammableBehavior</title><meta content="PSF - LoginServer - master - net.psforever.objects.equipment.JammableBehavior" name="description"/><meta content="PSF LoginServer master net.psforever.objects.equipment.JammableBehavior" 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.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects" class="anchorToMember"></a><a id="objects:objects" class="anchorToMember"></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.equipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equipment" class="anchorToMember"></a><a id="equipment:equipment" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/index.html" title="Permal
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Two aspects to jammering are supported -
a telling buzzing sound that follows the affected target
and actual effects upon the target's actions -
and are controlled independently.
The primary purpose of this behavior is to control timers that toggle the states of these two aspects.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
</p></div><dl class="attributes block"><dt>Self Type</dt><dd><a href="" name="net.psforever.objects.equipment.JammableBehavior" id="net.psforever.objects.equipment.JammableBehavior" class="extype">JammableBehavior</a> with <span name="akka.actor.Actor" class="extype">Actor</span></dd><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/objects/equipment/JammingUnit.scala" target="_blank">JammingUnit.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="../SensorDeployableControl.html" name="net.psforever.objects.SensorDeployableControl" id="net.psforever.objects.SensorDeployableControl" class="extype">SensorDeployableControl</a>, <a href="../ShieldGeneratorControl.html" name="net.psforever.objects.ShieldGeneratorControl" id="net.psforever.objects.ShieldGeneratorControl" class="extype">ShieldGeneratorControl</a>, <a href="../TurretControl.html" name="net.psforever.objects.TurretControl" id="net.psforever.objects.TurretControl" class="extype">TurretControl</a>, <a href="../avatar/PlayerControl.html" name="net.psforever.objects.avatar.PlayerControl" id="net.psforever.objects.avatar.PlayerControl" class="extype">PlayerControl</a>, <a href="JammableMountedWeapons.html" name="net.psforever.objects.equipment.JammableMountedWeapons" id="net.psforever.objects.equipment.JammableMountedWeapons" class="extype">JammableMountedWeapons</a>, <a href="../serverobject/turret/FacilityTurretControl.html" name="net.psforever.objects.serverobject.turret.FacilityTurretControl" id="net.psforever.objects.serverobject.turret.FacilityTurretControl" class="extype">FacilityTurretControl</a>, <a href="../vehicles/control/AmsControl.html" name="net.psforever.objects.vehicles.control.AmsControl" id="net.psforever.objects.vehicles.control.AmsControl" class="extype">AmsControl</a>, <a href="../vehicles/control/AntControl.html" name="net.psforever.objects.vehicles.control.AntControl" id="net.psforever.objects.vehicles.control.AntControl" class="extype">AntControl</a>, <a href="../vehicles/control/ApcControl.html" name="net.psforever.objects.vehicles.control.ApcControl" id="net.psforever.objects.vehicles.control.ApcControl" class="extype">ApcControl</a>, <a href="../vehicles/control/BfrControl.html" name="net.psforever.objects.vehicles.control.BfrControl" id="net.psforever.objects.vehicles.control.BfrControl" class="extype">BfrControl</a>, <a href="../vehicles/control/BfrFlightControl.html" name="net.psforever.objects.vehicles.control.BfrFlightControl" id="net.psforever.objects.vehicles.control.BfrFlightControl" class="extype">BfrFlightControl</a>, <a href="../vehicles/control/CargoCarrierControl.html" name="net.psforever.objects.vehicles.control.CargoCarrierControl" id="net.psforever.objects.vehicles.control.CargoCarrierControl" class="extype">CargoCarrierControl</a>, <a href="../vehicles/control/DeployingVehicleControl.html" name="net.psforever.objects.vehicles.control.DeployingVehicleControl" id="net.psforever.objects.vehicles.control.DeployingVehicleControl" class="extype">DeployingVehicleControl</a>, <a href="../vehicles/control/RouterControl.html" name="net.psforever.objects.vehicles.control.RouterControl" id="net.psforever.objects.vehicles.control.RouterControl" class="extype">RouterControl</a>, <a href="../vehicles/control/VehicleControl.html" name="net.psforever.objects.vehicles.control.VehicleControl" id="net.psforever.objects.vehicles.control.VehicleControl" class="extype">VehicleControl</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="t
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
We merely stop the timer.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>an object that can be affected by the jammered status</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableBehavior#CancelJammeredStatus" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CancelJammeredStatus(target:Any):Unit" class="anchorToMember"></a><a id="CancelJammeredStatus(Any):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableBehavior.html#CancelJammeredStatus(target:Any):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">CancelJammeredStatus</span><span class="params">(<span name="target">target: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Deactivate the effects of the jammered status.</p><div class="fullcomment"><div class="comment cmt"><p>Deactivate the effects of the jammered status.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
We merely stop the timer.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>an object that can be affected by the jammered status</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableBehavior#StartJammeredSound" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartJammeredSound(target:Any,dur:Int):Unit" class="anchorToMember"></a><a id="StartJammeredSound(Any,Int):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableBehavior.html#StartJammeredSound(target:Any,dur:Int):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">StartJammeredSound</span><span class="params">(<span name="target">target: <span name="scala.Any" class="extype">Any</span></span>, <span name="dur">dur: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">30000</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Activate a distinctive buzzing sound effect.</p><div class="fullcomment"><div class="comment cmt"><p>Activate a distinctive buzzing sound effect.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
We merely start the timer.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>an object that can be affected by the jammered status</p></dd><dt class="param">dur</dt><dd class="cmt"><p>the duration of the timer, in milliseconds;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
by default, 30000</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableBehavior#StartJammeredStatus" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartJammeredStatus(target:Any,dur:Int):Unit" class="anchorToMember"></a><a id="StartJammeredStatus(Any,Int):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableBehavior.html#StartJammeredStatus(target:Any,dur:Int):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">StartJammeredStatus</span><span class="params">(<span name="target">target: <span name="scala.Any" class="extype">Any</span></span>, <span name="dur">dur: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Deactivate the effects of the jammered status.</p><div class="fullcomment"><div class="comment cmt"><p>Deactivate the effects of the jammered status.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
We merely stop the timer.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>an object that can be affected by the jammered status</p></dd><dt class="param">dur</dt><dd class="cmt"><p>the duration of the timer, in milliseconds</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableBehavior#TryJammerEffectActivate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryJammerEffectActivate(target:Any,cause:net.psforever.objects.vital.interaction.DamageResult):Unit" class="anchorToMember"></a><a id="TryJammerEffectActivate(Any,DamageResult):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableBehavior.html#TryJammerEffectActivate(target:Any,cause:net.psforever.objects.vital.interaction.DamageResult):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">TryJammerEffectActivate</span><span class="params">(<span name="target">target: <span name="scala.Any" class="extype">Any</span></span>, <span name="cause">cause: <a href="../vital/interaction/DamageResult.html" name="net.psforever.objects.vital.interaction.DamageResult" id="net.psforever.objects.vital.interaction.DamageResult" class="extype">DamageResult</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">If the target can be validated against, affect it with the jammered status.</p><div class="fullcomment"><div class="comment cmt"><p>If the target can be validated against, affect it with the jammered status.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the objects to be determined if affected by the source's jammering</p></dd><dt class="param">cause</dt><dd class="cmt"><p>the source of the "jammered" status</p></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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableBehavior.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="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object" class="anchorToMember"></a><a id="clone():AnyRef" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableBehavior.html#clone():Object" 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">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</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="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </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" class="anchorToMember"><
Reference in a new issue Copy permalink