PSF-LoginServer/net/psforever/objects/ballistics/index.html

20 lines
47 KiB
HTML
Raw Permalink 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.ballistics</title><meta content="PSF - LoginServer - master - net.psforever.objects.ballistics" name="description"/><meta content="PSF LoginServer master net.psforever.objects.ballistics" 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_" 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.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar" class="anchorToMember"></a><a id="avatar:avatar" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="
Only <code>Direct</code> and <code>Splash</code> are valid damage types, however.</p></div><dl class="paramcmts block"><dt class="param">damage_type</dt><dd class="cmt"><p>the type of damage</p></dd><dt class="param">degradation_percentage</dt><dd class="cmt"><p>by how much the damage is degraded</p></dd><dt class="param">infliction_rate</dt><dd class="cmt"><p>how often the damage is inflicted (ms)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ballistics.AggravatedTiming" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AggravatedTimingextendsProductwithSerializable" class="anchorToMember"></a><a id="AggravatedTiming:AggravatedTiming" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/AggravatedTiming.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AggravatedTiming.html" title="In what manner of pacing the aggravated damage ticks are applied."><span class="name">AggravatedTiming</span></a><span class="params">(<span name="duration">duration: <span name="scala.Long" class="extype">Long</span></span>, <span name="ticks">ticks: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">In what manner of pacing the aggravated damage ticks are applied.</p><div class="fullcomment"><div class="comment cmt"><p>In what manner of pacing the aggravated damage ticks are applied.</p></div><dl class="paramcmts block"><dt class="param">duration</dt><dd class="cmt"><p>for how long the over-all effect is applied</p></dd><dt class="param">ticks</dt><dd class="cmt"><p>a custom number of damage applications,
as opposed to whatever calculations normally estimate the number of applications</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ballistics.ChargeDamage" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ChargeDamageextendsProductwithSerializable" class="anchorToMember"></a><a id="ChargeDamage:ChargeDamage" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/ChargeDamage.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChargeDamage.html" title=""><span class="name">ChargeDamage</span></a><span class="params">(<span name="effect_count">effect_count: <span name="scala.Int" class="extype">Int</span></span>, <span name="min">min: <a href="../vital/damage/StandardDamageProfile.html" name="net.psforever.objects.vital.damage.StandardDamageProfile" id="net.psforever.objects.vital.damage.StandardDamageProfile" class="extype">StandardDamageProfile</a></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.objects.ballistics.InteractWithRadiationClouds" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InteractWithRadiationCloudsextendsZoneInteraction" class="anchorToMember"></a><a id="InteractWithRadiationClouds:InteractWithRadiationClouds" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/InteractWithRadiationClouds.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="InteractWithRadiationClouds.html" title="This game entity may infrequently test whether it may interact with radiation cloud projectiles that may be emitted in the game environment for a limited amount of time."><span class="name">InteractWithRadiationClouds</span></a><span class="result"> extends <a href="../zones/ZoneInteraction.html" name="net.psforever.objects.zones.ZoneInteraction" id="net.psforever.objects.zones.ZoneInteraction" class="extype">ZoneInteraction</a></span></span><p class="shortcomment cmt">This game entity may infrequently test whether it may interact with radiation cloud projectiles
that may be emitted in the game environment for a limited amount of time.</p></li><li class="indented0 " name="net.psforever.objects.ballistics.Projectile" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ProjectileextendsPlanetSideGameObjectwithBlockMapEntitywithProductwithSerializable" class="anchorToMember"></a><a id="Projectile:Projectile" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/Projectile.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Projectile.html" title="A summation of weapon discharge."><span class="name">Projectile</span></a><span class="params">(<span name="profile">profile: <a href="../definition/ProjectileDefinition.html" name="net.psforever.objects.definition.ProjectileDefinition" id="net.psforever.objects.definition.ProjectileDefinition" class="extype">ProjectileDefinition</a></span>, <span name="tool_def">tool_def: <a href="../definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span>, <span name="fire_mode">fire_mode: <a href="../equipment/FireModeDefinition.html" name="net.psforever.objects.equipment.FireModeDefinition" id="net.psforever.objects.equipment.FireModeDefinition" class="extype">FireModeDefinition</a></span>, <span name="mounted_in">mounted_in: <span name="scala.Option" class="extype">Option</span>[(<span name="scala.Int" class="extype">Int</span>, <a href="../sourcing/SourceEntry.html" name="net.psforever.objects.sourcing.SourceEntry" id="net.psforever.objects.sourcing.SourceEntry" class="extype">SourceEntry</a>)]</span>, <span name="owner">owner: <a href="../sourcing/SourceEntry.html" name="net.psforever.objects.sourcing.SourceEntry" id="net.psforever.objects.sourcing.SourceEntry" class="extype">SourceEntry</a></span>, <span name="attribute_to">attribute_to: <span name="scala.Int" class="extype">Int</span></span>, <span name="shot_origin">shot_origin: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="shot_angle">shot_angle: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="shot_velocity">shot_velocity: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span>, <span name="quality">quality: <a href="ProjectileQuality.html" name="net.psforever.objects.ballistics.ProjectileQuality" id="net.psforever.objects.ballistics.ProjectileQuality" class="extype">ProjectileQuality</a> = <span class="symbol"><span class="name"><a href="ProjectileQuality$.html">ProjectileQuality.Normal</a></span></span></span>, <span name="id">id: <span name="scala.Long" class="extype">Long</span> = <span class="defval"><span class="name"><a href="Projectile$.html">Projectile.idGenerator.getAndIncrement()</a></span></span></span>, <span name="fire_time">fire_time: <span name="scala.Long" class="extype">Long</span> = <span class="symbol">System.currentTimeMillis()</span></span>)</span><span class="result"> extends <a href="../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">A summation of weapon discharge.</p><div class="fullcomment"><div clas
most often a player (<code>PlayerSource</code>)</p></dd><dt class="param">attribute_to</dt><dd class="cmt"><p>an object ID that refers to the method of death that would be reported;
usually the same as <code>tool_def.ObjectId</code>;
if not, then it is a type of vehicle (and owner should have a positive <code>seated</code> field)</p></dd><dt class="param">shot_origin</dt><dd class="cmt"><p>where the projectile started</p></dd><dt class="param">shot_angle</dt><dd class="cmt"><p>in which direction the projectile was aimed when it was discharged</p></dd><dt class="param">shot_velocity</dt><dd class="cmt"><p>the initial velocity coordinates of the projectile according to its world directions</p></dd><dt class="param">quality</dt><dd class="cmt"><p>na</p></dd><dt class="param">id</dt><dd class="cmt"><p>an exclusive identifier for this projectile;
normally generated internally, but can be manually set (for modifying a continuous projectile reference)</p></dd><dt class="param">fire_time</dt><dd class="cmt"><p>when the weapon discharged was recorded;
defaults to <code>System.currentTimeMillis()</code></p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ProjectileDefinition</code></p></span><span class="cmt"><p><code>ToolDefinition</code></p></span><span class="cmt"><p><code>FireModeDefinition</code></p></span><span class="cmt"><p><code>SourceEntry</code></p></span><span class="cmt"><p><code>PlayerSource</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ballistics.ProjectileQuality" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ProjectileQualityextendsAnyRef" class="anchorToMember"></a><a id="ProjectileQuality:ProjectileQuality" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/ProjectileQuality.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="ProjectileQuality.html" title="Projectile quality is an external aspect of projectiles that is not dependent on hard-coded definitions of the entities used to compose the projectile such as the knowlegde of the emitting Tool (weapon)."><span class="name">ProjectileQuality</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Projectile quality is an external aspect of projectiles
that is not dependent on hard-coded definitions of the entities
used to compose the projectile such as the knowlegde of the emitting <code>Tool</code> (weapon).</p><div class="fullcomment"><div class="comment cmt"><p>Projectile quality is an external aspect of projectiles
that is not dependent on hard-coded definitions of the entities
used to compose the projectile such as the knowlegde of the emitting <code>Tool</code> (weapon).
A flag or a damage modifier, depending on use.
To the extent that it can be used as a numeric modifier,
insists on defining a numeric modifier component rather to what it is trying to express.
That numeric modifier does not have to be used for anything.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.ballistics.SameAsQuality" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SameAsQualityextendsProjectileQuality" class="anchorToMember"></a><a id="SameAsQuality:SameAsQuality" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/SameAsQuality.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="SameAsQuality.html" title="Implement the numeric modifier with the value as one."><span class="name">SameAsQuality</span></a><span class="result"> extends <a href="ProjectileQuality.html" name="net.psforever.objects.ballistics.ProjectileQuality" id="net.psforever.objects.ballistics.ProjectileQuality" class="extype">ProjectileQuality</a></span></span><p class="shortcomment cmt">Implement the numeric modifier with the value as one.</p></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.ballistics.AggravatedDamage" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AggravatedDamage" class="anchorToMember"></a><a id="AggravatedDamage:AggravatedDamage" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/AggravatedDamage$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="AggravatedDamage$.html" title=""><span class="name">AggravatedDamage</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.ballistics.AggravatedTiming" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AggravatedTiming" class="anchorToMember"></a><a id="AggravatedTiming:AggravatedTiming" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/AggravatedTiming$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="AggravatedTiming$.html" title=""><span class="name">AggravatedTiming</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.ballistics.Projectile" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Projectile" class="anchorToMember"></a><a id="Projectile:Projectile" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/Projectile$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="Projectile$.html" title=""><span class="name">Projectile</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.ballistics.ProjectileQuality" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ProjectileQuality" class="anchorToMember"></a><a id="ProjectileQuality:ProjectileQuality" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/ballistics/ProjectileQuality$.html" title="Permalink"><i class="material-