PSF-LoginServer/net/psforever/objects/ExplosiveDeployableControl.html

14 lines
76 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.ExplosiveDeployableControl</title><meta content="PSF - LoginServer - master - net.psforever.objects.ExplosiveDeployableControl" name="description"/><meta content="PSF LoginServer master net.psforever.objects.ExplosiveDeployableControl" 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="
to account for sympathetic explosives even if there is no damage.</p><div class="fullcomment"><div class="comment cmt"><p>A supplement for checking target susceptibility
to account for sympathetic explosives even if there is no damage.
This does not supercede other underlying checks or undo prior damage checks.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the entity being damaged</p></dd><dt class="param">damage</dt><dd class="cmt"><p>the amount of damage</p></dd><dt class="param">data</dt><dd class="cmt"><p>historical information about the damage</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the target can be affected;
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Damageable.CanDamageOrJammer</code></p></span><span class="cmt"><p><code>DamageProperties.SympatheticExplosives</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ExplosiveDeployableControl#DamageableObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DamageableObject:net.psforever.objects.ExplosiveDeployable"></a><a id="DamageableObject:ExplosiveDeployable"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#DamageableObject:net.psforever.objects.ExplosiveDeployable" 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">DamageableObject</span><span class="result">: <a href="ExplosiveDeployable.html" name="net.psforever.objects.ExplosiveDeployable" id="net.psforever.objects.ExplosiveDeployable" class="extype">ExplosiveDeployable</a></span></span><p class="shortcomment cmt">Contextual access to the object being the target of this damage.</p><div class="fullcomment"><div class="comment cmt"><p>Contextual access to the object being the target of this damage.
Needs declaration in lowest implementing code.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the entity controlled by this actor</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.ExplosiveDeployableControl" id="net.psforever.objects.ExplosiveDeployableControl" class="extype">ExplosiveDeployableControl</a><a href="serverobject/damage/Damageable.html" name="net.psforever.objects.serverobject.damage.Damageable" id="net.psforever.objects.serverobject.damage.Damageable" class="extype">Damageable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ExplosiveDeployableControl#PerformDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="PerformDamage(target:net.psforever.objects.serverobject.damage.Damageable.Target,applyDamageTo:net.psforever.objects.vital.resolution.ResolutionCalculations.Output):Unit"></a><a id="PerformDamage(Target,Output):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#PerformDamage(target:net.psforever.objects.serverobject.damage.Damageable.Target,applyDamageTo:net.psforever.objects.vital.resolution.ResolutionCalculations.Output):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">PerformDamage</span><span class="params">(<span name="target">target: <a href="serverobject/damage/Damageable$.html#Target=net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vital.Vitality" name="net.psforever.objects.serverobject.damage.Damageable.Target" id="net.psforever.objects.serverobject.damage.Damageable.Target" class="extmbr">Target</a></span>, <span name="applyDamageTo">applyDamageTo: <a href="vital/resolution/ResolutionCalculations$.html#Output=net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinity=&gt;net.psforever.objects.vital.interaction.DamageResult" name="net.psforever.objects.vital.resolution.ResolutionCalculations.Output" id="net.psforever.objects.vital.resolution.ResolutionCalculations.Output" class="extmbr">Output</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Assess the vital statistics of the target, apply the damage, and determine if any of those statistics changed.</p><div class="fullcomment"><div class="comment cmt"><p>Assess the vital statistics of the target, apply the damage, and determine if any of those statistics changed.
By default, only take an interest in the change of "health".
If implementing custom damage with no new message handling, override this method.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity to be damaged</p></dd><dt class="param">applyDamageTo</dt><dd class="cmt"><p>the function that applies the damage to the target in a target-tailored fashion</p></dd></dl><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.ExplosiveDeployableControl" id="net.psforever.objects.ExplosiveDeployableControl" class="extype">ExplosiveDeployableControl</a><a href="serverobject/damage/Damageable.html" name="net.psforever.objects.serverobject.damage.Damageable" id="net.psforever.objects.serverobject.damage.Damageable" class="extype">Damageable</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>ResolutionCalculations.Output</code></p></span></dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostRestart(reason:Throwable):Unit"></a><a id="aroundPostRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#aroundPostRestart(reason:Throwable):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">aroundPostRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>)</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[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostStop():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#aroundPostStop():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">aroundPostStop</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[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreRestart(reason:Throwable,message:Option[Any]):Unit"></a><a id="aroundPreRestart(Throwable,Option[Any]):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#aroundPreRestart(reason:Throwable,message:Option[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">aroundPreRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>, <span name="message">message: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>]</span>)</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[<a
<code>orElse</code> onto the "control" <code>Actor</code> <code>receive</code>; or,
cite the <code>originalTakesDamage</code> protocol during inheritance overrides</p><div class="fullcomment"><div class="comment cmt"><p>the official mixin hook;
<code>orElse</code> onto the "control" <code>Actor</code> <code>receive</code>; or,
cite the <code>originalTakesDamage</code> protocol during inheritance overrides</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/damage/Damageable.html" name="net.psforever.objects.serverobject.damage.Damageable" id="net.psforever.objects.serverobject.damage.Damageable" class="extype">Damageable</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#toString():String" 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">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#unhandled" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unhandled(message:Any):Unit"></a><a id="unhandled(Any):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#unhandled(message: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">unhandled</span><span class="params">(<span name="message">message: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#wait():Unit" 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">wait</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>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.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/ExplosiveDeployableControl.html#wait(x$1:Long,x$2:Int):Unit" 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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><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.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="fa