mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-03-04 21:10:23 +00:00
69 lines
119 KiB
HTML
69 lines
119 KiB
HTML
<!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.SquadService</title><meta content="PSF - LoginServer - master - net.psforever.services.teamwork.SquadService" name="description"/><meta content="PSF LoginServer master net.psforever.services.teamwork.SquadService" 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"><</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">teamwork</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.services" id="net.psforever.services" class="extype">services</a></dd></dl></div></li><li class="current-entities indented4"><span class="separator"></span> <a href="SquadAction$.html" title="" class="object"></a><a href="SquadAction$.html" title="">SquadAction</a></li><li class="current-entities indented4"><a href="SquadInvitationManager$.html" title="" class="object"></a> <a href="SquadInvitationManager.html" title="" class="class"></a><a href="SquadInvitationManager.html" title="">SquadInvitationManager</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="SquadResponse$.html" title="" class="object"></a><a href="SquadResponse$.html" title="">SquadResponse</a></li><li class="current-entities indented4"><a href="SquadService$.html" title="" class="object"></a> <a href="" title="" class="class"></a><a href="" title="">SquadService</a></li><li class="current-entities indented4"><a href="SquadServiceMessage$.html" title="" class="object"></a> <a href="SquadServiceMessage.html" title="" class="class"></a><a href="SquadServiceMessage.html" title="">SquadServiceMessage</a></li><li class="current-entities indented4"><a href="SquadServiceResponse$.html" title="" class="object"></a> <a href="SquadServiceResponse.html" title="" class="class"></a><a href="SquadServiceResponse.html" title="">SquadServiceResponse</a></li><li class="current-entities indented4"><a href="SquadSubscriptionEntity$.html" title="" class="object"></a> <a href="SquadSubscriptionEntity.html" title="" class="class"></a><a href="SquadSubscriptionEntity.html" title="">SquadSubscriptionEntity</a></li><li class="current-entities indented4"><a href="SquadSwitchboard$.html" title="" class="object"></a> <a href="SquadSwitchboard.html" title="The dedicated messaging switchboard for members and observers of a given squad." class="class"></a><a href="SquadSwitchboard.html" title="The dedicated messaging switchboard for members and observers of a given squad.">SquadSwitchboard</a></li></ul></div></div><div id="content"><body class="class type"><div id="definition"><a href="SquadService$.html" title="See companion object"><div class="big-circle class-companion-object">c</div></a><p id="owner"><a href="../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../index.html" name="net.psforever.services" id="net.psforever.services" class="extype">services</a>.<a href="index.html" name="net.psforever.services.teamwork" id="net.psforever.services.teamwork" class="extype">teamwork</a></p><h1><a href="SquadService$.html" title="See companion object">SquadService</a><span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html" title="Permalink"><i class="material-icons"></i></a></span></h1><h3><span class="morelinks"><div>Companion <a href="SquadService$.html" title="See companion object">object SquadService</a></div></span></h3></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><span class="name">SquadService</span><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span></span></span></h4><div id="comment" class="fullcommenttop"><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/services/teamwork/SquadService.scala" target="_blank">SquadService.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="akka.actor.Actor" class="extype">Actor</span>, <span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.services.teamwork.SquadService"><span>SquadService</span></li><li class="in" name="akka.actor.Actor"><span>Actor</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.services.teamwork.SquadService#<init>" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="<init>():net.psforever.services.teamwork.SquadService"></a><a id="<init>:SquadService"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#<init>():net.psforever.services.teamwork.SquadService" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">SquadService</span><span class="params">()</span></span></li></ol></div><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="akka.actor.Actor.Receive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Receive=akka.actor.Actor.Receive"></a><a id="Receive:Receive"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Receive=akka.actor.Actor.Receive" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">type</span></span> <span class="symbol"><span class="name">Receive</span><span class="result alias"> = <span name="scala.PartialFunction" class="extype">PartialFunction</span>[<span name="scala.Any" class="extype">Any</span>, <span name="scala.Unit" class="extype">Unit</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#ApplySquadDecorationToEntriesForUser" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ApplySquadDecorationToEntriesForUser(faction:net.psforever.types.PlanetSideEmpire.Value,targetCharId:Long):Unit"></a><a id="ApplySquadDecorationToEntriesForUser(types.PlanetSideEmpire.Value,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#ApplySquadDecorationToEntriesForUser(faction:net.psforever.types.PlanetSideEmpire.Value,targetCharId: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">ApplySquadDecorationToEntriesForUser</span><span class="params">(<span name="faction">faction: <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 name="targetCharId">targetCharId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#ApplySquadDecorationToEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ApplySquadDecorationToEntry(faction:net.psforever.types.PlanetSideEmpire.Value,guid:net.psforever.types.PlanetSideGUID,squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="ApplySquadDecorationToEntry(types.PlanetSideEmpire.Value,PlanetSideGUID,Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#ApplySquadDecorationToEntry(faction:net.psforever.types.PlanetSideEmpire.Value,guid:net.psforever.types.PlanetSideGUID,squad:net.psforever.objects.teamwork.Squad):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">ApplySquadDecorationToEntry</span><span class="params">(<span name="faction">faction: <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 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="squad">squad: <a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Squad decoration are the colors applied to entries in the squad listing based on individual assessments.</p><div class="fullcomment"><div class="comment cmt"><p>Squad decoration are the colors applied to entries in the squad listing based on individual assessments.
|
|
Apply these colors to one squad at a time.
|
|
This sends out the least amount of messages -
|
|
one for the whole faction and one message for each search for which this squad is a positive result.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>empire whose squad is being decorated</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the squad's identifier</p></dd><dt class="param">squad</dt><dd class="cmt"><p>the squad</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#CleanUpSquadFeatures" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="CleanUpSquadFeatures(removed:List[Long],guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"></a><a id="CleanUpSquadFeatures(List[Long],PlanetSideGUID,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#CleanUpSquadFeatures(removed:List[Long],guid:net.psforever.types.PlanetSideGUID,position: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">CleanUpSquadFeatures</span><span class="params">(<span name="removed">removed: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span>, <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="position">position: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#CloseSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CloseSquad(squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="CloseSquad(Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#CloseSquad(squad:net.psforever.objects.teamwork.Squad):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">CloseSquad</span><span class="params">(<span name="squad">squad: <a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">All players are made to leave the squad and the squad will stop existing.</p><div class="fullcomment"><div class="comment cmt"><p>All players are made to leave the squad and the squad will stop existing.
|
|
Any member of the squad missing an <code>ActorRef</code> object used to message the player's client
|
|
will still leave the squad, but will not attempt to send feedback to the said unreachable client.
|
|
If the player is in the process of unsubscribing from the service,
|
|
the no-messaging pathway is useful to avoid accumulating dead letters.</p></div><dl class="paramcmts block"><dt class="param">squad</dt><dd class="cmt"><p>the squad</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CleanUpAllInvitesToSquad</code></p></span><span class="cmt"><p><code>SquadDetail</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.Publish</code></p></span><span class="cmt"><p><code>TryResetSquadId</code></p></span><span class="cmt"><p><code>UpdateSquadList</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#DisbandSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DisbandSquad(features:net.psforever.objects.teamwork.SquadFeatures):Unit"></a><a id="DisbandSquad(SquadFeatures):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#DisbandSquad(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">DisbandSquad</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">All players are made to leave the squad and the squad will stop existing.</p><div class="fullcomment"><div class="comment cmt"><p>All players are made to leave the squad and the squad will stop existing.
|
|
Essentially, perform the same operations as <code>CloseSquad</code>
|
|
but treat the process as if the squad is being disbanded in terms of messaging.</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>PanicDisbandSquad</code></p></span><span class="cmt"><p><code>SquadResponse.Membership</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.Publish</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#EnsureEmptySquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EnsureEmptySquad(charId:Long):Boolean"></a><a id="EnsureEmptySquad(Long):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#EnsureEmptySquad(charId:Long):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">EnsureEmptySquad</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Determine whether a player is sufficiently unemployed
|
|
and has no grand delusions of being a squad leader.</p><div class="fullcomment"><div class="comment cmt"><p>Determine whether a player is sufficiently unemployed
|
|
and has no grand delusions of being a squad leader.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the player</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the target player possesses no squad or a squad that is suitably nonexistent;
|
|
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CloseSquad</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#GetLeadingSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetLeadingSquad(charId:Long,opt:Option[net.psforever.objects.teamwork.SquadFeatures]):Option[net.psforever.objects.teamwork.SquadFeatures]"></a><a id="GetLeadingSquad(Long,Option[SquadFeatures]):Option[SquadFeatures]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetLeadingSquad(charId:Long,opt:Option[net.psforever.objects.teamwork.SquadFeatures]):Option[net.psforever.objects.teamwork.SquadFeatures]" 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">GetLeadingSquad</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="opt">opt: <span name="scala.Option" class="extype">Option</span>[<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.Option" class="extype">Option</span>[<a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a>]</span></span><p class="shortcomment cmt">If the player associated with this unique character identifier number is the leader of any squad, discover that squad.</p><div class="fullcomment"><div class="comment cmt"><p>If the player associated with this unique character identifier number is the leader of any squad, discover that squad.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the potential member identifier</p></dd><dt class="param">opt</dt><dd class="cmt"><p>an optional squad to check;
|
|
the expectation is that the provided squad is a known participating squad</p></dd><dt>returns</dt><dd class="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GetParticipatingSquad</code></p></span><span class="cmt"><p><code>Squad->Leader</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#GetLeadingSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetLeadingSquad(player:net.psforever.objects.Player,opt:Option[net.psforever.objects.teamwork.SquadFeatures]):Option[net.psforever.objects.teamwork.SquadFeatures]"></a><a id="GetLeadingSquad(Player,Option[SquadFeatures]):Option[SquadFeatures]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetLeadingSquad(player:net.psforever.objects.Player,opt:Option[net.psforever.objects.teamwork.SquadFeatures]):Option[net.psforever.objects.teamwork.SquadFeatures]" 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">GetLeadingSquad</span><span class="params">(<span name="player">player: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="opt">opt: <span name="scala.Option" class="extype">Option</span>[<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.Option" class="extype">Option</span>[<a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a>]</span></span><p class="shortcomment cmt">If this player is a member of any squad, discover that squad.</p><div class="fullcomment"><div class="comment cmt"><p>If this player is a member of any squad, discover that squad.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the potential member</p></dd><dt class="param">opt</dt><dd class="cmt"><p>an optional squad to check;
|
|
the expectation is that the provided squad is a known participating squad</p></dd><dt>returns</dt><dd class="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GetParticipatingSquad</code></p></span><span class="cmt"><p><code>Squad::Leader</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#GetNextSquadId" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetNextSquadId():net.psforever.types.PlanetSideGUID"></a><a id="GetNextSquadId():PlanetSideGUID"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetNextSquadId():net.psforever.types.PlanetSideGUID" 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">GetNextSquadId</span><span class="params">()</span><span class="result">: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span></span><p class="shortcomment cmt">Produce the next available unique squad identifier.</p><div class="fullcomment"><div class="comment cmt"><p>Produce the next available unique squad identifier.
|
|
The first number is always 1.
|
|
The greatest possible identifier is 65535 (an unsigned 16-bit integer)
|
|
before it wraps back around to 1.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the current squad unique identifier number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#GetOrCreateSquadOnlyIfLeader" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="GetOrCreateSquadOnlyIfLeader(player:net.psforever.objects.Player):Option[net.psforever.objects.teamwork.SquadFeatures]"></a><a id="GetOrCreateSquadOnlyIfLeader(Player):Option[SquadFeatures]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetOrCreateSquadOnlyIfLeader(player:net.psforever.objects.Player):Option[net.psforever.objects.teamwork.SquadFeatures]" 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">GetOrCreateSquadOnlyIfLeader</span><span class="params">(<span name="player">player: <a href="../../objects/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="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a>]</span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#GetParticipatingSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetParticipatingSquad(charId:Long):Option[net.psforever.objects.teamwork.SquadFeatures]"></a><a id="GetParticipatingSquad(Long):Option[SquadFeatures]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetParticipatingSquad(charId:Long):Option[net.psforever.objects.teamwork.SquadFeatures]" 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">GetParticipatingSquad</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a>]</span></span><p class="shortcomment cmt">If the player associated with this unique character identifier number is a member of any squad, discover that squad.</p><div class="fullcomment"><div class="comment cmt"><p>If the player associated with this unique character identifier number is a member of any squad, discover that squad.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the potential member identifier</p></dd><dt>returns</dt><dd class="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#GetParticipatingSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetParticipatingSquad(player:net.psforever.objects.Player):Option[net.psforever.objects.teamwork.SquadFeatures]"></a><a id="GetParticipatingSquad(Player):Option[SquadFeatures]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetParticipatingSquad(player:net.psforever.objects.Player):Option[net.psforever.objects.teamwork.SquadFeatures]" 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">GetParticipatingSquad</span><span class="params">(<span name="player">player: <a href="../../objects/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="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a>]</span></span><p class="shortcomment cmt">If this player is a member of any squad, discover that squad.</p><div class="fullcomment"><div class="comment cmt"><p>If this player is a member of any squad, discover that squad.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the potential member</p></dd><dt>returns</dt><dd class="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#GetSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetSquad(id:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.teamwork.SquadFeatures]"></a><a id="GetSquad(PlanetSideGUID):Option[SquadFeatures]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetSquad(id:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.teamwork.SquadFeatures]" 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">GetSquad</span><span class="params">(<span name="id">id: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a>]</span></span><p class="shortcomment cmt">If a squad exists for an identifier, return that squad.</p><div class="fullcomment"><div class="comment cmt"><p>If a squad exists for an identifier, return that squad.</p></div><dl class="paramcmts block"><dt class="param">id</dt><dd class="cmt"><p>the squad unique identifier number</p></dd><dt>returns</dt><dd class="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#JoinByCharacterId" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="JoinByCharacterId(charId:String,sender:akka.actor.ActorRef):Unit"></a><a id="JoinByCharacterId(String,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#JoinByCharacterId(charId:String,sender:akka.actor.ActorRef):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">JoinByCharacterId</span><span class="params">(<span name="charId">charId: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#JoinByFaction" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="JoinByFaction(faction:String,sender:akka.actor.ActorRef):Unit"></a><a id="JoinByFaction(String,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#JoinByFaction(faction:String,sender:akka.actor.ActorRef):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">JoinByFaction</span><span class="params">(<span name="faction">faction: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#JoinSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="JoinSquad(player:net.psforever.objects.Player,features:net.psforever.objects.teamwork.SquadFeatures,position:Int):Boolean"></a><a id="JoinSquad(Player,SquadFeatures,Int):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#JoinSquad(player:net.psforever.objects.Player,features:net.psforever.objects.teamwork.SquadFeatures,position:Int):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">JoinSquad</span><span class="params">(<span name="player">player: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <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="position">position: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Behaviors and exchanges necessary to complete the fulfilled recruitment process for the squad role.<br>
|
|
<br>
|
|
This operation is fairly safe to call whenever a player is to be inducted into a squad.</p><div class="fullcomment"><div class="comment cmt"><p>Behaviors and exchanges necessary to complete the fulfilled recruitment process for the squad role.<br>
|
|
<br>
|
|
This operation is fairly safe to call whenever a player is to be inducted into a squad.
|
|
The aforementioned player must have a callback retained in <code>subs.UserEvents</code>
|
|
and conditions imposed by both the role and the player must be satisfied.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the new squad member;
|
|
this player is NOT the squad leader</p></dd><dt class="param">features</dt><dd class="cmt"><p>the squad the player is joining</p></dd><dt class="param">position</dt><dd class="cmt"><p>the squad member role that the player will be filling</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the player joined the squad in some capacity;
|
|
<code>false</code>, if the player did not join the squad or is already a squad member</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CleanUpAllInvitesWithPlayer</code></p></span><span class="cmt"><p><code>Squad.isAvailable</code></p></span><span class="cmt"><p><code>Squad.Switchboard</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.MonitorSquadDetails</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.Publish</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.Join</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.UserEvents</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#LeaveByCharacterId" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LeaveByCharacterId(charId:String,sender:akka.actor.ActorRef):Unit"></a><a id="LeaveByCharacterId(String,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#LeaveByCharacterId(charId:String,sender:akka.actor.ActorRef):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">LeaveByCharacterId</span><span class="params">(<span name="charId">charId: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#LeaveByFaction" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LeaveByFaction(faction:String,sender:akka.actor.ActorRef):Unit"></a><a id="LeaveByFaction(String,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#LeaveByFaction(faction:String,sender:akka.actor.ActorRef):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">LeaveByFaction</span><span class="params">(<span name="faction">faction: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#LeaveInGeneral" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LeaveInGeneral(sender:akka.actor.ActorRef):Unit"></a><a id="LeaveInGeneral(ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#LeaveInGeneral(sender:akka.actor.ActorRef):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">LeaveInGeneral</span><span class="params">(<span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#LeaveService" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LeaveService(charId:Long,sender:akka.actor.ActorRef):Unit"></a><a id="LeaveService(Long,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#LeaveService(charId:Long,sender:akka.actor.ActorRef):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">LeaveService</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</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">charId</dt><dd class="cmt"><p>the player's unique character identifier number</p></dd><dt class="param">sender</dt><dd class="cmt"><p>the <code>ActorRef</code> associated with this character</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#LeaveService" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LeaveService(charId:String,sender:akka.actor.ActorRef):Unit"></a><a id="LeaveService(String,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#LeaveService(charId:String,sender:akka.actor.ActorRef):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">LeaveService</span><span class="params">(<span name="charId">charId: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</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">charId</dt><dd class="cmt"><p>the player's unique character identifier number</p></dd><dt class="param">sender</dt><dd class="cmt"><p>the <code>ActorRef</code> associated with this character</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#LeaveSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LeaveSquad(charId:Long,features:net.psforever.objects.teamwork.SquadFeatures):Boolean"></a><a id="LeaveSquad(Long,SquadFeatures):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#LeaveSquad(charId:Long,features:net.psforever.objects.teamwork.SquadFeatures):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">LeaveSquad</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Behaviors and exchanges necessary to undo the recruitment process for the squad role.</p><div class="fullcomment"><div class="comment cmt"><p>Behaviors and exchanges necessary to undo the recruitment process for the squad role.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the player</p></dd><dt class="param">features</dt><dd class="cmt"><p>the squad</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the player, formerly a normal member of the squad, has been ejected from the squad;
|
|
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>PanicLeaveSquad</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.Publish</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#PanicDisbandSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PanicDisbandSquad(features:net.psforever.objects.teamwork.SquadFeatures,membership:Iterable[Long]):Unit"></a><a id="PanicDisbandSquad(SquadFeatures,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#PanicDisbandSquad(features:net.psforever.objects.teamwork.SquadFeatures,membership: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">PanicDisbandSquad</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="membership">membership: <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">All players are made to leave the squad and the squad will stop existing.<br>
|
|
<br>
|
|
The complement of the prior <code>DisbandSquad</code> method.</p><div class="fullcomment"><div class="comment cmt"><p>All players are made to leave the squad and the squad will stop existing.<br>
|
|
<br>
|
|
The complement of the prior <code>DisbandSquad</code> method.
|
|
This method deals entirely with other squad members observing the squad become abandoned.
|
|
The distinction is useful when unsubscribing from this service,
|
|
as the <code>ActorRef</code> object used to message the player's client is no longer reliable
|
|
and has probably ceased to exist.</p></div><dl class="paramcmts block"><dt class="param">features</dt><dd class="cmt"><p>the squad</p></dd><dt class="param">membership</dt><dd class="cmt"><p>the unique character identifier numbers of the other squad members</p></dd><dt>returns</dt><dd class="cmt"><p>if a role/index pair is provided</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CloseSquad</code></p></span><span class="cmt"><p><code>DisbandSquad</code></p></span><span class="cmt"><p><code>SquadResponse.Membership</code></p></span><span class="cmt"><p><code>SquadResponseType</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.Publish</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#PublishedLists" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PublishedLists(squads:Iterable[net.psforever.objects.teamwork.SquadFeatures]):Vector[net.psforever.packet.game.SquadInfo]"></a><a id="PublishedLists(Iterable[SquadFeatures]):Vector[SquadInfo]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#PublishedLists(squads:Iterable[net.psforever.objects.teamwork.SquadFeatures]):Vector[net.psforever.packet.game.SquadInfo]" 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">PublishedLists</span><span class="params">(<span name="squads">squads: <span name="scala.Iterable" class="extype">Iterable</span>[<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.Vector" class="extype">Vector</span>[<a href="../../packet/game/SquadInfo.html" name="net.psforever.packet.game.SquadInfo" id="net.psforever.packet.game.SquadInfo" class="extype">SquadInfo</a>]</span></span><p class="shortcomment cmt">Transform a list of squad unique identifiers into a list of <code>SquadInfo</code> objects for updating the squad list window.</p><div class="fullcomment"><div class="comment cmt"><p>Transform a list of squad unique identifiers into a list of <code>SquadInfo</code> objects for updating the squad list window.</p></div><dl class="paramcmts block"><dt class="param">squads</dt><dd class="cmt"><p>the list of squads</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>Vector</code> of transformed squad data</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#PublishedLists" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PublishedLists(faction:net.psforever.types.PlanetSideEmpire.Type):Vector[net.psforever.packet.game.SquadInfo]"></a><a id="PublishedLists(Type):Vector[SquadInfo]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#PublishedLists(faction:net.psforever.types.PlanetSideEmpire.Type):Vector[net.psforever.packet.game.SquadInfo]" 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">PublishedLists</span><span class="params">(<span name="faction">faction: <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><span class="result">: <span name="scala.Vector" class="extype">Vector</span>[<a href="../../packet/game/SquadInfo.html" name="net.psforever.packet.game.SquadInfo" id="net.psforever.packet.game.SquadInfo" class="extype">SquadInfo</a>]</span></span><p class="shortcomment cmt">Transform a list of squad unique identifiers into a list of <code>SquadInfo</code> objects for updating the squad list window.</p><div class="fullcomment"><div class="comment cmt"><p>Transform a list of squad unique identifiers into a list of <code>SquadInfo</code> objects for updating the squad list window.</p></div><dl class="paramcmts block"><dt class="param">faction</dt><dd class="cmt"><p>the faction to which the squads belong</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>Vector</code> of transformed squad data</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinition(message:net.psforever.services.teamwork.SquadServiceMessage,action:net.psforever.packet.game.SquadAction,guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="SquadActionDefinition(SquadServiceMessage,packet.game.SquadAction,PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinition(message:net.psforever.services.teamwork.SquadServiceMessage,action:net.psforever.packet.game.SquadAction,guid:net.psforever.types.PlanetSideGUID):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">SquadActionDefinition</span><span class="params">(<span name="message">message: <a href="SquadServiceMessage.html" name="net.psforever.services.teamwork.SquadServiceMessage" id="net.psforever.services.teamwork.SquadServiceMessage" class="extype">SquadServiceMessage</a></span>, <span name="action">action: <a href="../../packet/game/SquadAction.html" name="net.psforever.packet.game.SquadAction" id="net.psforever.packet.game.SquadAction" class="extype">packet.game.SquadAction</a></span>, <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><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionCancelSquadSearch" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionCancelSquadSearch(charId:Long):Unit"></a><a id="SquadActionDefinitionCancelSquadSearch(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionCancelSquadSearch(charId: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">SquadActionDefinitionCancelSquadSearch</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionDisplaySquad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionDisplaySquad(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="SquadActionDefinitionDisplaySquad(Player,PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionDisplaySquad(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID):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">SquadActionDefinitionDisplaySquad</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <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><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">the following action can be performed by anyone</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionSearchForSquadsWithParticularRole" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionSearchForSquadsWithParticularRole(tplayer:net.psforever.objects.Player,criteria:net.psforever.packet.game.SquadAction.SearchForSquadsWithParticularRole):Unit"></a><a id="SquadActionDefinitionSearchForSquadsWithParticularRole(Player,SearchForSquadsWithParticularRole):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionSearchForSquadsWithParticularRole(tplayer:net.psforever.objects.Player,criteria:net.psforever.packet.game.SquadAction.SearchForSquadsWithParticularRole):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">SquadActionDefinitionSearchForSquadsWithParticularRole</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="criteria">criteria: <a href="../../packet/game/SquadAction$$SearchForSquadsWithParticularRole.html" name="net.psforever.packet.game.SquadAction.SearchForSquadsWithParticularRole" id="net.psforever.packet.game.SquadAction.SearchForSquadsWithParticularRole" class="extype">SearchForSquadsWithParticularRole</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionSquadInitializationIssue" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionSquadInitializationIssue(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="SquadActionDefinitionSquadInitializationIssue(Player,PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionSquadInitializationIssue(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID):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">SquadActionDefinitionSquadInitializationIssue</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <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><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionInitCharId" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionInitCharId(tplayer:net.psforever.objects.Player):Unit"></a><a id="SquadActionInitCharId(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionInitCharId(tplayer: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">SquadActionInitCharId</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/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="net.psforever.services.teamwork.SquadService#SquadActionInitSquadList" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionInitSquadList(tplayer:net.psforever.objects.Player,sender:akka.actor.ActorRef):Unit"></a><a id="SquadActionInitSquadList(Player,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionInitSquadList(tplayer:net.psforever.objects.Player,sender:akka.actor.ActorRef):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">SquadActionInitSquadList</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembership" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembership(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone,action:Any):Unit"></a><a id="SquadActionMembership(Player,Zone,Any):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembership(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone,action:Any):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">SquadActionMembership</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>, <span name="action">action: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipAccept" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipAccept(tplayer:net.psforever.objects.Player,invitedPlayer:Long):Unit"></a><a id="SquadActionMembershipAccept(Player,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipAccept(tplayer:net.psforever.objects.Player,invitedPlayer: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">SquadActionMembershipAccept</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipCancel" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipCancel(cancellingPlayer:Long):Unit"></a><a id="SquadActionMembershipCancel(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipCancel(cancellingPlayer: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">SquadActionMembershipCancel</span><span class="params">(<span name="cancellingPlayer">cancellingPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipDisband" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipDisband(charId:Long):Unit"></a><a id="SquadActionMembershipDisband(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipDisband(charId: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">SquadActionMembershipDisband</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipInvite" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipInvite(tplayer:net.psforever.objects.Player,invitingPlayer:Long,_invitedPlayer:Long,invitedName:String):Unit"></a><a id="SquadActionMembershipInvite(Player,Long,Long,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipInvite(tplayer:net.psforever.objects.Player,invitingPlayer:Long,_invitedPlayer:Long,invitedName: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">SquadActionMembershipInvite</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="_invitedPlayer">_invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="invitedName">invitedName: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipLeave" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipLeave(tplayer:net.psforever.objects.Player,actingPlayer:Long,_leavingPlayer:Option[Long],name:String):Unit"></a><a id="SquadActionMembershipLeave(Player,Long,Option[Long],String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipLeave(tplayer:net.psforever.objects.Player,actingPlayer:Long,_leavingPlayer:Option[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">SquadActionMembershipLeave</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="actingPlayer">actingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="_leavingPlayer">_leavingPlayer: <span name="scala.Option" class="extype">Option</span>[<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></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipPromote" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipPromote(sponsoringPlayer:Long,promotedPlayer:Long,features:net.psforever.objects.teamwork.SquadFeatures,msg:net.psforever.services.teamwork.SquadServiceMessage,ref:akka.actor.ActorRef):Unit"></a><a id="SquadActionMembershipPromote(Long,Long,SquadFeatures,SquadServiceMessage,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipPromote(sponsoringPlayer:Long,promotedPlayer:Long,features:net.psforever.objects.teamwork.SquadFeatures,msg:net.psforever.services.teamwork.SquadServiceMessage,ref:akka.actor.ActorRef):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">SquadActionMembershipPromote</span><span class="params">(<span name="sponsoringPlayer">sponsoringPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="promotedPlayer">promotedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <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="msg">msg: <a href="SquadServiceMessage.html" name="net.psforever.services.teamwork.SquadServiceMessage" id="net.psforever.services.teamwork.SquadServiceMessage" class="extype">SquadServiceMessage</a></span>, <span name="ref">ref: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipPromote" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipPromote(sponsoringPlayer:Long,promotionCandidatePlayer:Long,promotionCandidateName:String,msg:net.psforever.services.teamwork.SquadServiceMessage,ref:akka.actor.ActorRef):Unit"></a><a id="SquadActionMembershipPromote(Long,Long,String,SquadServiceMessage,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipPromote(sponsoringPlayer:Long,promotionCandidatePlayer:Long,promotionCandidateName:String,msg:net.psforever.services.teamwork.SquadServiceMessage,ref:akka.actor.ActorRef):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">SquadActionMembershipPromote</span><span class="params">(<span name="sponsoringPlayer">sponsoringPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="promotionCandidatePlayer">promotionCandidatePlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="promotionCandidateName">promotionCandidateName: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <a href="SquadServiceMessage.html" name="net.psforever.services.teamwork.SquadServiceMessage" id="net.psforever.services.teamwork.SquadServiceMessage" class="extype">SquadServiceMessage</a></span>, <span name="ref">ref: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipProximityInvite" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipProximityInvite(zone:net.psforever.objects.zones.Zone,invitingPlayer:Long):Unit"></a><a id="SquadActionMembershipProximityInvite(Zone,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipProximityInvite(zone:net.psforever.objects.zones.Zone,invitingPlayer: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">SquadActionMembershipProximityInvite</span><span class="params">(<span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>, <span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionMembershipReject" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipReject(tplayer:net.psforever.objects.Player,rejectingPlayer:Long):Unit"></a><a id="SquadActionMembershipReject(Player,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipReject(tplayer:net.psforever.objects.Player,rejectingPlayer: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">SquadActionMembershipReject</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="rejectingPlayer">rejectingPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionUpdate" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionUpdate(message:net.psforever.services.teamwork.SquadServiceMessage,char_id:Long,replyTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionUpdate(SquadServiceMessage,Long,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionUpdate(message:net.psforever.services.teamwork.SquadServiceMessage,char_id:Long,replyTo:akka.actor.ActorRef):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">SquadActionUpdate</span><span class="params">(<span name="message">message: <a href="SquadServiceMessage.html" name="net.psforever.services.teamwork.SquadServiceMessage" id="net.psforever.services.teamwork.SquadServiceMessage" class="extype">SquadServiceMessage</a></span>, <span name="char_id">char_id: <span name="scala.Long" class="extype">Long</span></span>, <span name="replyTo">replyTo: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionWaypoint" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionWaypoint(message:net.psforever.services.teamwork.SquadServiceMessage,tplayer:net.psforever.objects.Player):Unit"></a><a id="SquadActionWaypoint(SquadServiceMessage,Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionWaypoint(message:net.psforever.services.teamwork.SquadServiceMessage,tplayer: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">SquadActionWaypoint</span><span class="params">(<span name="message">message: <a href="SquadServiceMessage.html" name="net.psforever.services.teamwork.SquadServiceMessage" id="net.psforever.services.teamwork.SquadServiceMessage" class="extype">SquadServiceMessage</a></span>, <span name="tplayer">tplayer: <a href="../../objects/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="net.psforever.services.teamwork.SquadService#SquadServiceReloadSquadDecoration" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadServiceReloadSquadDecoration(faction:net.psforever.types.PlanetSideEmpire.Value,to:Long):Unit"></a><a id="SquadServiceReloadSquadDecoration(types.PlanetSideEmpire.Value,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadServiceReloadSquadDecoration(faction:net.psforever.types.PlanetSideEmpire.Value,to: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">SquadServiceReloadSquadDecoration</span><span class="params">(<span name="faction">faction: <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 name="to">to: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#StartSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartSquad(player:net.psforever.objects.Player):net.psforever.objects.teamwork.SquadFeatures"></a><a id="StartSquad(Player):SquadFeatures"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#StartSquad(player:net.psforever.objects.Player):net.psforever.objects.teamwork.SquadFeatures" 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">StartSquad</span><span class="params">(<span name="player">player: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a></span></span><p class="shortcomment cmt">Establish a new squad.</p><div class="fullcomment"><div class="comment cmt"><p>Establish a new squad.
|
|
Create all of the support structures for the squad and link into them.
|
|
At a minimum, by default, the squad needs a squad leader
|
|
and a stronger, more exposed connection between the squad and leader needs to be recognized.<br>
|
|
<br>
|
|
Usually, a squad is created by modifying some aspect of its necessary fields.
|
|
The primary necessary fields required for a squad include the squad's task and the squad's zone of operation.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player who would become the squad leader</p></dd><dt>returns</dt><dd class="cmt"><p>the squad that has been created</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GetNextSquadId</code></p></span><span class="cmt"><p><code>Squad</code></p></span><span class="cmt"><p><code>SquadFeatures</code></p></span><span class="cmt"><p><code>SquadFeatures::Start</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#TerminatedBy" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="TerminatedBy(requestee:akka.actor.ActorRef):Unit"></a><a id="TerminatedBy(ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#TerminatedBy(requestee:akka.actor.ActorRef):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">TerminatedBy</span><span class="params">(<span name="requestee">requestee: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#TryResetSquadId" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryResetSquadId():Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#TryResetSquadId():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">TryResetSquadId</span><span class="params">()</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Set the unique squad identifier back to the start if no squads are active.</p><div class="fullcomment"><div class="comment cmt"><p>Set the unique squad identifier back to the start if no squads are active.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the identifier is reset; <code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#UpdateSquadList" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadList(features:net.psforever.objects.teamwork.SquadFeatures,changes:Option[net.psforever.packet.game.SquadInfo]):Unit"></a><a id="UpdateSquadList(SquadFeatures,Option[SquadInfo]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadList(features:net.psforever.objects.teamwork.SquadFeatures,changes:Option[net.psforever.packet.game.SquadInfo]):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">UpdateSquadList</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="changes">changes: <span name="scala.Option" class="extype">Option</span>[<a href="../../packet/game/SquadInfo.html" name="net.psforever.packet.game.SquadInfo" id="net.psforever.packet.game.SquadInfo" class="extype">SquadInfo</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
|
|
and focus on any specific aspects of it, purported as being changed recently.<br>
|
|
<br>
|
|
What sort of message is dispatched is not only based on the input parameters
|
|
but also on the state of previously listed squad information.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch a message entailing the composition of this squad
|
|
and focus on any specific aspects of it, purported as being changed recently.<br>
|
|
<br>
|
|
What sort of message is dispatched is not only based on the input parameters
|
|
but also on the state of previously listed squad information.
|
|
Listed squad information is queued when it is first published, organized first by faction affinity, then by chronology.
|
|
The output is first determinate on whether the squad had previously been listed as available.
|
|
If so, it will either update its data to all valid faction associated entities with the provided changed data;
|
|
or, it will be removed from the list of available squads, if there is no provided change data.
|
|
If the squad can not be found,
|
|
the change data, whatever it is, is unimportant, and the squad will be listed in full for the first time.<br>
|
|
<br>
|
|
When a squad is first introduced to the aforementioned list,
|
|
thus first being published to all faction-associated parties,
|
|
the entirety of the squad list for that faction will be updated in one go.
|
|
It is not necessary to do this, but doing so saves index and unique squad identifier management
|
|
at the cost of the size of the packet to be dispatched.
|
|
When a squad is removed to the aforementioned list,
|
|
the same process occurs where the full list for that faction affiliation is sent as an update.
|
|
The procedure for updating individual squad fields is precise and targeted,
|
|
and has been or should be prepared in advance by the caller to this method.
|
|
As a consequence, when updating the entry for that squad,
|
|
the information used as the update does not necessarily reflect the actual information currently in the squad.</p></div><dl class="paramcmts block"><dt class="param">features</dt><dd class="cmt"><p>the squad</p></dd><dt class="param">changes</dt><dd class="cmt"><p>the optional highlighted aspects of the squad;
|
|
these "changes" do not have to reflect the actual squad but are related to the contents of the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadResponse.InitList</code></p></span><span class="cmt"><p><code>SquadResponse.UpdateList</code></p></span><span class="cmt"><p><code>SquadService.SquadList.Publish</code></p></span></dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostRestart(reason:Throwable):Unit"></a><a id="aroundPostRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#aroundPostRestart(reason:Throwable):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">aroundPostRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostStop():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#aroundPostStop():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">aroundPostStop</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>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreRestart(reason:Throwable,message:Option[Any]):Unit"></a><a id="aroundPreRestart(Throwable,Option[Any]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#aroundPreRestart(reason:Throwable,message:Option[Any]):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">aroundPreRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>, <span name="message">message: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreStart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreStart():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#aroundPreStart():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">aroundPreStart</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>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundReceive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundReceive(receive:akka.actor.Actor.Receive,msg:Any):Unit"></a><a id="aroundReceive(akka.actor.Actor.Receive,Any):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#aroundReceive(receive:akka.actor.Actor.Receive,msg:Any):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">aroundReceive</span><span class="params">(<span name="receive">receive: <span name="akka.actor.Actor.Receive" class="extype">akka.actor.Actor.Receive</span></span>, <span name="msg">msg: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</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/SquadService.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/SquadService.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="akka.actor.Actor#context" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="context:akka.actor.ActorContext"></a><a id="context:ActorContext"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#context:akka.actor.ActorContext" 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">context</span><span class="result">: <span name="akka.actor.ActorContext" class="extype">ActorContext</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</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/SquadService.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/SquadService.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/SquadService.html#finalize():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">finalize</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>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="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_<:AnyRef]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#getClass():Class[_]" 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">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ <: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#hashCode():Int" 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">hashCode</span><span class="params">()</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</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"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.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="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/services/teamwork/SquadService.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"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.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"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.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.services.teamwork.SquadService#performStartSquad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="performStartSquad(sender:akka.actor.ActorRef,player:net.psforever.objects.Player):Unit"></a><a id="performStartSquad(ActorRef,Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#performStartSquad(sender:akka.actor.ActorRef,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">performStartSquad</span><span class="params">(<span name="sender">sender: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="player">player: <a href="../../objects/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="akka.actor.Actor#postRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="postRestart(reason:Throwable):Unit"></a><a id="postRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#postRestart(reason:Throwable):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">postRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>)</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>Actor</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Exception]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#postStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="postStop():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#postStop():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">postStop</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><a href="" name="net.psforever.services.teamwork.SquadService" id="net.psforever.services.teamwork.SquadService" class="extype">SquadService</a> → Actor</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#preRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="preRestart(reason:Throwable,message:Option[Any]):Unit"></a><a id="preRestart(Throwable,Option[Any]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#preRestart(reason:Throwable,message:Option[Any]):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">preRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>, <span name="message">message: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>]</span>)</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>Actor</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Exception]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#preStart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="preStart():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#preStart():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">preStart</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>Actor</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Exception]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#receive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="receive:SquadService.this.Receive"></a><a id="receive:Receive"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#receive:SquadService.this.Receive" 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">receive</span><span class="result">: <a href="#Receive=akka.actor.Actor.Receive" name="net.psforever.services.teamwork.SquadService.Receive" id="net.psforever.services.teamwork.SquadService.Receive" class="extmbr">Receive</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.services.teamwork.SquadService" id="net.psforever.services.teamwork.SquadService" class="extype">SquadService</a> → Actor</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#self" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="self:akka.actor.ActorRef"></a><a id="self:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#self:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit final </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">self</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#sender" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sender():akka.actor.ActorRef"></a><a id="sender():ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#sender():akka.actor.ActorRef" 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">sender</span><span class="params">()</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#supervisorStrategy" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="supervisorStrategy:akka.actor.SupervisorStrategy"></a><a id="supervisorStrategy:SupervisorStrategy"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#supervisorStrategy:akka.actor.SupervisorStrategy" 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">supervisorStrategy</span><span class="result">: <span name="akka.actor.SupervisorStrategy" class="extype">SupervisorStrategy</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](=>T0):T0"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#synchronized[T0](x$1:=>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">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: => <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</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#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#toString():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">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#unhandled" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unhandled(message:Any):Unit"></a><a id="unhandled(Any):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#unhandled(message:Any):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">unhandled</span><span class="params">(<span name="message">message: <span name="scala.Any" class="extype">Any</span></span>)</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>Actor</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#wait():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">wait</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">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#wait(x$1:Long,x$2:Int):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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</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">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#wait(x$1:Long):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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</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">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="akka.actor.Actor" class="parent"><h3>Inherited from <span name="akka.actor.Actor" class="extype">Actor</span></h3></div><div name="scala.AnyRef" class="parent"><h3>Inherited from <span name="scala.AnyRef" class="extype">AnyRef</span></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3></div></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
|