mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-04-02 19:15:21 +00:00
34 lines
113 KiB
HTML
34 lines
113 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.TelepadDeployableControl</title><meta content="PSF - LoginServer - master - net.psforever.objects.TelepadDeployableControl" name="description"/><meta content="PSF LoginServer master net.psforever.objects.TelepadDeployableControl" 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"><</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.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/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="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
|
||
|
|
The decorator is constructed by the <code>Actor</code> name of the entity, sliced after the last forward/slash.
|
||
|
|
For example, for "foo/bar/name", the decorator is just "name".</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity to be used for the decorator</p></dd><dt class="param">msg</dt><dd class="cmt"><p>the message for the damage log</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></dd><dt>See also</dt><dd><span class="cmt"><p><code>PlanetSideServerObject</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.damage.DamageableEntity#DamageLog" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="DamageLog(msg:String):Unit"></a><a id="DamageLog(String):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#DamageLog(msg:String):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">DamageLog</span><span class="params">(<span name="msg">msg: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Log a damage message.</p><div class="fullcomment"><div class="comment cmt"><p>Log a damage message.</p></div><dl class="paramcmts block"><dt class="param">msg</dt><dd class="cmt"><p>the message for the damage log</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></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.TelepadDeployableControl#DamageableObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DamageableObject:net.psforever.objects.TelepadDeployable"></a><a id="DamageableObject:TelepadDeployable"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#DamageableObject:net.psforever.objects.TelepadDeployable" 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">DamageableObject</span><span class="result">: <a href="TelepadDeployable.html" name="net.psforever.objects.TelepadDeployable" id="net.psforever.objects.TelepadDeployable" class="extype">TelepadDeployable</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.TelepadDeployableControl" id="net.psforever.objects.TelepadDeployableControl" class="extype">TelepadDeployableControl</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></dl></div></li><li class="indented0 " name="net.psforever.objects.TelepadDeployableControl#DeployableObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeployableObject:net.psforever.objects.TelepadDeployable"></a><a id="DeployableObject:TelepadDeployable"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#DeployableObject:net.psforever.objects.TelepadDeployable" 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">DeployableObject</span><span class="result">: <a href="TelepadDeployable.html" name="net.psforever.objects.TelepadDeployable" id="net.psforever.objects.TelepadDeployable" class="extype">TelepadDeployable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.TelepadDeployableControl" id="net.psforever.objects.TelepadDeployableControl" class="extype">TelepadDeployableControl</a> → <a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.TelepadDeployableControl#DestructionAwareness" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="DestructionAwareness(target:net.psforever.objects.serverobject.damage.Damageable.Target,cause:net.psforever.objects.vital.interaction.DamageResult):Unit"></a><a id="DestructionAwareness(Target,DamageResult):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#DestructionAwareness(target:net.psforever.objects.serverobject.damage.Damageable.Target,cause:net.psforever.objects.vital.interaction.DamageResult):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">DestructionAwareness</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="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.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">What happens when the target sustains too much damage and is destroyed.</p><div class="fullcomment"><div class="comment cmt"><p>What happens when the target sustains too much damage and is destroyed.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity being destroyed</p></dd><dt class="param">cause</dt><dd class="cmt"><p>historical information about the damage</p></dd></dl><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.TelepadDeployableControl" id="net.psforever.objects.T
|
||
|
|
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.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/TelepadDeployableControl.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
|
||
|
|
to execute the reminder of damage resolution considerations?
|
||
|
|
The projectile causing additional affects, e.g., jamming, should be tested here, when applicable.
|
||
|
|
Contrast with <code>Vitality.CanDamage</code>.
|
||
|
|
The damage value tested against should be the total value of all meaningful vital statistics affected.</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">damage</dt><dd class="cmt"><p>the amount of damage</p></dd><dt class="param">cause</dt><dd class="cmt"><p>historical information about the damage</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if damage resolution is to be evaluated;
|
||
|
|
<code>false</code>, otherwise</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></dd><dt>See also</dt><dd><span class="cmt"><p><code>Damageable.CanDamageOrJammer</code></p></span><span class="cmt"><p><code>PerformDamage</code></p></span></dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostRestart(reason:Throwable):Unit"></a><a id="aroundPostRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#aroundPostRestart(reason:Throwable):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">aroundPostRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostStop():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#aroundPostStop():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">aroundPostStop</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreRestart(reason:Throwable,message:Option[Any]):Unit"></a><a id="aroundPreRestart(Throwable,Option[Any]):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#aroundPreRestart(reason:Throwable,message:Option[Any]):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">aroundPreRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>, <span name="message">message: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreStart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreStart():Unit
|
||
|
|
Queue up final deployable unregistering, separate from the zone's deployable governance,
|
||
|
|
and instruct all clients in this zone that the deployable is to be deconstructed.
|
||
|
|
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#equals(x$1:Object):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">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#finalize():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">finalize</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.TelepadDeployableControl#finalizeDeployable" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="finalizeDeployable(callback:akka.actor.ActorRef):Unit"></a><a id="finalizeDeployable(ActorRef):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#finalizeDeployable(callback:akka.actor.ActorRef):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">finalizeDeployable</span><span class="params">(<span name="callback">callback: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The second stage of the deployable build process, to complete the formal process.</p><div class="fullcomment"><div class="comment cmt"><p>The second stage of the deployable build process, to complete the formal process.
|
||
|
|
If no owner is assigned, the deployable must immediately begin suffering decay.
|
||
|
|
Nothing dangerous happens if it does not begin to decay, but, because it is not under a player's management,
|
||
|
|
the deployable will not properly transition to a decay state for another reason
|
||
|
|
and can linger in the zone ownerless for as long as it is not destroyed.</p></div><dl class="paramcmts block"><dt class="param">callback</dt><dd class="cmt"><p>an <code>ActorRef</code> used for confirming the deployable's completion of the process</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.TelepadDeployableControl" id="net.psforever.objects.TelepadDeployableControl" class="extype">TelepadDeployableControl</a> → <a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>AvatarAction.DeployItem</code></p></span><span class="cmt"><p><code>DeploymentAction</code></p></span><span class="cmt"><p><code>DeployableInfo</code></p></span><span class="cmt"><p><code>LocalAction.DeployableMapIcon</code></p></span><span class="cmt"><p><code>Zone.Deployable.IsBuilt</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ce.DeployableBehavior#gainOwnership" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="gainOwnership(player:net.psforever.objects.Player,toFaction:net.psforever.types.PlanetSideEmpire.Value):Unit"></a><a id="gainOwnership(Player,types.PlanetSideEmpire.Value):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#gainOwnership(player:net.psforever.objects.Player,toFaction:net.psforever.types.PlanetSideEmpire.Value):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">gainOwnership</span><span class="params">(<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="toFaction">toFaction: <a href="../types/PlanetSideEmpire$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.PlanetSideEmpire.Value" id="net.psforever.types.PlanetSideEmpire.Value" class="extmbr">types.PlanetSideEmpire.Value</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player being given ownership of this deployable</p></dd><dt class="param">toFaction</dt><dd class="cmt"><p>the faction to which the deployable is being assigned;
|
||
|
|
usually matches the <code>player</code>'s own faction</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ce.DeployableBehavior#gainOwnership" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="gainOwnership(player:net.psforever.objects.Player):Unit"></a><a id="gainOwnership(Player):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#gainOwnership(player:net.psforever.objects.Player):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">gainOwnership</span><span class="params">(<span name="player">player: <a href="Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player being given ownership of this deployable</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>gainOwnership(Player, PlanetSideEmpire.Value)</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_<:AnyRef]"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#getClass():Class[_]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ <: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#hashCode():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">hashCode</span><span class="params">()</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ce.DeployableBehavior#isConstructed" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isConstructed:Option[Boolean]"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#isConstructed:Option[Boolean]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><sp
|
||
|
|
and may involve concealing the deployable from the map screen for the entirety of the previous owner's faction.</p><div class="fullcomment"><div class="comment cmt"><p>Losing ownership involves updating map screen UI, to remove management rights from the now-previous owner,
|
||
|
|
and may involve concealing the deployable from the map screen for the entirety of the previous owner's faction.
|
||
|
|
Displaying the deployable on the map screen of another faction may be required.</p></div><dl class="paramcmts block"><dt class="param">toFaction</dt><dd class="cmt"><p>the faction to which to set the deployable to be visualized on the map and in the game world;
|
||
|
|
may also affect deployable operation</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#ne(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#notify():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#notifyAll():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.damage.Damageable#originalTakesDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="originalTakesDamage:akka.actor.Actor.Receive"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#originalTakesDamage:akka.actor.Actor.Receive" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">originalTakesDamage</span><span class="result">: <span name="akka.actor.Actor.Receive" class="extype">akka.actor.Actor.Receive</span></span></span><p class="shortcomment cmt">a duplicate of the core implementation for the default mixin hook, for use in overriding</p><div class="fullcomment"><div class="comment cmt"><p>a duplicate of the core implementation for the default mixin hook, for use in overriding</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><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></dl></div></li><li class="indented0 " name="akka.actor.Actor#postRestart" group="Ungrouped" fullC
|
||
|
|
Deployables, upon construction, may display an animation effect.
|
||
|
|
Parameters are required to be passed onto the next stage of the build process and are not used here.</p></div><dl class="paramcmts block"><dt class="param">callback</dt><dd class="cmt"><p>an <code>ActorRef</code> used for confirming the deployable's completion of the process</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>DeployableDefinition.deployAnimation</code></p></span><span class="cmt"><p><code>DeployableDefinition.DeployTime</code></p></span><span class="cmt"><p><code>LocalAction.TriggerEffectLocation</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.TelepadDeployableControl#startOwnerlessDecay" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="startOwnerlessDecay():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#startOwnerlessDecay():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">startOwnerlessDecay</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.TelepadDeployableControl" id="net.psforever.objects.TelepadDeployableControl" class="extype">TelepadDeployableControl</a> → <a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#supervisorStrategy" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="supervisorStrategy:akka.actor.SupervisorStrategy"></a><a id="supervisorStrategy:SupervisorStrategy"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#supervisorStrategy:akka.actor.SupervisorStrategy" 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">supervisorStrategy</span><span class="result">: <span name="akka.actor.SupervisorStrategy" class="extype">SupervisorStrategy</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](=>T0):T0"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#synchronized[T0](x$1:=>T0):T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: => <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.damage.Damageable#takesDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="takesDamage:akka.actor.Actor.Receive"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#takesDamage:akka.actor.Actor.Receive" title="Permalin
|
||
|
|
<code>orElse</code> onto the "control" <code>Actor</code> <code>receive</code>; or,
|
||
|
|
cite the <code>originalTakesDamage</code> protocol during inheritance overrides</p><div class="fullcomment"><div class="comment cmt"><p>the official mixin hook;
|
||
|
|
<code>orElse</code> onto the "control" <code>Actor</code> <code>receive</code>; or,
|
||
|
|
cite the <code>originalTakesDamage</code> protocol during inheritance overrides</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><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></dl></div></li><li class="indented0 " name="scala.AnyRef#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#toString():String" 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">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#unhandled" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unhandled(message:Any):Unit"></a><a id="unhandled(Any):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#unhandled(message:Any):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">unhandled</span><span class="params">(<span name="message">message: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.ce.DeployableBehavior#unregisterDeployable" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unregisterDeployable(obj:net.psforever.objects.ce.Deployable):Unit"></a><a id="unregisterDeployable(Deployable):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#unregisterDeployable(obj:net.psforever.objects.ce.Deployable):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">unregisterDeployable</span><span class="params">(<span name="obj">obj: <a href="ce/Deployable.html" name="net.psforever.objects.ce.Deployable" id="net.psforever.objects.ce.Deployable" class="extype">Deployable</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The task for unregistering this deployable.</p><div class="fullcomment"><div class="comment cmt"><p>The task for unregistering this deployable.
|
||
|
|
Most deployables are monolithic entities, requiring only a single unique identifier.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the deployable</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ce/DeployableBehavior.html" name="net.psforever.objects.ce.DeployableBehavior" id="net.psforever.objects.ce.DeployableBehavior" class="extype">DeployableBehavior</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#wait():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/TelepadDeployableControl.html#wait(x$1:Long):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="net.psforever.objects.serverobject.damage.DamageableEntity" class="parent"><h3>Inherited from <a href="serverobject/damage/DamageableEntity.html" name="net.psforever.objects.serverobject.damage.DamageableEntity" id="net.psforever.objects.serverobject.damage.DamageableEntity" class="extype">DamageableEntity</a></h3></div><div name="net.psforever.objects.serverobject.damage.Damageable" class="parent"><h3>Inherited from <a href="serverobject/damage/Damageable.html" name="net.psforever.objects.serverobject.damage.Damageable" id="net.psforever.objects.serverobject.damage.Damageable" cla
|