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

20 lines
54 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.objects.serverobject</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject" 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.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 measure of synchronization can be managed using this <code>Actor</code> as a "controlling agent."
</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.ServerObjectBuilder" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ServerObjectBuilder[A&lt;:net.psforever.objects.serverobject.PlanetSideServerObject]extendsAnyRef"></a><a id="ServerObjectBuilder[A&lt;:PlanetSideServerObject]:ServerObjectBuilder[A]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/ServerObjectBuilder.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="ServerObjectBuilder.html" title="Customizable native entity instantiation logic at the ZoneMap level."><span class="name">ServerObjectBuilder</span></a><span class="tparams">[<span name="A">A &lt;: <a href="PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a></span>]</span><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Customizable native entity instantiation logic at the <code>ZoneMap</code> level.</p><div class="fullcomment"><div class="comment cmt"><p>Customizable native entity instantiation logic at the <code>ZoneMap</code> level.
Produces environmental constants such as <code>Terminal</code> objects and <code>Door</code> objects.<br>
<br>
<code>ZoneMap</code> is the expected position where this class is defined.
Within <code>Zone.Init</code> is where this class is expected to be fully executed.
The former is a blueprint which provides as many emitted entities based on how many <code>Zone</code> objects utilize it.
<code>constructor</code> is required to have the form <code>(Int, ActorContext) =&gt; A</code> by the point where it executes
due to invocation of the <code>Build</code> method.
For that reason, it must exist in an <code>Actor</code> which has an <code>ActorContext</code> to lend, hence the <code>Zone</code>'s <code>Actor</code>.
Furthermore, the requirement of a <code>NumberPoolHub</code> means the region is accessible to and defined by
a closed number space, which is also the <code>Zone</code>.
It utilizes those qualities of the enclosing region to construct the entity within that region.<br>
<br>
Example: <code>ServerObjectBuilder(n, function)</code><br>
Example: <code>new ServerBuilderObject[A](n, function)</code>, where <code>function</code> is a <code>(Int,Context)=&gt;A</code></p></div><dl class="paramcmts block"><dt class="tparam">A</dt><dd class="cmt"><p>any object that extends from PlanetSideServerObject that will be produced by this class;
can be inferred from the output of <code>constructor</code></p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ZoneMap</code></p></span><span class="cmt"><p><code>Zone.Init</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.ServerObjectControl" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="ServerObjectControlextendsActor"></a><a id="ServerObjectControl:ServerObjectControl"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/ServerObjectControl.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="ServerObjectControl.html" title=""><span class="name">ServerObjectControl</span></a><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span></span></span></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.serverobject.CommonMessages" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="CommonMessages"></a><a id="CommonMessages:CommonMessages"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="CommonMessages$.html" title=""><span class="name">CommonMessages</span></a></span></li><li class="indented0 " name="net.psforever.objects.serverobject.PlanetSideServerObject" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PlanetSideServerObject"></a><a id="PlanetSideServerObject:PlanetSideServerObject"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/PlanetSideServerObject$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="PlanetSideServerObject$.html" title=""><span class="name">PlanetSideServerObject</span></a></span></li><li class="indented0 " name="net.psforever.objects.serverobject.ServerObject" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ServerObject"></a><a id="ServerObject:ServerObject"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/ServerObject$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="ServerObject$.html" title=""><span class="name">ServerObject</span></a></span></li><li class="indented0 " name="net.psforever.objects.serverobject.ServerObjectBuilder" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ServerObjectBuilder"></a><a id="ServerObjectBuilder:ServerObjectBuilder"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/ServerObjectBuilder$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="ServerObjectBuilder$.html" title=""><span class="name">ServerObjectBuilder</span></a></span></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>