PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-04-23 05:15:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/services/teamwork/SquadSubscriptionEntity.html

52 lines
66 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ psforever/PSF-LoginServer@ebfc028f5ce38ef299de422822354479d97b0fd5 🚀
2023-01-16 15:45:52 +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.services.teamwork.SquadSubscriptionEntity</title><meta content="PSF - LoginServer - master - net.psforever.services.teamwork.SquadSubscriptionEntity" name="description"/><meta content="PSF LoginServer master net.psforever.services.teamwork.SquadSubscriptionEntity" 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.services" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="services"></a><a id="services:services"></a> <span class="permalink"><a href="../../../../net/psforever/services/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">services</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.services.teamwork" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="teamwork"></a><a id="teamwork:teamwork"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/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">teamwor
The details of the squad will be updated in full and be sent to all indicated observers.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier to be used when composing the details for this message</p></dd><dt class="param">to</dt><dd class="cmt"><p>the unique character identifier numbers of the players who will receive this message</p></dd><dt class="param">squad</dt><dd class="cmt"><p>the squad from which the squad details shall be composed</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadService.PublishFullDetails</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#InitSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):Unit"></a><a id="InitSquadDetail(SquadFeatures):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#InitSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):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">InitSquadDetail</span><span class="params">(<span name="features">features: <a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Dispatch a message entailing the composition of this squad.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch a message entailing the composition of this squad.
This is considered the first time this information will be dispatched to any relevant observers
so the details of the squad will be updated in full and be sent to all relevant observers,
namely, all the occupants of the squad.
External observers are ignored.</p></div><dl class="paramcmts block"><dt class="param">features</dt><dd class="cmt"><p>the squad</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>InitSquadDetail(PlanetSideGUID, Iterable[Long], Squad)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#MonitorSquadDetails" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="MonitorSquadDetails:scala.collection.mutable.LongMap[net.psforever.services.teamwork.SquadSubscriptionEntity.MonitorEntry]"></a><a id="MonitorSquadDetails:LongMap[MonitorEntry]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#MonitorSquadDetails:scala.collection.mutable.LongMap[net.psforever.services.teamwork.SquadSubscriptionEntity.MonitorEntry]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">MonitorSquadDetails</span><span class="result">: <span name="scala.collection.mutable.LongMap" class="extype">LongMap</span>[<span name="net.psforever.services.teamwork.SquadSubscriptionEntity.MonitorEntry" class="extype">MonitorEntry</span>]</span></span><p class="shortcomment cmt">Players who are interested in updated details regarding a certain squad
though they may not be a member of the squad.<br>
key - unique character identifier number; value - a squad identifier number
</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish[ANY&gt;:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish[ANY&gt;:Any](ANY,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish[ANY&gt;:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):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">Publish</span><span class="tparams">[<span name="ANY">ANY &gt;: <span name="scala.Any" class="extype">Any</span></span>]</span><span class="params">(<span name="to">to: <span name="net.psforever.services.teamwork.SquadSubscriptionEntity.Publish.ANY" class="extype">ANY</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
No message can be sent using this distinction.
Log a warning.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>something that was expected to be used as the channel for the message
but is not handled as such</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish[ANY&gt;:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish[ANY&gt;:Any](ANY,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish[ANY&gt;:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):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">Publish</span><span class="tparams">[<span name="ANY">ANY &gt;: <span name="scala.Any" class="extype">Any</span></span>]</span><span class="params">(<span name="to">to: <span name="net.psforever.services.teamwork.SquadSubscriptionEntity.Publish.ANY" class="extype">ANY</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
No message can be sent using this distinction.
Log a warning.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>something that was expected to be used as the channel for the message
but is not handled as such</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(Long,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):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">Publish</span><span class="params">(<span name="to">to: <span name="scala.Long" class="extype">Long</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(Long,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):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">Publish</span><span class="params">(<span name="to">to: <span name="scala.Long" class="extype">Long</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(String,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):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">Publish</span><span class="params">(<span name="to">to: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
Strings come in three accepted patterns.
The first resolves into a faction name, as determined by <code>PlanetSideEmpire</code> when transformed into a string.
The second resolves into a squad's dedicated channel, a name that is formulaic.
The third resolves as a unique character identifier number.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a string used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
(resolved at destination, usually)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(String,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response):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">Publish</span><span class="params">(<span name="to">to: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
Strings come in three accepted patterns.
The first resolves into a faction name, as determined by <code>PlanetSideEmpire</code> when transformed into a string.
The second resolves into a squad's dedicated channel, a name that is formulaic.
The third resolves as a unique character identifier number.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a string used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(Type,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):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">Publish</span><span class="params">(<span name="to">to: <a href="../../types/PlanetSideEmpire$.html#Type=net.psforever.types.PlanetSideEmpire.Value" name="net.psforever.types.PlanetSideEmpire.Type" id="net.psforever.types.PlanetSideEmpire.Type" class="extmbr">Type</a></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
Always publishes on the <code>SquadEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
(resolved at destination)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(Type,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response):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">Publish</span><span class="params">(<span name="to">to: <a href="../../types/PlanetSideEmpire$.html#Type=net.psforever.types.PlanetSideEmpire.Value" name="net.psforever.types.PlanetSideEmpire.Type" id="net.psforever.types.PlanetSideEmpire.Type" class="extmbr">Type</a></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
Always publishes on the <code>SquadEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(ActorRef,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):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">Publish</span><span class="params">(<span name="to">to: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
(resolved at destination)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(ActorRef,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response):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">Publish</span><span class="params">(<span name="to">to: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#PublishToMonitorTargets" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PublishToMonitorTargets(guid:net.psforever.types.PlanetSideGUID,excluding:Iterable[Long]):Iterable[Long]"></a><a id="PublishToMonitorTargets(PlanetSideGUID,Iterable[Long]):Iterable[Long]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#PublishToMonitorTargets(guid:net.psforever.types.PlanetSideGUID,excluding:Iterable[Long]):Iterable[Long]" 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">PublishToMonitorTargets</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="excluding">excluding: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier number to be used for the squad detail message</p></dd><dt class="param">excluding</dt><dd class="cmt"><p>the explicit unique character identifier numbers of individuals who should not receive the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>LongMap.subtractOne</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.MonitorEntry</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#SquadEvents" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SquadEvents:net.psforever.services.GenericEventBus[net.psforever.services.teamwork.SquadServiceResponse]"></a><a id="SquadEvents:GenericEventBus[SquadServiceResponse]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#SquadEvents:net.psforever.services.GenericEventBus[net.psforever.services.teamwork.SquadServiceResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">SquadEvents</span><span class="result">: <a href="../GenericEventBus.html" name="net.psforever.services.GenericEventBus" id="net.psforever.services.GenericEventBus" class="extype">GenericEventBus</a>[<a href="SquadServiceResponse.html" name="net.psforever.services.teamwork.SquadServiceResponse" id="net.psforever.services.teamwork.SquadServiceResponse" class="extype">SquadServiceResponse</a>]</span></span><p class="shortcomment cmt">This is a formal <code>ActorEventBus</code> object that is reserved for faction-wide messages and squad-specific messages.</p><div class="fullcomment"><div class="comment cmt"><p>This is a formal <code>ActorEventBus</code> object that is reserved for faction-wide messages and squad-specific messages.
When the user joins the <code>SquadService</code> with a <code>Service.Join</code> message
that includes a confirmed faction affiliation identifier,
the origin <code>ActorRef</code> is added as a subscription.
Squad channels are produced when a squad is created,
and are subscribed to as users join the squad,
and unsubscribed from as users leave the squad.<br>
key - a <code>PlanetSideEmpire</code> value; value - <code>ActorRef</code> reference<br>
key - a consistent squad channel name; value - <code>ActorRef</code> reference</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CloseSquad</code></p></span><span class="cmt"><p><code>JoinSquad</code></p></span><span class="cmt"><p><code>LeaveSquad</code></p></span><span class="cmt"><p><code>Service.Join</code></p></span><span class="cmt"><p><code>Service.Leave</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,toChannel:String,excluding:Iterable[Long],details:net.psforever.packet.game.SquadDetail):Unit"></a><a id="UpdateSquadDetail(PlanetSideGUID,String,Iterable[Long],SquadDetail):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,toChannel:String,excluding:Iterable[Long],details:net.psforever.packet.game.SquadDetail):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">UpdateSquadDetail</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="toChannel">toChannel: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="excluding">excluding: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>, <span name="details">details: <a href="../../packet/game/SquadDetail.html" name="net.psforever.packet.game.SquadDetail" id="net.psforever.packet.game.SquadDetail" class="extype">SquadDetail</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing some of the strategic information and the composition to the existing members of the squad.
Also send the same information to any users who are watching the squad, potentially for want to join it.
The squad-specific message is contingent on finding the squad's features using the unique identifier number
and, from that, reporting to the specific squad's messaging channel.
Anyone watching the squad will always be updated the given details.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier number to be used for the squad detail message</p></dd><dt class="param">toChannel</dt><dd class="cmt"><p>the squad broadcast channel name</p></dd><dt class="param">excluding</dt><dd class="cmt"><p>the explicit unique character identifier numbers of individuals who should not receive the message</p></dd><dt class="param">details</dt><dd class="cmt"><p>the squad details to be included in the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>DisplaySquad</code></p></span><span class="cmt"><p><code>Publish</code></p></span><span class="cmt"><p><code>SquadDetail</code></p></span><span class="cmt"><p><code>SquadResponse.Detail</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures,details:net.psforever.packet.game.SquadDetail):Unit"></a><a id="UpdateSquadDetail(SquadFeatures,SquadDetail):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures,details:net.psforever.packet.game.SquadDetail):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">UpdateSquadDetail</span><span class="params">(<span name="features">features: <a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a></span>, <span name="details">details: <a href="../../packet/game/SquadDetail.html" name="net.psforever.packet.game.SquadDetail" id="net.psforever.packet.game.SquadDetail" class="extype">SquadDetail</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p></div><dl class="paramcmts block"><dt class="param">features</dt><dd class="cmt"><p>information about the squad</p></dd><dt class="param">details</dt><dd class="cmt"><p>the squad details to be included in the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadResponse.Detail</code></p></span><span class="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):Unit"></a><a id="UpdateSquadDetail(SquadFeatures):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):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">UpdateSquadDetail</span><span class="params">(<span name="features">features: <a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a></span>)</span><span class="result">: <span name="scala.Unit" clas
When the user joins the <code>SquadService</code> with a <code>Service.Join</code> message
that includes their unique character identifier,
the origin <code>ActorRef</code> is added as a subscription.
It is maintained until they disconnect entirely.
The subscription is anticipated to belong to an instance of <code>SessionActor</code>.<br>
key - unique character identifier number; value - <code>ActorRef</code> reference for that character</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Service.Join</code></p></span></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/services/teamwork/SquadSubscriptionEntity.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/services/teamwork/SquadSubscriptionEntity.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"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.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"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.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"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#finalize():Unit" title="Permalink"><i class="material-icons
Reference in a new issue Copy permalink