PSF-LoginServer/net/psforever/objects/vital/interaction/index.html

6 lines
23 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.interaction</title><meta content="PSF - LoginServer - master - net.psforever.objects.vital.interaction" name="description"/><meta content="PSF LoginServer master net.psforever.objects.vital.interaction" 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
the object id of the method of punishment, used for reporting</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.interaction.DamageInteraction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DamageInteractionextendsProductwithSerializable"></a><a id="DamageInteraction:DamageInteraction"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/interaction/DamageInteraction.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="DamageInteraction.html" title="The recorded encounter of a damage source and a damageable target."><span class="name">DamageInteraction</span></a><span class="params">(<span name="target">target: <a href="../../ballistics/SourceEntry.html" name="net.psforever.objects.ballistics.SourceEntry" id="net.psforever.objects.ballistics.SourceEntry" class="extype">SourceEntry</a></span>, <span name="hitPos">hitPos: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="cause">cause: <a href="../base/DamageReason.html" name="net.psforever.objects.vital.base.DamageReason" id="net.psforever.objects.vital.base.DamageReason" class="extype">DamageReason</a></span>, <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="hitTime">hitTime: <span name="scala.Long" class="extype">Long</span> = <span class="symbol">System.currentTimeMillis()</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">The recorded encounter of a damage source and a damageable target.</p><div class="fullcomment"><div class="comment cmt"><p>The recorded encounter of a damage source and a damageable target.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the original affected target;
not necessarily the currently affected target</p></dd><dt class="param">hitPos</dt><dd class="cmt"><p>the coordinate location where the damage was inflicted</p></dd><dt class="param">cause</dt><dd class="cmt"><p>the method by which the damage was produced</p></dd><dt class="param">resolution</dt><dd class="cmt"><p>how the damage is being processed</p></dd><dt class="param">hitTime</dt><dd class="cmt"><p>when the interaction originally occurred;
defaults to <code>System.currentTimeMills()</code> at object creation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.interaction.DamageResult" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="DamageResultextendsProductwithSerializable"></a><a id="DamageResult:DamageResult"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/interaction/DamageResult.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="DamageResult.html" title="The outcome of the damage interaction, after all the numbers have been processed and properly applied."><span class="name">DamageResult</span></a><span class="params">(<span name="targetBefore">targetBefore: <a href="../../ballistics/SourceEntry.html" name="net.psforever.objects.ballistics.SourceEntry" id="net.psforever.objects.ballistics.SourceEntry" class="extype">SourceEntry</a></span>, <span name="targetAfter">targetAfter: <a href="../../ballistics/SourceEntry.html" name="net.psforever.objects.ballistics.SourceEntry" id="net.psforever.objects.ballistics.SourceEntry" class="extype">SourceEntry</a></span>, <span name="interaction">interaction: <a href="DamageInteraction.html" name="net.psforever.objects.vital.interaction.DamageInteraction" id="net.psforever.objects.vital.interaction.DamageInteraction" class="extype">DamageInteraction</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><p class="shortcomment cmt">The outcome of the damage interaction, after all the numbers have been processed and properly applied.</p></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.vital.interaction.DamageInteraction" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="DamageInteraction"></a><a id="DamageInteraction:DamageInteraction"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/interaction/DamageInteraction$.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="DamageInteraction$.html" title=""><span class="name">DamageInteraction</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></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>