PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-04-14 17:05:15 +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/SensorDeployableControl.html
View file

@ -25,7 +25,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/SensorDeployableControl.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/SensorDeployableControl.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/SensorDeployableControl.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.SensorDeployableControl#RepairableObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RepairableObject:net.psforever.objects.SensorDeployable"></a><a id="RepairableObject:SensorDeployable"></a> <span class="permalink"><a href="../../../net/psforever/objects/SensorDeployableControl.html#RepairableObject:net.psforever.objects.SensorDeployable" 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="SensorDeployable.html" name="net.psforever.objects.SensorDeployable" id="net.psforever.objects.SensorDeployable" class="extype">SensorDeployable</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/SensorDeployableControl.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.SensorDeployableControl#RepairableObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RepairableObject:net.psforever.objects.SensorDeployable"></a><a id="RepairableObject:SensorDeployable"></a> <span class="permalink"><a href="../../../net/psforever/objects/SensorDeployableControl.html#RepairableObject:net.psforever.objects.SensorDeployable" 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="SensorDeployable.html" name="net.psforever.objects.SensorDeployable" id="net.psforever.objects.SensorDeployable" class="extype">SensorDeployable</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.SensorDeployableControl" id="net.psforever.objects.SensorDeployableControl" class="extype">SensorDeployableControl</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/SensorDeployableControl.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.SensorDeployableControl#StartJammeredSound" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartJammeredSound(target:Any,dur:Int):Unit"></a><a id="StartJammeredSound(Any,Int):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/SensorDeployableControl.html#StartJammeredSound(target:Any,dur:Int):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">StartJammeredSound</span><span class="params">(<span name="target">target: <span name="scala.Any" class="extype">Any</span></span>, <span name="dur">dur: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Activate a distinctive buzzing sound effect.</p><div class="fullcomment"><div class="comment cmt"><p>Activate a distinctive buzzing sound effect.
Due to considerations of the object that is the target, this is left to be implemented by a subclass.
We merely start the timer.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>an object that can be affected by the jammered status</p></dd><dt class="param">dur</dt><dd class="cmt"><p>the duration of the timer, in milliseconds;