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

14 lines
113 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.vital</title><meta content="PSF - LoginServer - master - net.psforever.objects.vital" name="description"/><meta content="PSF LoginServer master net.psforever.objects.vital" 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="
Must keep track of the time (ms) the activity occurred.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.vital.InGameHistory" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="InGameHistoryextendsAnyRef" class="anchorToMember"></a><a id="InGameHistory:InGameHistory" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/InGameHistory.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="InGameHistory.html" title=""><span class="name">InGameHistory</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></li><li class="indented0 " name="net.psforever.objects.vital.PlayerSuicide" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PlayerSuicideextendsDamagingActivitywithProductwithSerializable" class="anchorToMember"></a><a id="PlayerSuicide:PlayerSuicide" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/PlayerSuicide.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="PlayerSuicide.html" title=""><span class="name">PlayerSuicide</span></a><span class="params">(<span name="player">player: <a href="../sourcing/PlayerSource.html" name="net.psforever.objects.sourcing.PlayerSource" id="net.psforever.objects.sourcing.PlayerSource" class="extype">PlayerSource</a></span>)</span><span class="result"> extends <a href="DamagingActivity.html" name="net.psforever.objects.vital.DamagingActivity" id="net.psforever.objects.vital.DamagingActivity" class="extype">DamagingActivity</a> with <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.vital.ReconstructionActivity" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ReconstructionActivityextendsGeneralActivitywithProductwithSerializable" class="anchorToMember"></a><a id="ReconstructionActivity:ReconstructionActivity" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/ReconstructionActivity.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="ReconstructionActivity.html" title=""><span class="name">ReconstructionActivity</span></a><span class="params">(<span name="src">src: <a href="../sourcing/SourceEntry.html" name="net.psforever.objects.sourcing.SourceEntry" id="net.psforever.objects.sourcing.SourceEntry" class="extype">SourceEntry</a></span>, <span name="zoneNumber">zoneNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="unit">unit: <span name="scala.Option" class="extype">Option</span>[<a href="../sourcing/SourceEntry.html" name="net.psforever.objects.sourcing.SourceEntry" id="net.psforever.objects.sourcing.SourceEntry" class="extype">SourceEntry</a>]</span>)</span><span class="result"> extends <a href="GeneralActivity.html" name="net.psforever.objects.vital.GeneralActivity" id="net.psforever.objects.vital.GeneralActivity" class="extype">GeneralActivity</a> with <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.vital.RepairFromAmenityAutoRepair" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="RepairFromAmenityAutoRepairextendsRepairingActivitywithProductwithSerializable" class="anchorToMember"></a><a id="RepairFromAmenityAutoRepair:RepairFromAmenityAutoRepair" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/RepairFromAm
The amount of HDHR is controlled by the damage model of this vital object reacting to stimulus.
The damage model is provided.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.vital.VitalityDefinition" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="VitalityDefinitionextendsDamageModifiers" class="anchorToMember"></a><a id="VitalityDefinition:VitalityDefinition" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/VitalityDefinition.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="VitalityDefinition.html" title="na The expected (but not enforced) relationship between values follows: 0 &lt;= DamageDestroysAt &lt;= DamageDisablesAt &lt; RepairRestoresAt &lt;= MaxHealth."><span class="name">VitalityDefinition</span></a><span class="result"> extends <a href="base/DamageModifiers.html" name="net.psforever.objects.vital.base.DamageModifiers" id="net.psforever.objects.vital.base.DamageModifiers" class="extype">DamageModifiers</a></span></span><p class="shortcomment cmt">na<br>
<br>
The expected (but not enforced) relationship between values follows:
<code>0 &lt;= DamageDestroysAt &lt;= DamageDisablesAt &lt; RepairRestoresAt &lt;= MaxHealth</code>.</p></li><li class="indented0 " name="net.psforever.objects.vital.VitalsActivity" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="VitalsActivityextendsInGameActivity" class="anchorToMember"></a><a id="VitalsActivity:VitalsActivity" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/VitalsActivity.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="VitalsActivity.html" title="A vital entity can be hurt or damaged or healed or repaired (HDHR). Shields are not included in the definition of what is a &quot;vital statistic&quot;, and that includes Infantry shields due to the Personal Shield implant and MAX shields due to being a New Conglomerate soldier."><span class="name">VitalsActivity</span></a><span class="result"> extends <a href="InGameActivity.html" name="net.psforever.objects.vital.InGameActivity" id="net.psforever.objects.vital.InGameActivity" class="extype">InGameActivity</a></span></span><p class="shortcomment cmt">A vital entity can be hurt or damaged or healed or repaired (HDHR).<br>
Shields are not included in the definition of what is a "vital statistic",
and that includes Infantry shields due to the Personal Shield implant
and MAX shields due to being a New Conglomerate soldier.</p></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.vital.AmenityHitResistance" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AmenityHitResistance" class="anchorToMember"></a><a id="AmenityHitResistance:AmenityHitResistance" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/AmenityHitResistance$.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="AmenityHitResistance$.html" title=""><span class="name">AmenityHitResistance</span></a><span class="result"> extends <a href="resistance/ResistanceCalculations.html" name="net.psforever.objects.vital.resistance.ResistanceCalculations" id="net.psforever.objects.vital.resistance.ResistanceCalculations" class="extype">ResistanceCalculations</a>[<a href="../sourcing/ObjectSource.html" name="net.psforever.objects.sourcing.ObjectSource" id="net.psforever.objects.sourcing.ObjectSource" class="extype">ObjectSource</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.vital.AmenitySplashResistance" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AmenitySplashResistance" class="anchorToMember"></a><a id="AmenitySplashResistance:AmenitySplashResistance" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/AmenitySplashResistance$.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="AmenitySplashResistance$.html" title=""><span class="name">AmenitySplashResistance</span></a><span class="result"> extends <a href="resistance/ResistanceCalculations.html" name="net.psforever.objects.vital.resistance.ResistanceCalculations" id="net.psforever.objects.vital.resistance.ResistanceCalculations" class="extype">ResistanceCalculations</a>[<a href="../sourcing/ObjectSource.html" name="net.psforever.objects.sourcing.ObjectSource" id="net.psforever.objects.sourcing.ObjectSource" class="extype">ObjectSource</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.vital.AnyResolutions" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AnyResolutions" class="anchorToMember"></a><a id="AnyResolutions:AnyResolutions" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/AnyResolutions$.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="AnyResolutions$.html" title=""><span class="name">AnyResolutions</span></a><span class="result"> extends <a href="resolution/DamageResistanceCalculations.html" name="net.psforever.objects.vital.resolution.DamageResistanceCalculations" id="net.psforever.objects.vital.resolution.DamageResistanceCalculations" class="extype">DamageResistanceCalculations</a>[<span name="scala.Any" class="extype">Any</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.vital.BfrResolutions" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BfrResolutions" class="anchorToMember"></a><a id="BfrResolutions:BfrResolutions" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vital/BfrResolutions$.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="BfrResolutions$.html" title=""><span class="name">BfrResolutions</span></a><span class="result"> extends <a href="resolution/DamageResistanceCalculations.html" name="net.psforever.objects.vital.resolution.DamageResistanceC