PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-07-14 07:55:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/zones/ZonePopulationActor$.html

13 lines
51 KiB
HTML
Raw Permalink 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.ZonePopulationActor</title><meta content="PSF - LoginServer - master - net.psforever.objects.zones.ZonePopulationActor" name="description"/><meta content="PSF LoginServer master net.psforever.objects.zones.ZonePopulationActor" 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 */
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
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_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></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" class="anchorToMember"></a><a id="net:net" class="anchorToMember"></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" class="anchorToMember"></a><a id="psforever:psforever" class="anchorToMember"></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" class="anchorToMember"></a><a id="objects:objects" class="anchorToMember"></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" class="anchorToMember"></a><a id="zones:zones" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/index.html" title="Permalink"><i class="mater
false, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZonePopulationActor#CorpseRemove" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CorpseRemove(player:net.psforever.objects.Player,corpseList:scala.collection.mutable.ListBuffer[net.psforever.objects.Player]):Boolean" class="anchorToMember"></a><a id="CorpseRemove(Player,ListBuffer[Player]):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.html#CorpseRemove(player:net.psforever.objects.Player,corpseList:scala.collection.mutable.ListBuffer[net.psforever.objects.Player]):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">CorpseRemove</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="corpseList">corpseList: <span name="scala.collection.mutable.ListBuffer" class="extype">ListBuffer</span>[<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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Remove the given <code>player</code> from the list.</p><div class="fullcomment"><div class="comment cmt"><p>Remove the given <code>player</code> from the list.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>a <code>Player</code> object</p></dd><dt class="param">corpseList</dt><dd class="cmt"><p>a list of <code>Player</code> objects</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZonePopulationActor#GetPlayerControlName" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="GetPlayerControlName(player:net.psforever.objects.Player,old:Option[akka.actor.ActorRef]):String" class="anchorToMember"></a><a id="GetPlayerControlName(Player,Option[ActorRef]):String" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.html#GetPlayerControlName(player:net.psforever.objects.Player,old:Option[akka.actor.ActorRef]):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">GetPlayerControlName</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="old">old: <span name="scala.Option" class="extype">Option</span>[<span name="akka.actor.ActorRef" class="extype">ActorRef</span>]</span>)</span><span class="result">: <span name="scala.Predef.String" class="extype">String</span></span></span></li><li class="indented0 " name="net.psforever.objects.zones.ZonePopulationActor#PlayerLeave" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PlayerLeave(player:net.psforever.objects.Player):Unit" class="anchorToMember"></a><a id="PlayerLeave(Player):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.html#PlayerLeave(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">PlayerLeave</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></li><li class="indented0 " name="n
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
</p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>an <code>Avatar</code> id</p></dd><dt class="param">playerMap</dt><dd class="cmt"><p>the mapping of <code>Avatar</code> objects to <code>Player</code> objects</p></dd><dt>returns</dt><dd class="cmt"><p>true, if the mapping is for a new key;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
false, if the key already exists</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZonePopulationActor#PopulationLeave" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PopulationLeave(id:Int,playerMap:scala.collection.concurrent.TrieMap[Int,Option[net.psforever.objects.Player]]):Option[net.psforever.objects.Player]" class="anchorToMember"></a><a id="PopulationLeave(Int,TrieMap[Int,Option[Player]]):Option[Player]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.html#PopulationLeave(id:Int,playerMap:scala.collection.concurrent.TrieMap[Int,Option[net.psforever.objects.Player]]):Option[net.psforever.objects.Player]" 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">PopulationLeave</span><span class="params">(<span name="id">id: <span name="scala.Int" class="extype">Int</span></span>, <span name="playerMap">playerMap: <span name="scala.collection.concurrent.TrieMap" class="extype">TrieMap</span>[<span name="scala.Int" class="extype">Int</span>, <span name="scala.Option" class="extype">Option</span>[<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.Option" class="extype">Option</span>[<a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>]</span></span><p class="shortcomment cmt">Remove an <code>avatar</code> from the key of an <code>Avatar</code> to <code>Player</code> object pair in the given collection.</p><div class="fullcomment"><div class="comment cmt"><p>Remove an <code>avatar</code> from the key of an <code>Avatar</code> to <code>Player</code> object pair in the given collection.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
If a <code>Player</code> object is associated at the time, return it safely.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
</p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>an <code>Avatar</code> id</p></dd><dt class="param">playerMap</dt><dd class="cmt"><p>the mapping of <code>Avatar</code> objects to <code>Player</code> objects</p></dd><dt>returns</dt><dd class="cmt"><p>any <code>Player</code> object that was associated at the time the <code>avatar</code> was removed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZonePopulationActor#PopulationRelease" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PopulationRelease(id:Int,playerMap:scala.collection.concurrent.TrieMap[Int,Option[net.psforever.objects.Player]]):Option[net.psforever.objects.Player]" class="anchorToMember"></a><a id="PopulationRelease(Int,TrieMap[Int,Option[Player]]):Option[Player]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.html#PopulationRelease(id:Int,playerMap:scala.collection.concurrent.TrieMap[Int,Option[net.psforever.objects.Player]]):Option[net.psforever.objects.Player]" 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">PopulationRelease</span><span class="params">(<span name="id">id: <span name="scala.Int" class="extype">Int</span></span>, <span name="playerMap">playerMap: <span name="scala.collection.concurrent.TrieMap" class="extype">TrieMap</span>[<span name="scala.Int" class="extype">Int</span>, <span name="scala.Option" class="extype">Option</span>[<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.Option" class="extype">Option</span>[<a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>]</span></span><p class="shortcomment cmt">Disassociate a <code>Player</code> object from an existing <code>Avatar</code> object that was be its key.</p><div class="fullcomment"><div class="comment cmt"><p>Disassociate a <code>Player</code> object from an existing <code>Avatar</code> object that was be its key.
</p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>an <code>Avatar</code> id</p></dd><dt class="param">playerMap</dt><dd class="cmt"><p>the mapping of <code>Avatar</code> objects to <code>Player</code> objects</p></dd><dt>returns</dt><dd class="cmt"><p>any <code>Player</code> object that is associated at the time</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZonePopulationActor#PopulationSpawn" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PopulationSpawn(id:Int,player:net.psforever.objects.Player,playerMap:scala.collection.concurrent.TrieMap[Int,Option[net.psforever.objects.Player]]):Option[(net.psforever.objects.Player,Boolean)]" class="anchorToMember"></a><a id="PopulationSpawn(Int,Player,TrieMap[Int,Option[Player]]):Option[(Player,Boolean)]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.html#PopulationSpawn(id:Int,player:net.psforever.objects.Player,playerMap:scala.collection.concurrent.TrieMap[Int,Option[net.psforever.objects.Player]]):Option[(net.psforever.objects.Player,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">PopulationSpawn</span><span class="params">(<span name="id">id: <span name="scala.Int" class="extype">Int</span></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="playerMap">playerMap: <span name="scala.collection.concurrent.TrieMap" class="extype">TrieMap</span>[<span name="scala.Int" class="extype">Int</span>, <span name="scala.Option" class="extype">Option</span>[<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.Option" class="extype">Option</span>[(<a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>, <span name="scala.Boolean" class="extype">Boolean</span>)]</span></span><p class="shortcomment cmt">Associate a <code>Player</code> object as a value to an existing <code>Avatar</code> object that will be its key.</p><div class="fullcomment"><div class="comment cmt"><p>Associate a <code>Player</code> object as a value to an existing <code>Avatar</code> object that will be its key.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Do not overwrite players that are already associated.
</p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>an <code>Avatar</code> object</p></dd><dt class="param">player</dt><dd class="cmt"><p>a <code>Player</code> object</p></dd><dt class="param">playerMap</dt><dd class="cmt"><p>the mapping of <code>Avatar</code> objects to <code>Player</code> objects</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>Tuple</code> object of the <code>Player</code> object that is associated with the <code>Avatar</code> key
and whether that player was added to the zone for the first time;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
<code>None</code>, if the player should not be introduced to this zone at this time</p></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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.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" class="anchorToMember"></a><a id="clone():AnyRef" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.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><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </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" class="anchorToMember"></a><a id="eq(AnyRef):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.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" class="anchorToMember"></a><a id="equals(AnyRef):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ZonePopulationActor$.html#finalize():Unit" title="Permalin
Reference in a new issue Copy permalink