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

18 lines
26 KiB
HTML

<!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.resistance</title><meta content="PSF - LoginServer - master - net.psforever.objects.vital.resistance" name="description"/><meta content="PSF LoginServer master net.psforever.objects.vital.resistance" 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.vital" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="vital" class="anchorToMember"></a><a id="vital:vital" class="anchorToMember"></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=""><span class="name">vital</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.base" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="base" class="anchorToMember"></a><a id="base:base" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/base/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="../base/index.html" title=""><span class="name">base</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.collision" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="collision" class="anchorToMember"></a><a id="collision:collision" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/collision/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="../collision/index.html" title=""><span class="name">collision</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.damage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="damage" class="anchorToMember"></a><a id="damage:damage" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/damage/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="../damage/index.html" title=""><span class="name">damage</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.environment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="environment" class="anchorToMember"></a><a id="environment:environment" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/environment/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="../environment/index.html" title=""><span class="name">environment</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.etc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="etc" class="anchorToMember"></a><a id="etc:etc" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/etc/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="../etc/index.html" title=""><span class="name">etc</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.interaction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="interaction" class="anchorToMember"></a><a id="interaction:interaction" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/interaction/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="../interaction/index.html" title=""><span class="name">interaction</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.projectile" group="Ungrouped" fullComment="yes" 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/vital/projectile/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="../projectile/index.html" title=""><span class="name">projectile</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.vital.prop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="prop" class="anchorToMember"></a><a id="prop:prop" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/prop/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="../prop/index.html" title=""><span class="name">prop</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="indented5 current" name="net.psforever.objects.vital.resistance" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="resistance" class="anchorToMember"></a><a id="resistance:resistance" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/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"><span class="name">resistance</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li><li class="current-entities indented5"><a href="ResistanceCalculations$.html" title="" class="object"></a> <a href="ResistanceCalculations.html" title="The base for function literal description related to calculating resistance information." class="class"></a><a href="ResistanceCalculations.html" title="The base for function literal description related to calculating resistance information.">ResistanceCalculations</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="ResistanceProfile.html" title="The different values for four common methods of modifying incoming damage." class="trait"></a><a href="ResistanceProfile.html" title="The different values for four common methods of modifying incoming damage.">ResistanceProfile</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="ResistanceProfileMutators.html" title="The different values for four common methods of modifying incoming damage." class="trait"></a><a href="ResistanceProfileMutators.html" title="The different values for four common methods of modifying incoming damage.">ResistanceProfileMutators</a></li><li class="current-entities indented5"><a href="ResistanceSelection$.html" title="" class="object"></a> <a href="ResistanceSelection.html" title="Maintain information about four primary forms of resistance calculation and a means to test which calculation is valid in a given situation." class="trait"></a><a href="ResistanceSelection.html" title="Maintain information about four primary forms of resistance calculation and a means to test which calculation is valid in a given situation.">ResistanceSelection</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="StandardResistanceProfile.html" title="The different values for four common methods of modifying incoming damage." class="trait"></a><a href="StandardResistanceProfile.html" title="The different values for four common methods of modifying incoming damage.">StandardResistanceProfile</a></li><li class="indented5 " name="net.psforever.objects.vital.resolution" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="resolution" class="anchorToMember"></a><a id="resolution:resolution" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resolution/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="../resolution/index.html" title=""><span class="name">resolution</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></dd></dl></div></li></ul></div></div><div id="content"><body class="package value"><div id="definition"><div class="big-circle package">p</div><p id="owner"><a href="../../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a>.<a href="../index.html" name="net.psforever.objects.vital" id="net.psforever.objects.vital" class="extype">vital</a></p><h1>resistance<span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/index.html" title="Permalink"><i class="material-icons"></i></a></span></h1></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">resistance</span></span></h4><div id="comment" class="fullcommenttop"></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="net.psforever.objects.vital.resistance.ResistanceCalculations" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ResistanceCalculations[TargetType]extendsAnyRef" class="anchorToMember"></a><a id="ResistanceCalculations[TargetType]:ResistanceCalculations[TargetType]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/ResistanceCalculations.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="ResistanceCalculations.html" title="The base for function literal description related to calculating resistance information."><span class="name">ResistanceCalculations</span></a><span class="tparams">[<span name="TargetType">TargetType</span>]</span><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">The base for function literal description related to calculating resistance information.</p><div class="fullcomment"><div class="comment cmt"><p>The base for function literal description related to calculating resistance information.
This glue connects target validation to value extraction
to avoid the possibility of <code>NullPointerException</code> and <code>ClassCastException</code>.
Some different types of vital objects store their resistance values in different places.</p></div><dl class="paramcmts block"><dt class="tparam">TargetType</dt><dd class="cmt"><p>an internal type that converts between <code>validate</code>'s output and <code>extractor</code>'s input;
in essence, should match the type of object container to which these resistances belong;
never has to be defined explicitly but will be checked at compile time</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.resistance.ResistanceProfile" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ResistanceProfileextendsAnyRef" class="anchorToMember"></a><a id="ResistanceProfile:ResistanceProfile" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/ResistanceProfile.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="ResistanceProfile.html" title="The different values for four common methods of modifying incoming damage."><span class="name">ResistanceProfile</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">The different values for four common methods of modifying incoming damage.</p><div class="fullcomment"><div class="comment cmt"><p>The different values for four common methods of modifying incoming damage.
Two of the four resistances are directly paired with forms of incoming damage.
This is for defining pure accessor functions.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.vital.resistance.ResistanceProfileMutators" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ResistanceProfileMutatorsextendsResistanceProfile" class="anchorToMember"></a><a id="ResistanceProfileMutators:ResistanceProfileMutators" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/ResistanceProfileMutators.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="ResistanceProfileMutators.html" title="The different values for four common methods of modifying incoming damage."><span class="name">ResistanceProfileMutators</span></a><span class="result"> extends <a href="ResistanceProfile.html" name="net.psforever.objects.vital.resistance.ResistanceProfile" id="net.psforever.objects.vital.resistance.ResistanceProfile" class="extype">ResistanceProfile</a></span></span><p class="shortcomment cmt">The different values for four common methods of modifying incoming damage.</p><div class="fullcomment"><div class="comment cmt"><p>The different values for four common methods of modifying incoming damage.
Two of the four resistances are directly paired with forms of incoming damage.
This is for defining both accessor and mutator functions.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.vital.resistance.ResistanceSelection" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="ResistanceSelectionextendsAnyRef" class="anchorToMember"></a><a id="ResistanceSelection:ResistanceSelection" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/ResistanceSelection.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="ResistanceSelection.html" title="Maintain information about four primary forms of resistance calculation and a means to test which calculation is valid in a given situation."><span class="name">ResistanceSelection</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Maintain information about four primary forms of resistance calculation
and a means to test which calculation is valid in a given situation.</p></li><li class="indented0 " name="net.psforever.objects.vital.resistance.StandardResistanceProfile" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="StandardResistanceProfileextendsResistanceProfile" class="anchorToMember"></a><a id="StandardResistanceProfile:StandardResistanceProfile" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/StandardResistanceProfile.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="StandardResistanceProfile.html" title="The different values for four common methods of modifying incoming damage."><span class="name">StandardResistanceProfile</span></a><span class="result"> extends <a href="ResistanceProfile.html" name="net.psforever.objects.vital.resistance.ResistanceProfile" id="net.psforever.objects.vital.resistance.ResistanceProfile" class="extype">ResistanceProfile</a></span></span><p class="shortcomment cmt">The different values for four common methods of modifying incoming damage.</p><div class="fullcomment"><div class="comment cmt"><p>The different values for four common methods of modifying incoming damage.
Two of the four resistances are directly paired with forms of incoming damage.
This is for defining pure accessor functions,
based on the assumption that the implementing object's <code>Definition</code> is the primary <code>ResistanceProfile</code>.
</p></div></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.vital.resistance.ResistanceCalculations" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ResistanceCalculations" class="anchorToMember"></a><a id="ResistanceCalculations:ResistanceCalculations" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/ResistanceCalculations$.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="ResistanceCalculations$.html" title=""><span class="name">ResistanceCalculations</span></a></span></li><li class="indented0 " name="net.psforever.objects.vital.resistance.ResistanceSelection" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ResistanceSelection" class="anchorToMember"></a><a id="ResistanceSelection:ResistanceSelection" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/vital/resistance/ResistanceSelection$.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="ResistanceSelection$.html" title=""><span class="name">ResistanceSelection</span></a></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>