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

13 lines
53 KiB
HTML
Raw Permalink 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.ChatActor</title><meta content="PSF - LoginServer - master - net.psforever.actors.session.ChatActor" name="description"/><meta content="PSF LoginServer master net.psforever.actors.session.ChatActor" 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_" 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.actors" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="actors" class="anchorToMember"></a><a id="actors:actors" class="anchorToMember"></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" class="anchorToMember"></a><a id="session:session" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/index.html" title="Permalink"><i class="mat
and that other player sends an emote,
that player is assigned a cooldown and only one emote per period will be seen<br>
key - character unique avatar identifier, value - when the current cooldown period will end
</p></li><li class="indented0 " name="net.psforever.actors.session.ChatActor#implantSanityTest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="implantSanityTest(guid:net.psforever.types.PlanetSideGUID,haveImplants:Iterable[net.psforever.objects.definition.ImplantDefinition],shortcuts:Array[Option[net.psforever.objects.avatar.Shortcut]]):Unit" class="anchorToMember"></a><a id="implantSanityTest(PlanetSideGUID,Iterable[ImplantDefinition],Array[Option[Shortcut]]):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.html#implantSanityTest(guid:net.psforever.types.PlanetSideGUID,haveImplants:Iterable[net.psforever.objects.definition.ImplantDefinition],shortcuts:Array[Option[net.psforever.objects.avatar.Shortcut]]):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">implantSanityTest</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="haveImplants">haveImplants: <span name="scala.Iterable" class="extype">Iterable</span>[<a href="../../objects/definition/ImplantDefinition.html" name="net.psforever.objects.definition.ImplantDefinition" id="net.psforever.objects.definition.ImplantDefinition" class="extype">ImplantDefinition</a>]</span>, <span name="shortcuts">shortcuts: <span name="scala.Array" class="extype">Array</span>[<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/avatar/Shortcut.html" name="net.psforever.objects.avatar.Shortcut" id="net.psforever.objects.avatar.Shortcut" class="extype">Shortcut</a>]]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Create all implant macro shortcuts for all implants whose shortcuts have been removed from the hotbar.</p><div class="fullcomment"><div class="comment cmt"><p>Create all implant macro shortcuts for all implants whose shortcuts have been removed from the hotbar.
Bounce the packet to the client and the client will bounce it back to the server to continue the setup,
or cancel / invalidate the shortcut creation.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>current player unique identifier for the target client</p></dd><dt class="param">haveImplants</dt><dd class="cmt"><p>list of implants the player possesses</p></dd><dt class="param">shortcuts</dt><dd class="cmt"><p>list of all existing shortcuts, used for early validation</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CreateShortcutMessage</code></p></span><span class="cmt"><p><code>ImplantDefinition</code></p></span><span class="cmt"><p><code>net.psforever.objects.avatar.Shortcut</code></p></span><span class="cmt"><p><code>SessionActor.SendResponse</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.html#isInstanceOf[T0]: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">isInstanceOf</span><span class="tparams">[<span name="T0">T0</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>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.ChatActor#macroSanityTest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="macroSanityTest(guid:net.psforever.types.PlanetSideGUID,acronym:String,msg:String,shortcuts:Array[Option[net.psforever.objects.avatar.Shortcut]]):Unit" class="anchorToMember"></a><a id="macroSanityTest(PlanetSideGUID,String,String,Array[Option[Shortcut]]):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.html#macroSanityTest(guid:net.psforever.types.PlanetSideGUID,acronym:String,msg:String,shortcuts:Array[Option[net.psforever.objects.avatar.Shortcut]]):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">macroSanityTest</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="acronym">acronym: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="shortcuts">shortcuts: <span name="scala.Array" class="extype">Array</span>[<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/avatar/Shortcut.html" name="net.psforever.objects.avatar.Shortcut" id="net.psforever.objects.avatar.Shortcut" class="extype">Shortcut</a>]]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Create a text chat macro shortcut if it doesn't already exist.</p><div class="fullcomment"><div class="comment cmt"><p>Create a text chat macro shortcut if it doesn't already exist.
Bounce the packet to the client and the client will bounce it back to the server to continue the setup,
or cancel / invalidate the shortcut creation.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>current player unique identifier for the target client</p></dd><dt class="param">acronym</dt><dd class="cmt"><p>three letters emblazoned on the shortcut icon</p></dd><dt class="param">msg</dt><dd class="cmt"><p>the message published to text chat</p></dd><dt class="param">shortcuts</dt><dd class="cmt"><p>a list of all existing shortcuts, used for early validation</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Array::indexWhere</code></p></span><span class="cmt"><p><code>CreateShortcutMessage</code></p></span><span class="cmt"><p><code>net.psforever.objects.avatar.Shortcut</code></p></span><span class="cmt"><p><code>net.psforever.packet.game.Shortcut.Macro</code></p></span><span class="cmt"><p><code>SessionActor.SendResponse</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.ChatActor#medkitSanityTest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="medkitSanityTest(guid:net.psforever.types.PlanetSideGUID,shortcuts:Array[Option[net.psforever.objects.avatar.Shortcut]]):Unit" class="anchorToMember"></a><a id="medkitSanityTest(PlanetSideGUID,Array[Option[Shortcut]]):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.html#medkitSanityTest(guid:net.psforever.types.PlanetSideGUID,shortcuts:Array[Option[net.psforever.objects.avatar.Shortcut]]):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">medkitSanityTest</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="shortcuts">shortcuts: <span name="scala.Array" class="extype">Array</span>[<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/avatar/Shortcut.html" name="net.psforever.objects.avatar.Shortcut" id="net.psforever.objects.avatar.Shortcut" class="extype">Shortcut</a>]]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Create a medkit shortcut if there is no medkit shortcut on the hotbar.</p><div class="fullcomment"><div class="comment cmt"><p>Create a medkit shortcut if there is no medkit shortcut on the hotbar.
Bounce the packet to the client and the client will bounce it back to the server to continue the setup,
or cancel / invalidate the shortcut creation.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>current player unique identifier for the target client</p></dd><dt class="param">shortcuts</dt><dd class="cmt"><p>list of all existing shortcuts, used for early validation</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Array::indexWhere</code></p></span><span class="cmt"><p><code>CreateShortcutMessage</code></p></span><span class="cmt"><p><code>net.psforever.objects.avatar.Shortcut</code></p></span><span class="cmt"><p><code>net.psforever.packet.game.Shortcut.Medkit</code></p></span><span class="cmt"><p><code>SessionActor.SendResponse</code></p></span></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" class="anchorToMember"></a><a id="ne(AnyRef):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.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</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#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.html#notify():Unit" 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">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.html#notifyAll():Unit" 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">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.ChatActor#postStartBehaviour" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="postStartBehaviour():akka.actor.typed.Behavior[net.psforever.actors.session.ChatActor.Command]" class="anchorToMember"></a><a id="postStartBehaviour():Behavior[Command]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/ChatActor.html#postStartBehaviour():akka.actor.typed.Behavior[net.psforever.actors.session.ChatActor.Command]" 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">postStartBehaviour</span><span class="params">()</span><span class="result">: <span name="akka.act