PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-07-11 06:24:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deploying to gh-pages from @ psforever/PSF-LoginServer@cbb48d1442 🚀

Browse source
This commit is contained in:
Fate-JH 2021-05-06 11:35:16 +00:00
parent 9cc655366f
commit 585cac1b7e
22 changed files with 28 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
net/psforever/objects/TrapDeployableControl.html
View file

@ -21,7 +21,7 @@ Needs declaration in lowest implementing code.</p></div><dl class="paramcmts blo
By default, only take an interest in the change of "health".
If implementing custom <code>DamageableAmenity</code> with no new message handling, choose to override this method.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity to be damaged</p></dd><dt class="param">applyDamageTo</dt><dd class="cmt"><p>the function that applies the damage to the target in a target-tailored fashion</p></dd></dl><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="serverobject/damage/DamageableEntity.html" name="net.psforever.objects.serverobject.damage.DamageableEntity" id="net.psforever.objects.serverobject.damage.DamageableEntity" class="extype">DamageableEntity</a> → <a href="serverobject/damage/Damageable.html" name="net.psforever.objects.serverobject.damage.Damageable" id="net.psforever.objects.serverobject.damage.Damageable" class="extype">Damageable</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>DamageableAmenity.TakesDamage</code></p></span><span class="cmt"><p><code>ResolutionCalculations.Output</code></p></span><span class="cmt"><p><code>Vitality.Health</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.repair.RepairableEntity#PerformRepairs" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="PerformRepairs(target:net.psforever.objects.serverobject.repair.Repairable.Target,amount:Int):Int"></a><a id="PerformRepairs(Target,Int):Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#PerformRepairs(target:net.psforever.objects.serverobject.repair.Repairable.Target,amount:Int):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">PerformRepairs</span><span class="params">(<span name="target">target: <a href="serverobject/repair/Repairable$.html#Target=net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vital.Vitality" name="net.psforever.objects.serverobject.repair.Repairable.Target" id="net.psforever.objects.serverobject.repair.Repairable.Target" class="extmbr">Target</a></span>, <span name="amount">amount: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="serverobject/repair/RepairableEntity.html" name="net.psforever.objects.serverobject.repair.RepairableEntity" id="net.psforever.objects.serverobject.repair.RepairableEntity" class="extype">RepairableEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.repair.RepairableEntity#PerformRepairs" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="PerformRepairs(target:net.psforever.objects.serverobject.repair.Repairable.Target,player:net.psforever.objects.Player,item:net.psforever.objects.Tool):Unit"></a><a id="PerformRepairs(Target,Player,Tool):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#PerformRepairs(target:net.psforever.objects.serverobject.repair.Repairable.Target,player:net.psforever.objects.Player,item:net.psforever.objects.Tool):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">PerformRepairs</span><span class="params">(<span name="target">target: <a href="serverobject/repair/Repairable$.html#Target=net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vital.Vitality" name="net.psforever.objects.serverobject.repair.Repairable.Target" id="net.psforever.objects.serverobject.repair.Repairable.Target" class="extmbr">Target</a></span>, <span name="player">player: <a href="Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="item">item: <a href="Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Calculate the health points change and enact that repair action if the targets are stationary.</p><div class="fullcomment"><div class="comment cmt"><p>Calculate the health points change and enact that repair action if the targets are stationary.
Restore the target entity to a not destroyed state if applicable.
Always show the repair progress bar window by using the appropriate packet.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity being repaired</p></dd><dt class="param">player</dt><dd class="cmt"><p>the user of the nano dispenser tool</p></dd><dt class="param">item</dt><dd class="cmt"><p>the nano dispenser tool</p></dd></dl><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="serverobject/repair/RepairableEntity.html" name="net.psforever.objects.serverobject.repair.RepairableEntity" id="net.psforever.objects.serverobject.repair.RepairableEntity" class="extype">RepairableEntity</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>AvatarAction.PlanetsideAttributeToAll</code></p></span><span class="cmt"><p><code>AvatarAction.SendResponse</code></p></span><span class="cmt"><p><code>AvatarService</code></p></span><span class="cmt"><p><code>InventoryStateMessage</code></p></span><span class="cmt"><p><code>PlanetSideGameObject.isMoving</code></p></span><span class="cmt"><p><code>RepairMessage</code></p></span><span class="cmt"><p><code>Service.defaultPlayerGUID</code></p></span><span class="cmt"><p><code>Tool.Discharge</code></p></span><span class="cmt"><p><code>Zone.AvatarEvents</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.repair.RepairableEntity#RepairValue" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RepairValue(item:net.psforever.objects.Tool):Int"></a><a id="RepairValue(Tool):Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#RepairValue(item:net.psforever.objects.Tool):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">RepairValue</span><span class="params">(<span name="item">item: <a href="Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">The amount of repair that any specific tool provides.</p><div class="fullcomment"><div class="comment cmt"><p>The amount of repair that any specific tool provides.</p></div><dl class="paramcmts block"><dt class="param">item</dt><dd class="cmt"><p>the tool in question</p></dd><dt>returns</dt><dd class="cmt"><p>an amount to add to the repair attempt progress</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/repair/RepairableEntity.html" name="net.psforever.objects.serverobject.repair.RepairableEntity" id="net.psforever.objects.serverobject.repair.RepairableEntity" class="extype">RepairableEntity</a> → <a href="serverobject/repair/Repairable.html" name="net.psforever.objects.serverobject.repair.Repairable" id="net.psforever.objects.serverobject.repair.Repairable" class="extype">Repairable</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>Repairable.Quality</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.TrapDeployableControl#RepairableObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RepairableObject:net.psforever.objects.TrapDeployable"></a><a id="RepairableObject:TrapDeployable"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#RepairableObject:net.psforever.objects.TrapDeployable" 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">RepairableObject</span><span class="result">: <a href="TrapDeployable.html" name="net.psforever.objects.TrapDeployable" id="net.psforever.objects.TrapDeployable" class="extype">TrapDeployable</a></span></span><p class="shortcomment cmt">Contextual access to the object being the target of this damage.</p><div class="fullcomment"><div class="comment cmt"><p>Contextual access to the object being the target of this damage.
Always show the repair progress bar window by using the appropriate packet.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity being repaired</p></dd><dt class="param">player</dt><dd class="cmt"><p>the user of the nano dispenser tool</p></dd><dt class="param">item</dt><dd class="cmt"><p>the nano dispenser tool</p></dd></dl><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="serverobject/repair/RepairableEntity.html" name="net.psforever.objects.serverobject.repair.RepairableEntity" id="net.psforever.objects.serverobject.repair.RepairableEntity" class="extype">RepairableEntity</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>AvatarAction.PlanetsideAttributeToAll</code></p></span><span class="cmt"><p><code>AvatarAction.SendResponse</code></p></span><span class="cmt"><p><code>AvatarService</code></p></span><span class="cmt"><p><code>InventoryStateMessage</code></p></span><span class="cmt"><p><code>PlanetSideGameObject.isMoving</code></p></span><span class="cmt"><p><code>RepairMessage</code></p></span><span class="cmt"><p><code>Service.defaultPlayerGUID</code></p></span><span class="cmt"><p><code>Tool.Discharge</code></p></span><span class="cmt"><p><code>Zone.AvatarEvents</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.repair.Repairable#RepairToolValue" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RepairToolValue(item:net.psforever.objects.Tool):Float"></a><a id="RepairToolValue(Tool):Float"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#RepairToolValue(item:net.psforever.objects.Tool):Float" 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">RepairToolValue</span><span class="params">(<span name="item">item: <a href="Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a></span>)</span><span class="result">: <span name="scala.Float" class="extype">Float</span></span></span><p class="shortcomment cmt">The amount of repair that any specific tool provides.</p><div class="fullcomment"><div class="comment cmt"><p>The amount of repair that any specific tool provides.</p></div><dl class="paramcmts block"><dt class="param">item</dt><dd class="cmt"><p>the tool in question</p></dd><dt>returns</dt><dd class="cmt"><p>an amount to add to the repair attempt progress</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/repair/Repairable.html" name="net.psforever.objects.serverobject.repair.Repairable" id="net.psforever.objects.serverobject.repair.Repairable" class="extype">Repairable</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>Repairable.Quality</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.TrapDeployableControl#RepairableObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RepairableObject:net.psforever.objects.TrapDeployable"></a><a id="RepairableObject:TrapDeployable"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#RepairableObject:net.psforever.objects.TrapDeployable" 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">RepairableObject</span><span class="result">: <a href="TrapDeployable.html" name="net.psforever.objects.TrapDeployable" id="net.psforever.objects.TrapDeployable" class="extype">TrapDeployable</a></span></span><p class="shortcomment cmt">Contextual access to the object being the target of this damage.</p><div class="fullcomment"><div class="comment cmt"><p>Contextual access to the object being the target of this damage.
Needs declaration in lowest implementing code.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the entity controlled by this actor</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.TrapDeployableControl" id="net.psforever.objects.TrapDeployableControl" class="extype">TrapDeployableControl</a> → <a href="serverobject/repair/Repairable.html" name="net.psforever.objects.serverobject.repair.Repairable" id="net.psforever.objects.serverobject.repair.Repairable" class="extype">Repairable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.repair.Repairable#Restoration" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Restoration(obj:net.psforever.objects.serverobject.repair.Repairable.Target):Unit"></a><a id="Restoration(Target):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#Restoration(obj:net.psforever.objects.serverobject.repair.Repairable.Target):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">Restoration</span><span class="params">(<span name="obj">obj: <a href="serverobject/repair/Repairable$.html#Target=net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vital.Vitality" name="net.psforever.objects.serverobject.repair.Repairable.Target" id="net.psforever.objects.serverobject.repair.Repairable.Target" class="extmbr">Target</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The entity is no longer destroyed.</p><div class="fullcomment"><div class="comment cmt"><p>The entity is no longer destroyed.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the entity</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/repair/Repairable.html" name="net.psforever.objects.serverobject.repair.Repairable" id="net.psforever.objects.serverobject.repair.Repairable" class="extype">Repairable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.damage.DamageableEntity#WillAffectTarget" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="WillAffectTarget(target:net.psforever.objects.serverobject.damage.Damageable.Target,damage:Int,cause:net.psforever.objects.vital.interaction.DamageResult):Boolean"></a><a id="WillAffectTarget(Target,Int,DamageResult):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/TrapDeployableControl.html#WillAffectTarget(target:net.psforever.objects.serverobject.damage.Damageable.Target,damage:Int,cause:net.psforever.objects.vital.interaction.DamageResult):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">WillAffectTarget</span><span class="params">(<span name="target">target: <a href="serverobject/damage/Damageable$.html#Target=net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.vital.Vitality" name="net.psforever.objects.serverobject.damage.Damageable.Target" id="net.psforever.objects.serverobject.damage.Damageable.Target" class="extmbr">Target</a></span>, <span name="damage">damage: <span name="scala.Int" class="extype">Int</span></span>, <span name="cause">cause: <a href="vital/interaction/DamageResult.html" name="net.psforever.objects.vital.interaction.DamageResult" id="net.psforever.objects.vital.interaction.DamageResult" class="extype">DamageResult</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Does the damage or the projectile that caused the damage offer any reason
to execute the reminder of damage resolution considerations?
The projectile causing additional affects, e.g., jamming, should be tested here, when applicable.</p><div class="fullcomment"><div class="comment cmt"><p>Does the damage or the projectile that caused the damage offer any reason