PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-04-27 23:35:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/zones/Zone$$Population$.html

12 lines
40 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<!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.zones.Zone.Population</title><meta content="PSF - LoginServer - master - net.psforever.objects.zones.Zone.Population" name="description"/><meta content="PSF LoginServer master net.psforever.objects.zones.Zone.Population" 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.zones" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="zones"></a><a id="zones:zones"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/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">zones</span></a></span><div cl
That user will be counted as part of that zone's population.
The <code>avatar</code> may associate <code>Player</code> objects with itself in the future.</p></div><dl class="paramcmts block"><dt class="param">avatar</dt><dd class="cmt"><p>the <code>Avatar</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.Zone.Population.Leave" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LeaveextendsProductwithSerializable"></a><a id="Leave:Leave"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$$Leave.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Zone$$Population$$Leave.html" title="Message that excuses a user, by their Avatar, into a Zone."><span class="name">Leave</span></a><span class="params">(<span name="avatar">avatar: <a href="../avatar/Avatar.html" name="net.psforever.objects.avatar.Avatar" id="net.psforever.objects.avatar.Avatar" class="extype">Avatar</a></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message that excuses a user, by their <code>Avatar</code>, into a <code>Zone</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Message that excuses a user, by their <code>Avatar</code>, into a <code>Zone</code>.
That user will not longer be counted as part of that zone's population.</p></div><dl class="paramcmts block"><dt class="param">avatar</dt><dd class="cmt"><p>the <code>Avatar</code> object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>PlayerHasLeft</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.Zone.Population.PlayerAlreadySpawned" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayerAlreadySpawnedextendsProductwithSerializable"></a><a id="PlayerAlreadySpawned:PlayerAlreadySpawned"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$$PlayerAlreadySpawned.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Zone$$Population$$PlayerAlreadySpawned.html" title="Message that acts in reply to Spawn(avatar, player), but the avatar already has a player."><span class="name">PlayerAlreadySpawned</span></a><span class="params">(<span name="zone">zone: <a href="Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</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><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message that acts in reply to <code>Spawn(avatar, player)</code>, but the avatar already has a player.</p><div class="fullcomment"><div class="comment cmt"><p>Message that acts in reply to <code>Spawn(avatar, player)</code>, but the avatar already has a player.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the <code>Player</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.Zone.Population.PlayerCanNotSpawn" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayerCanNotSpawnextendsProductwithSerializable"></a><a id="PlayerCanNotSpawn:PlayerCanNotSpawn"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$$PlayerCanNotSpawn.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Zone$$Population$$PlayerCanNotSpawn.html" title="Message that acts in reply to Spawn(avatar, player), but the avatar did not initially Join this zone."><span class="name">PlayerCanNotSpawn</span></a><span class="params">(<span name="zone">zone: <a href="Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</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><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message that acts in reply to <code>Spawn(avatar, player)</code>, but the avatar did not initially <code>Join</code> this zone.</p><div class="fullcomment"><div class="comment cmt"><p>Message that acts in reply to <code>Spawn(avatar, player)</code>, but the avatar did not initially <code>Join</code> this zone.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>the <code>Zone</code> object</p></dd><dt class="param">player</dt><dd class="cmt"><p>the <code>Player</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.Zone.Population.PlayerHasLeft" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayerHasLe
In the former case, the avatar will have successfully left the zone, and <code>player</code> may be defined.
In the latter case, the avatar did not initially <code>Join</code> the zone, and <code>player</code> is <code>None</code>.
This message should not be considered a failure or a success case.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>the <code>Zone</code> object</p></dd><dt class="param">player</dt><dd class="cmt"><p>the <code>Player</code> object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Release</code><br>
<code>Leave</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.Zone.Population.Release" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ReleaseextendsProductwithSerializable"></a><a id="Release:Release"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$$Release.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Zone$$Population$$Release.html" title="Message that instructs the zone to disassociate a Player from this Actor."><span class="name">Release</span></a><span class="params">(<span name="avatar">avatar: <a href="../avatar/Avatar.html" name="net.psforever.objects.avatar.Avatar" id="net.psforever.objects.avatar.Avatar" class="extype">Avatar</a></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message that instructs the zone to disassociate a <code>Player</code> from this <code>Actor</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Message that instructs the zone to disassociate a <code>Player</code> from this <code>Actor</code>.</p></div><dl class="paramcmts block"><dt class="param">avatar</dt><dd class="cmt"><p>the <code>Avatar</code> object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>PlayerHasLeft</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.Zone.Population.Spawn" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SpawnextendsProductwithSerializable"></a><a id="Spawn:Spawn"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$$Spawn.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Zone$$Population$$Spawn.html" title="Message that instructs the zone to disassociate a Player from this Actor."><span class="name">Spawn</span></a><span class="params">(<span name="avatar">avatar: <a href="../avatar/Avatar.html" name="net.psforever.objects.avatar.Avatar" id="net.psforever.objects.avatar.Avatar" class="extype">Avatar</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="avatarActor">avatarActor: <span name="akka.actor.typed.ActorRef" class="extype">ActorRef</span>[<a href="../../actors/session/AvatarActor$$Command.html" name="net.psforever.actors.session.AvatarActor.Command" id="net.psforever.actors.session.AvatarActor.Command" class="extype">Command</a>]</span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Message that instructs the zone to disassociate a <code>Player</code> from this <code>Actor</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Message that instructs the zone to disassociate a <code>Player</code> from this <code>Actor</code>.
</p></div><dl class="paramcmts block"><dt class="param">avatar</dt><dd class="cmt"><p>the <code>Avatar</code> object</p></dd><dt class="param">player</dt><dd class="cmt"><p>the <code>Player</code> object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>PlayerAlreadySpawned</code><br>
<code>PlayerCanNotSpawn</code></p></span></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$.html#!=(x$1:Any):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" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$.html###:Int" 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" title="gt4s: $hash$hash">##</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></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$.html#==(x$1:Any):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" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$.html#asInstanceOf[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">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/Zone$$Population$.html#clone():Object" 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">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</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><
Reference in a new issue Copy permalink