PSF-LoginServer/net/psforever/services/local/LocalService.html

13 lines
49 KiB
HTML
Raw 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.services.local.LocalService</title><meta content="PSF - LoginServer - master - net.psforever.services.local.LocalService" name="description"/><meta content="PSF LoginServer master net.psforever.services.local.LocalService" 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_"></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.services" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="services"></a><a id="services:services"></a> <span class="permalink"><a href="../../../../net/psforever/services/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">services</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.services.local" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="local"></a><a id="local:local"></a> <span class="permalink"><a href="../../../../net/psforever/services/local/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">local</span></a></span
<br>
The primary distribution task instructs all clients to eliminate the target deployable.</p><div class="fullcomment"><div class="comment cmt"><p>Common behavior for distributing information about a deployable's destruction or deconstruction.<br>
<br>
The primary distribution task instructs all clients to eliminate the target deployable.
This is a cosmetic exercise as the deployable should already be unregistered from its zone and
functionally removed from its zone's list of deployable objects by external operations.
The other distribution is a targeted message sent to the former owner of the deployable
if he still exists on the server
to clean up any leftover ownership-specific knowledge about the deployable.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the deployable object</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the deployable objects globally unique identifier;
may be a former identifier</p></dd><dt class="param">position</dt><dd class="cmt"><p>the deployable's position</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>DeployableRemover</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.local.LocalService#LocalEvents" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LocalEvents:net.psforever.services.GenericEventBus[net.psforever.services.local.LocalServiceResponse]"></a><a id="LocalEvents:GenericEventBus[LocalServiceResponse]"></a> <span class="permalink"><a href="../../../../net/psforever/services/local/LocalService.html#LocalEvents:net.psforever.services.GenericEventBus[net.psforever.services.local.LocalServiceResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">LocalEvents</span><span class="result">: <a href="../GenericEventBus.html" name="net.psforever.services.GenericEventBus" id="net.psforever.services.GenericEventBus" class="extype">GenericEventBus</a>[<a href="LocalServiceResponse.html" name="net.psforever.services.local.LocalServiceResponse" id="net.psforever.services.local.LocalServiceResponse" class="extype">LocalServiceResponse</a>]</span></span></li><li class="indented0 " name="net.psforever.services.local.LocalService#RouterTelepadError" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RouterTelepadError(telepad:net.psforever.objects.TelepadDeployable,msg:String):Unit"></a><a id="RouterTelepadError(TelepadDeployable,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/local/LocalService.html#RouterTelepadError(telepad:net.psforever.objects.TelepadDeployable,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">RouterTelepadError</span><span class="params">(<span name="telepad">telepad: <a href="../../objects/TelepadDeployable.html" name="net.psforever.objects.TelepadDeployable" id="net.psforever.objects.TelepadDeployable" class="extype">TelepadDeployable</a></span>, <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">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">telepad</dt><dd class="cmt"><p>na</p></dd><dt class="param">msg</dt><dd class="cmt"><p>na</p></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/services/local/LocalService.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