PSF-LoginServer/net/psforever/objects/equipment/JammableMountedWeapons.html

12 lines
54 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.equipment.JammableMountedWeapons</title><meta content="PSF - LoginServer - master - net.psforever.objects.equipment.JammableMountedWeapons" name="description"/><meta content="PSF LoginServer master net.psforever.objects.equipment.JammableMountedWeapons" 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.equipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equipment"></a><a id="equipment:equipment"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/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">equipment<
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
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><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.equipment.JammableMountedWeapons" id="net.psforever.objects.equipment.JammableMountedWeapons" class="extype">JammableMountedWeapons</a><a href="JammableBehavior.html" name="net.psforever.objects.equipment.JammableBehavior" id="net.psforever.objects.equipment.JammableBehavior" class="extype">JammableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableMountedWeapons#CancelJammeredStatus" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CancelJammeredStatus(target:Any):Unit"></a><a id="CancelJammeredStatus(Any):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableMountedWeapons.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.
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
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><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.equipment.JammableMountedWeapons" id="net.psforever.objects.equipment.JammableMountedWeapons" class="extype">JammableMountedWeapons</a><a href="JammableBehavior.html" name="net.psforever.objects.equipment.JammableBehavior" id="net.psforever.objects.equipment.JammableBehavior" class="extype">JammableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableMountedWeapons#JammableMountedWeaponsJammeredStatus" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="JammableMountedWeaponsJammeredStatus(target:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vehicles.MountedWeapons,statusCode:Int):Unit"></a><a id="JammableMountedWeaponsJammeredStatus(PlanetSideServerObjectwithMountedWeapons,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableMountedWeapons.html#JammableMountedWeaponsJammeredStatus(target:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vehicles.MountedWeapons,statusCode: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">JammableMountedWeaponsJammeredStatus</span><span class="params">(<span name="target">target: <a href="../serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../vehicles/MountedWeapons.html" name="net.psforever.objects.vehicles.MountedWeapons" id="net.psforever.objects.vehicles.MountedWeapons" class="extype">MountedWeapons</a></span>, <span name="statusCode">statusCode: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.objects.equipment.JammableMountedWeapons#StartJammeredSound" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartJammeredSound(target:Any,dur:Int):Unit"></a><a id="StartJammeredSound(Any,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableMountedWeapons.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>)</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.
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;
by default, 30000</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.equipment.JammableMountedWeapons" id="net.psforever.objects.equipment.JammableMountedWeapons" class="extype">JammableMountedWeapons</a><a href="JammableBehavior.html" name="net.psforever.objects.equipment.JammableBehavior" id="net.psforever.objects.equipment.JammableBehavior" class="extype">JammableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.equipment.JammableMountedWeapons#StartJammeredStatus" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartJammeredStatus(target:Any,dur:Int):Unit"></a><a id="StartJammeredStatus(Any,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableMountedWeapons.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.
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
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><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.equipment.JammableMountedWeapons" id="net.psforever.objects.equipment.JammableMountedWeapons" class="extype">JammableMountedWeapons</a><a href="JammableBehavior.html" name="net.psforever.objects.equipment.JammableBehavior" id="net.psforever.objects.equipment.JammableBehavior" class="extype">JammableBehavior</a></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"></a><a id="TryJammerEffectActivate(Any,DamageResult):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableMountedWeapons.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><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="JammableBehavior.html" name="net.psforever.objects.equipment.JammableBehavior" id="net.psforever.objects.equipment.JammableBehavior" class="extype">JammableBehavior</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/equipment/JammableMountedWeapons.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"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/objects/equipment/JammableMountedWeapons.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 cla