PSF-LoginServer/net/psforever/actors/session/AvatarActor.html

17 lines
93 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.actors.session.AvatarActor</title><meta content="PSF - LoginServer - master - net.psforever.actors.session.AvatarActor" name="description"/><meta content="PSF LoginServer master net.psforever.actors.session.AvatarActor" 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.actors" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="actors"></a><a id="actors:actors"></a> <span class="permalink"><a href="../../../../net/psforever/actors/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">actors</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.actors.session" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="session"></a><a id="session:session"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/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">session</span></a></span><di
If the player's reserves become zero in the act, inform the player that he is fatigued
meaning that he will only be able to walk, all implants will deactivate,
and all exertion that require stamina use will become impossible until a threshold of stamina is regained.</p></div><dl class="paramcmts block"><dt class="param">stamina</dt><dd class="cmt"><p>an amount to drain</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, as long as the requested amount of stamina can be drained in total;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#deactivateImplant" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="deactivateImplant(implantType:net.psforever.types.ImplantType):Unit"></a><a id="deactivateImplant(ImplantType):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#deactivateImplant(implantType:net.psforever.types.ImplantType):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">deactivateImplant</span><span class="params">(<span name="implantType">implantType: <a href="../../types/ImplantType.html" name="net.psforever.types.ImplantType" id="net.psforever.types.ImplantType" class="extype">ImplantType</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#defaultStaminaRegen" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="defaultStaminaRegen(initialDelay:scala.concurrent.duration.FiniteDuration):Unit"></a><a id="defaultStaminaRegen(FiniteDuration):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#defaultStaminaRegen(initialDelay:scala.concurrent.duration.FiniteDuration):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">defaultStaminaRegen</span><span class="params">(<span name="initialDelay">initialDelay: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#deinitializeImplants" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="deinitializeImplants():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#deinitializeImplants():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">deinitializeImplants</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#doNotStoreLocker" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="doNotStoreLocker():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#doNotStoreLocker():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">doNotStoreLocker</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#ec" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ec:scala.concurrent.ExecutionContextExecutor"></a><a id="ec:ExecutionContextExecutor"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#ec:scala.concurrent.ExecutionContextExecutor" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">ec</span><span class="result">: <span name="scala.concurrent.ExecutionContextExecutor" class="extype">ExecutionContextExecutor</span></span></span></li><li class="indented0 " name="scala.AnyRef#e
Update the database appropriately.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>unique account identifier</p></dd><dt class="param">name</dt><dd class="cmt"><p>unique character name</p></dd><dt class="param">faction</dt><dd class="cmt"><p>a faction affiliation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#memberActionAddIgnored" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="memberActionAddIgnored(charId:Long,name:String,faction:Int):Unit"></a><a id="memberActionAddIgnored(Long,String,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#memberActionAddIgnored(charId:Long,name:String,faction:Int):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">memberActionAddIgnored</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="faction">faction: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Add another player's data to the list of ignored players.</p><div class="fullcomment"><div class="comment cmt"><p>Add another player's data to the list of ignored players.
Update the database appropriately.
The change affects not only this player but also the player being ignored
by denying online visibility of the former to the latter.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>unique account identifier</p></dd><dt class="param">name</dt><dd class="cmt"><p>unique character name</p></dd><dt class="param">faction</dt><dd class="cmt"><p>a faction affiliation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#memberActionListManagement" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="memberActionListManagement(action:net.psforever.types.MemberAction.Value,listFunc:()=&gt;List[net.psforever.packet.game.Friend]):Unit"></a><a id="memberActionListManagement(types.MemberAction.Value,()=&gt;List[Friend]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#memberActionListManagement(action:net.psforever.types.MemberAction.Value,listFunc:()=&gt;List[net.psforever.packet.game.Friend]):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">memberActionListManagement</span><span class="params">(<span name="action">action: <a href="../../types/MemberAction$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.MemberAction.Value" id="net.psforever.types.MemberAction.Value" class="extmbr">types.MemberAction.Value</a></span>, <span name="listFunc">listFunc: () =&gt; <span name="scala.List" class="extype">List</span>[<a href="../../packet/game/Friend.html" name="net.psforever.packet.game.Friend" id="net.psforever.packet.game.Friend" class="extype">Friend</a>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Reload the list of friend players or ignored players for the client.</p><div class="fullcomment"><div class="comment cmt"><p>Reload the list of friend players or ignored players for the client.
This does not update any player's online status, but merely reloads current states.</p></div><dl class="paramcmts block"><dt class="param">action</dt><dd class="cmt"><p>nature of the request
(either <code>InitializeFriendList</code> or <code>InitializeIgnoreList</code>, hopefully)</p></dd><dt class="param">listFunc</dt><dd class="cmt"><p>transformation function that produces data suitable for a game paket</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#memberActionRemoveFriend" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="memberActionRemoveFriend(charId:Long,name:String):Unit"></a><a id="memberActionRemoveFriend(Long,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#memberActionRemoveFriend(charId:Long,name: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">memberActionRemoveFriend</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <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">Remove another player's data from the list of friend players.</p><div class="fullcomment"><div class="comment cmt"><p>Remove another player's data from the list of friend players.
Update the database appropriately.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>unique account identifier</p></dd><dt class="param">name</dt><dd class="cmt"><p>unique character name</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#memberActionRemoveIgnored" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="memberActionRemoveIgnored(charId:Long,name:String):Unit"></a><a id="memberActionRemoveIgnored(Long,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#memberActionRemoveIgnored(charId:Long,name: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">memberActionRemoveIgnored</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <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">Remove another player's data from the list of ignored players.</p><div class="fullcomment"><div class="comment cmt"><p>Remove another player's data from the list of ignored players.
Update the database appropriately.
The change affects not only this player but also the player formerly being ignored
by restoring online visibility of the former to the latter.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>unique account identifier</p></dd><dt class="param">name</dt><dd class="cmt"><p>unique character name</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#memberActionUpdateFriend" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="memberActionUpdateFriend(name:String):Option[(Long,net.psforever.types.PlanetSideEmpire.Value)]"></a><a id="memberActionUpdateFriend(String):Option[(Long,types.PlanetSideEmpire.Value)]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#memberActionUpdateFriend(name:String):Option[(Long,net.psforever.types.PlanetSideEmpire.Value)]" 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">memberActionUpdateFriend</span><span class="params">(<span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[(<span name="scala.Long" class="extype">Long</span>, <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><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">name</dt><dd class="cmt"><p>unique character name</p></dd><dt>returns</dt><dd class="cmt"><p>if the avatar is found, that avatar's unique identifier and the avatar's faction affiliation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#memberListAction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="memberListAction(action:net.psforever.types.MemberAction.Value,name:String):Unit"></a><a id="memberListAction(types.MemberAction.Value,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor.html#memberListAction(action:net.psforever.types.MemberAction.Value,name: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">memberListAction</span><span class="params">(<span name="action">action: <a href="../../types/MemberAction$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.MemberAction.Value" id="net.psforever.types.MemberAction.Value" class="extmbr">types.MemberAction.Value</a></span>, <span name="name">name: <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">Branch based on behavior of the request for the friends list or the ignored people list.</p><div class="fullcomment"><div class="comment cmt"><p>Branch based on behavior of the request for the friends list or the ignored people list.</p></div><dl class="paramcmts block"><dt class="param">action</dt><dd class="cmt"><p>nature of the request</p></dd><dt class="param">name</dt><dd class="cmt"><p>other player's name (can not be our name)</p></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/actors/session/AvatarActor.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