PSF-LoginServer/net/psforever/objects/vital/projectile/ProjectileDamageModifierFunctions$.html

21 lines
46 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.vital.projectile.ProjectileDamageModifierFunctions</title><meta content="PSF - LoginServer - master - net.psforever.objects.vital.projectile.ProjectileDamageModifierFunctions" name="description"/><meta content="PSF LoginServer master net.psforever.objects.vital.projectile.ProjectileDamageModifierFunctions" 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.vital" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="vital"></a><a id="vital:vital"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/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=""><spa
calculate that damage application burn for each tick for infantry targets
and produce the modified damage value.</p><div class="fullcomment"><div class="comment cmt"><p>For damage application that involves aggravation of a particular damage type,
calculate that damage application burn for each tick for infantry targets
and produce the modified damage value.
Infantry wearing mechanized assault exo-suits (MAX) incorporate an additional modifier.
Vanilla infantry incorporate their resistance value into a slightly different calculation than usual.</p></div><dl class="paramcmts block"><dt class="param">resolution</dt><dd class="cmt"><p>the projectile resolution to match against</p></dd><dt class="param">damageType</dt><dd class="cmt"><p>the damage type to find in as a component of aggravated information</p></dd><dt class="param">damage</dt><dd class="cmt"><p>the base damage value</p></dd><dt class="param">data</dt><dd class="cmt"><p>historical information related to the damage interaction</p></dd><dt>returns</dt><dd class="cmt"><p>the modified damage</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AggravatedDamage</code></p></span><span class="cmt"><p><code>ExoSuitType</code></p></span><span class="cmt"><p><code>InfantryAggravatedDirectBurn</code></p></span><span class="cmt"><p><code>InfantryAggravatedSplashBurn</code></p></span><span class="cmt"><p><code>PlayerSource</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.projectile.ProjectileDamageModifierFunctions#baseAggravatedFormula" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="baseAggravatedFormula(resolution:net.psforever.objects.vital.base.DamageResolution.Value,damageType:net.psforever.objects.vital.base.DamageType.Value)(damage:Int,data:net.psforever.objects.vital.interaction.DamageInteraction,cause:net.psforever.objects.vital.projectile.ProjectileReason):Int"></a><a id="baseAggravatedFormula(base.DamageResolution.Value,base.DamageType.Value)(Int,DamageInteraction,ProjectileReason):Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/projectile/ProjectileDamageModifierFunctions$.html#baseAggravatedFormula(resolution:net.psforever.objects.vital.base.DamageResolution.Value,damageType:net.psforever.objects.vital.base.DamageType.Value)(damage:Int,data:net.psforever.objects.vital.interaction.DamageInteraction,cause:net.psforever.objects.vital.projectile.ProjectileReason):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">baseAggravatedFormula</span><span class="params">(<span name="resolution">resolution: <a href="../base/DamageResolution$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.vital.base.DamageResolution.Value" id="net.psforever.objects.vital.base.DamageResolution.Value" class="extmbr">base.DamageResolution.Value</a></span>, <span name="damageType">damageType: <a href="../base/DamageType$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.vital.base.DamageType.Value" id="net.psforever.objects.vital.base.DamageType.Value" class="extmbr">base.DamageType.Value</a></span>)</span><span class="params">(<span name="damage">damage: <span name="scala.Int" class="extype">Int</span></span>, <span name="data">data: <a href="../interaction/DamageInteraction.html" name="net.psforever.objects.vital.interaction.DamageInteraction" id="net.psforever.objects.vital.interaction.DamageInteraction" class="extype">DamageInteraction</a></span>, <span name="cause">cause: <a href="ProjectileReason.html" name="net.psforever.objects.vital.projectile.ProjectileReason" id="net.psforever.objects.vital.projectile.ProjectileReason" class="extype">ProjectileReason</a></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">For damage application that involves aggravation of a particular damage type,
calculate that initial damage application for infantry targets
and produce the modified damage value.</p><div class="fullcomment"><div class="comment cmt"><p>For damage application that involves aggravation of a particular damage type,
calculate that initial damage application for infantry targets
and produce the modified damage value.
Infantry wearing mechanized assault exo-suits (MAX) incorporate an additional modifier.</p></div><dl class="paramcmts block"><dt class="param">resolution</dt><dd class="cmt"><p>the projectile resolution to match against</p></dd><dt class="param">damageType</dt><dd class="cmt"><p>the damage type to find in as a component of aggravated information</p></dd><dt class="param">damage</dt><dd class="cmt"><p>the base damage value</p></dd><dt class="param">data</dt><dd class="cmt"><p>historical information related to the damage interaction</p></dd><dt>returns</dt><dd class="cmt"><p>the modified damage</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AggravatedDamage</code></p></span><span class="cmt"><p><code>ExoSuitType</code></p></span><span class="cmt"><p><code>InfantryAggravatedDirect</code></p></span><span class="cmt"><p><code>InfantryAggravatedSplash</code></p></span><span class="cmt"><p><code>PlayerSource</code></p></span><span class="cmt"><p><code>ProjectileTarget.AggravatesTarget</code></p></span></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/vital/projectile/ProjectileDamageModifierFunctions$.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="net.psforever.objects.vital.projectile.ProjectileDamageModifierFunctions#distanceDegradeFunction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="distanceDegradeFunction(damage:Int,data:net.psforever.objects.vital.interaction.DamageInteraction,cause:net.psforever.objects.vital.projectile.ProjectileReason):Int"></a><a id="distanceDegradeFunction(Int,DamageInteraction,ProjectileReason):Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/projectile/ProjectileDamageModifierFunctions$.html#distanceDegradeFunction(damage:Int,data:net.psforever.objects.vital.interaction.DamageInteraction,cause:net.psforever.objects.vital.projectile.ProjectileReason):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">distanceDegradeFunction</span><span class="params">(<span name="damage">damage: <span name="scala.Int" class="extype">Int</span></span>, <span name="data">data: <a href="../interaction/DamageInteraction.html" name="net.psforever.objects.vital.interaction.DamageInteraction" id="net.psforever.objects.vital.interaction.DamageInteraction" class="extype">DamageInteraction</a></span>, <span name="cause">cause: <a href="ProjectileReason.html" name="net.psforever.objects.vital.projectile.ProjectileReason" id="net.psforever.objects.vital.projectile.ProjectileReason" class="extype">ProjectileReason</a></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">The input value degrades (lessens)
the further the distance between the point of origin (<code>shot_origin</code>)
and the point of encounter (<code>hitPos</code>) of its vector (projectile).</p><div class="fullcomment"><div class="comment cmt"><p>The input value degrades (lessens)
the further the distance between the point of origin (<code>shot_origin</code>)
and the point of encounter (<code>hitPos</code>) of its vector (projectile).
If the value is not set to degrade over any distance within its maximum distance, the value goes unmodified.
If the value is encountered beyond its maximum distance, the value is zero'd.
</p></div></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/vital/projectile/ProjectileDamageModifierFunctions$.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/vital/projectile/ProjectileDamageModifierFunctions$.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/vital/projectile/ProjectileDamageModifierFunctions$.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/vital/projectile/ProjectileDamageModifierFunctions$.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="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/vital/projectile/ProjectileDamageModifierFunctions$.html#ha