mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-01-20 02:54:46 +00:00
244 lines
240 KiB
HTML
244 lines
240 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"><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="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#AddInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AddInvite(invitedPlayer:Long,invite:net.psforever.services.teamwork.SquadService.Invitation):Option[net.psforever.services.teamwork.SquadService.Invitation]"></a><a id="AddInvite(Long,Invitation):Option[Invitation]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#AddInvite(invitedPlayer:Long,invite:net.psforever.services.teamwork.SquadService.Invitation):Option[net.psforever.services.teamwork.SquadService.Invitation]" 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">AddInvite</span><span class="params">(<span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="invite">invite: <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a>]</span></span><p class="shortcomment cmt">Assign a provided invitation object to either the active or inactive position for a player.<br>
|
|
<br>
|
|
The determination for the active position is whether or not something is currently in the active position
|
|
or whether some mechanism tried to shift invitation object into the active position
|
|
but found nothing to shift.</p><div class="fullcomment"><div class="comment cmt"><p>Assign a provided invitation object to either the active or inactive position for a player.<br>
|
|
<br>
|
|
The determination for the active position is whether or not something is currently in the active position
|
|
or whether some mechanism tried to shift invitation object into the active position
|
|
but found nothing to shift.
|
|
If an invitation object originating from the reported player already exists,
|
|
a new one is not appended to the inactive queue.
|
|
This method should always be used as the entry point for the active and inactive invitation options
|
|
or as a part of the entry point for the aforesaid options.</p></div><dl class="paramcmts block"><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited;
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt class="param">invite</dt><dd class="cmt"><p>the "new" invitation envelop object</p></dd><dt>returns</dt><dd class="cmt"><p>an optional invite;
|
|
the invitation object in the active invite position;
|
|
<code>None</code>, if it is not added to either the active option or inactive position</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AddInviteAndRespond</code></p></span><span class="cmt"><p><code>AltAddInviteAndRespond</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#AddInviteAndRespond" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer:Long,name:String):Unit"></a><a id="AddInviteAndRespond(Long,Invitation,Long,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#AddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer: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">AddInviteAndRespond</span><span class="params">(<span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="targetInvite">targetInvite: <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a></span>, <span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Enqueue a newly-submitted invitation object
|
|
either as the active position or into the inactive positions
|
|
and dispatch a response for any invitation object that is discovered.</p><div class="fullcomment"><div class="comment cmt"><p>Enqueue a newly-submitted invitation object
|
|
either as the active position or into the inactive positions
|
|
and dispatch a response for any invitation object that is discovered.
|
|
Implementation of a workflow.</p></div><dl class="paramcmts block"><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited;
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt class="param">targetInvite</dt><dd class="cmt"><p>a comparison invitation object</p></dd><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dt class="param">name</dt><dd class="cmt"><p>a name to be used in message composition</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AddInvite</code></p></span><span class="cmt"><p><code>indirectInviteResp</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#AddWaypoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AddWaypoint(guid:net.psforever.types.PlanetSideGUID,waypointType:net.psforever.types.SquadWaypoints.Value,info:net.psforever.packet.game.WaypointInfo):Option[net.psforever.services.teamwork.SquadService.WaypointData]"></a><a id="AddWaypoint(PlanetSideGUID,types.SquadWaypoints.Value,WaypointInfo):Option[WaypointData]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#AddWaypoint(guid:net.psforever.types.PlanetSideGUID,waypointType:net.psforever.types.SquadWaypoints.Value,info:net.psforever.packet.game.WaypointInfo):Option[net.psforever.services.teamwork.SquadService.WaypointData]" 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">AddWaypoint</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="waypointType">waypointType: <a href="../../types/SquadWaypoints$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.SquadWaypoints.Value" id="net.psforever.types.SquadWaypoints.Value" class="extmbr">types.SquadWaypoints.Value</a></span>, <span name="info">info: <a href="../../packet/game/WaypointInfo.html" name="net.psforever.packet.game.WaypointInfo" id="net.psforever.packet.game.WaypointInfo" class="extype">WaypointInfo</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="SquadService$$WaypointData.html" name="net.psforever.services.teamwork.SquadService.WaypointData" id="net.psforever.services.teamwork.SquadService.WaypointData" class="extype">WaypointData</a>]</span></span><p class="shortcomment cmt">Display the indicated waypoint.<br>
|
|
<br>
|
|
Despite the name, no waypoints are actually "added."
|
|
All of the waypoints constantly exist as long as the squad to which they are attached exists.</p><div class="fullcomment"><div class="comment cmt"><p>Display the indicated waypoint.<br>
|
|
<br>
|
|
Despite the name, no waypoints are actually "added."
|
|
All of the waypoints constantly exist as long as the squad to which they are attached exists.
|
|
They are merely "activated" and "deactivated."</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the squad's unique identifier</p></dd><dt class="param">waypointType</dt><dd class="cmt"><p>the type of the waypoint</p></dd><dt class="param">info</dt><dd class="cmt"><p>information about the waypoint, as was reported by the client's packet</p></dd><dt>returns</dt><dd class="cmt"><p>the waypoint data, if the waypoint type is changed</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadWaypointRequest</code></p></span><span class="cmt"><p><code>WaypointInfo</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#AltAddInviteAndRespond" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AltAddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer:Long,name:String):Unit"></a><a id="AltAddInviteAndRespond(Long,Invitation,Long,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#AltAddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer: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">AltAddInviteAndRespond</span><span class="params">(<span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="targetInvite">targetInvite: <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a></span>, <span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Enqueue a newly-submitted invitation object
|
|
either as the active position or into the inactive positions
|
|
and dispatch a response for any invitation object that is discovered.</p><div class="fullcomment"><div class="comment cmt"><p>Enqueue a newly-submitted invitation object
|
|
either as the active position or into the inactive positions
|
|
and dispatch a response for any invitation object that is discovered.
|
|
Implementation of a workflow.</p></div><dl class="paramcmts block"><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited</p></dd><dt class="param">targetInvite</dt><dd class="cmt"><p>a comparison invitation object</p></dd><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dt class="param">name</dt><dd class="cmt"><p>a name to be used in message composition</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AddInvite</code></p></span><span class="cmt"><p><code>altIndirectInviteResp</code></p></span></dd></dl></div></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>Publish</code></p></span><span class="cmt"><p><code>RemoveAllInvitesToSquad</code></p></span><span class="cmt"><p><code>SquadDetail</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(squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="DisbandSquad(Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#DisbandSquad(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">DisbandSquad</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.
|
|
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">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>PanicDisbandSquad</code></p></span><span class="cmt"><p><code>Publish</code></p></span><span class="cmt"><p><code>SquadResponse.Membership</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.Squad]):Option[net.psforever.objects.teamwork.Squad]"></a><a id="GetLeadingSquad(Long,Option[Squad]):Option[Squad]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetLeadingSquad(charId:Long,opt:Option[net.psforever.objects.teamwork.Squad]):Option[net.psforever.objects.teamwork.Squad]" 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/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.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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.Squad]):Option[net.psforever.objects.teamwork.Squad]"></a><a id="GetLeadingSquad(Player,Option[Squad]):Option[Squad]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetLeadingSquad(player:net.psforever.objects.Player,opt:Option[net.psforever.objects.teamwork.Squad]):Option[net.psforever.objects.teamwork.Squad]" 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/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.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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#GetParticipatingSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetParticipatingSquad(charId:Long):Option[net.psforever.objects.teamwork.Squad]"></a><a id="GetParticipatingSquad(Long):Option[Squad]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetParticipatingSquad(charId:Long):Option[net.psforever.objects.teamwork.Squad]" 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/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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.Squad]"></a><a id="GetParticipatingSquad(Player):Option[Squad]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetParticipatingSquad(player:net.psforever.objects.Player):Option[net.psforever.objects.teamwork.Squad]" 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/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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.Squad]"></a><a id="GetSquad(PlanetSideGUID):Option[Squad]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#GetSquad(id:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.teamwork.Squad]" 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/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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#HandleRequestRole" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.Invitation,guid:net.psforever.types.PlanetSideGUID,player:net.psforever.objects.Player):Boolean"></a><a id="HandleRequestRole(Invitation,PlanetSideGUID,Player):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.Invitation,guid:net.psforever.types.PlanetSideGUID,player:net.psforever.objects.Player):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">HandleRequestRole</span><span class="params">(<span name="bid">bid: <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</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="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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">The functionality for handling indirection
|
|
for handling one player requesting a specific squad role
|
|
or when messaging the squad leader about an invite.<br>
|
|
<br>
|
|
At this point in the squad join process, the only consent required is that of the squad leader.</p><div class="fullcomment"><div class="comment cmt"><p>The functionality for handling indirection
|
|
for handling one player requesting a specific squad role
|
|
or when messaging the squad leader about an invite.<br>
|
|
<br>
|
|
At this point in the squad join process, the only consent required is that of the squad leader.
|
|
An automatic consent flag exists on the squad;
|
|
but, if that is not set, then the squad leader must be asked whether or not to accept or to reject the recruit.
|
|
If the squad leader changes in the middle of the latter half of the process,
|
|
the invitation may still fail even if the old squad leader accepts.
|
|
If the squad leader changes in the middle of the latter half of the process,
|
|
the inquiry might be posed again of the new squad leader, of whether to accept or to reject the recruit.</p></div><dl class="paramcmts block"><dt class="param">bid</dt><dd class="cmt"><p>the <code>Invitation</code> object that was the target of this request</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier number</p></dd><dt class="param">player</dt><dd class="cmt"><p>the player who wants to join the squad</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the player is not denied the possibility of joining the squad;
|
|
<code>false</code>, otherwise, of it the squad does not exist</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#HandleRequestRole" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player):Boolean"></a><a id="HandleRequestRole(IndirectInvite,Player):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">HandleRequestRole</span><span class="params">(<span name="bid">bid: <a href="SquadService$$IndirectInvite.html" name="net.psforever.services.teamwork.SquadService.IndirectInvite" id="net.psforever.services.teamwork.SquadService.IndirectInvite" class="extype">IndirectInvite</a></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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">An overloaded entry point to the functionality for handling indirection when messaging the squad leader about an invite.</p><div class="fullcomment"><div class="comment cmt"><p>An overloaded entry point to the functionality for handling indirection when messaging the squad leader about an invite.</p></div><dl class="paramcmts block"><dt class="param">bid</dt><dd class="cmt"><p>a specific kind of <code>Invitation</code> object</p></dd><dt class="param">player</dt><dd class="cmt"><p>the player who wants to join the squad</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the player is not denied the possibility of joining the squad;
|
|
<code>false</code>, otherwise, of it the squad does not exist</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#HandleRequestRole" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.RequestRole,player:net.psforever.objects.Player):Boolean"></a><a id="HandleRequestRole(RequestRole,Player):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.RequestRole,player:net.psforever.objects.Player):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">HandleRequestRole</span><span class="params">(<span name="bid">bid: <a href="SquadService$$RequestRole.html" name="net.psforever.services.teamwork.SquadService.RequestRole" id="net.psforever.services.teamwork.SquadService.RequestRole" class="extype">RequestRole</a></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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">An overloaded entry point to the functionality for handling one player requesting a specific squad role.</p><div class="fullcomment"><div class="comment cmt"><p>An overloaded entry point to the functionality for handling one player requesting a specific squad role.</p></div><dl class="paramcmts block"><dt class="param">bid</dt><dd class="cmt"><p>a specific kind of <code>Invitation</code> object</p></dd><dt class="param">player</dt><dd class="cmt"><p>the player who wants to join the squad</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the player is not denied the possibility of joining the squad;
|
|
<code>false</code>, otherwise, of it the squad does not exist</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#HandleVacancyInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleVacancyInvite(squad:net.psforever.objects.teamwork.Squad,invitedPlayer:Long,invitingPlayer:Long,recruit:net.psforever.objects.Player):Option[(net.psforever.objects.teamwork.Squad,Int)]"></a><a id="HandleVacancyInvite(Squad,Long,Long,Player):Option[(Squad,Int)]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#HandleVacancyInvite(squad:net.psforever.objects.teamwork.Squad,invitedPlayer:Long,invitingPlayer:Long,recruit:net.psforever.objects.Player):Option[(net.psforever.objects.teamwork.Squad,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">HandleVacancyInvite</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 name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="recruit">recruit: <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/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>, <span name="scala.Int" class="extype">Int</span>)]</span></span><p class="shortcomment cmt">Resolve an invitation to a general, not guaranteed, position in someone else's squad.<br>
|
|
<br>
|
|
Originally, the instigating type of invitation object was a "<code>VacancyInvite</code>"
|
|
which indicated a type of undirected invitation extended from the squad leader to another player
|
|
but the resolution is generalized enough to suffice for a number of invitation objects.</p><div class="fullcomment"><div class="comment cmt"><p>Resolve an invitation to a general, not guaranteed, position in someone else's squad.<br>
|
|
<br>
|
|
Originally, the instigating type of invitation object was a "<code>VacancyInvite</code>"
|
|
which indicated a type of undirected invitation extended from the squad leader to another player
|
|
but the resolution is generalized enough to suffice for a number of invitation objects.
|
|
First, an actual position is determined;
|
|
then, the squad is tested for recruitment conditions,
|
|
including whether the person who solicited the would-be member is still the squad leader.
|
|
If the recruitment is manual and the squad leader is not the same as the recruiting player,
|
|
then the real squad leader is sent an indirect query regarding the player's eligibility.
|
|
These <code>IndirectInvite</code> invitation objects also are handled by calls to <code>HandleVacancyInvite</code>.</p></div><dl class="paramcmts block"><dt class="param">squad</dt><dd class="cmt"><p>the squad</p></dd><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited</p></dd><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dt class="param">recruit</dt><dd class="cmt"><p>the player being invited</p></dd><dt>returns</dt><dd class="cmt"><p>the squad object and a role position index, if properly invited;
|
|
<code>None</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AltAddInviteAndRespond</code></p></span><span class="cmt"><p><code>IndirectInvite</code></p></span><span class="cmt"><p><code>SquadFeatures::AutoApproveInvitationRequests</code></p></span><span class="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#HandleVacancyInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleVacancyInvite(squad_guid:net.psforever.types.PlanetSideGUID,invitedPlayer:Long,invitingPlayer:Long,recruit:net.psforever.objects.Player):Option[(net.psforever.objects.teamwork.Squad,Int)]"></a><a id="HandleVacancyInvite(PlanetSideGUID,Long,Long,Player):Option[(Squad,Int)]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#HandleVacancyInvite(squad_guid:net.psforever.types.PlanetSideGUID,invitedPlayer:Long,invitingPlayer:Long,recruit:net.psforever.objects.Player):Option[(net.psforever.objects.teamwork.Squad,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">HandleVacancyInvite</span><span class="params">(<span name="squad_guid">squad_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="recruit">recruit: <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/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>, <span name="scala.Int" class="extype">Int</span>)]</span></span><p class="shortcomment cmt">Resolve an invitation to a general, not guaranteed, position in someone else's squad.</p><div class="fullcomment"><div class="comment cmt"><p>Resolve an invitation to a general, not guaranteed, position in someone else's squad.
|
|
For the moment, just validate the provided parameters and confirm the eligibility of the user.</p></div><dl class="paramcmts block"><dt class="param">squad_guid</dt><dd class="cmt"><p>the unique squad identifier number</p></dd><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited</p></dd><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dt class="param">recruit</dt><dd class="cmt"><p>the player being invited</p></dd><dt>returns</dt><dd class="cmt"><p>the squad object and a role position index, if properly invited;
|
|
<code>None</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#InitSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitSquadDetail(guid:net.psforever.types.PlanetSideGUID,to:Iterable[Long],squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="InitSquadDetail(PlanetSideGUID,Iterable[Long],Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#InitSquadDetail(guid:net.psforever.types.PlanetSideGUID,to:Iterable[Long],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">InitSquadDetail</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="to">to: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</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">Dispatch an intial message entailing the strategic information and the composition of this squad.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch an intial message entailing the strategic information and the composition of this squad.
|
|
The details of the squad will be updated in full and be sent to all indicated observers.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier to be used when composing the details for this message</p></dd><dt class="param">to</dt><dd class="cmt"><p>the unique character identifier numbers of the players who will receive this message</p></dd><dt class="param">squad</dt><dd class="cmt"><p>the squad from which the squad details shall be composed</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadService.PublishFullDetails</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#InitSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitSquadDetail(squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="InitSquadDetail(Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#InitSquadDetail(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">InitSquadDetail</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">Dispatch a message entailing the composition of this squad.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch a message entailing the composition of this squad.
|
|
This is considered the first time this information will be dispatched to any relevant observers
|
|
so the details of the squad will be updated in full and be sent to all relevant observers,
|
|
namely, all the occupants of the squad.
|
|
External observers are ignored.</p></div><dl class="paramcmts block"><dt class="param">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>InitSquadDetail(PlanetSideGUID, Iterable[Long], Squad)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#InitWaypoints" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitWaypoints(toCharId:Long,guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="InitWaypoints(Long,PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#InitWaypoints(toCharId:Long,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">InitWaypoints</span><span class="params">(<span name="toCharId">toCharId: <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><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Dispatch all of the information about a given squad's waypoints to a user.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch all of the information about a given squad's waypoints to a user.</p></div><dl class="paramcmts block"><dt class="param">toCharId</dt><dd class="cmt"><p>the player to whom the waypoint data will be dispatched</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the squad's unique identifier</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#InitialAssociation" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitialAssociation(squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="InitialAssociation(Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#InitialAssociation(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">InitialAssociation</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">Pertains to the original message of squad synchronicity sent to the squad leader by the server under specific conditions.</p><div class="fullcomment"><div class="comment cmt"><p>Pertains to the original message of squad synchronicity sent to the squad leader by the server under specific conditions.
|
|
The initial formation of a squad of two players is the most common expected situation.
|
|
While the underlying flag is normally only set once, its state can be reset and triggered anew if necessary.</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>Publish</code></p></span><span class="cmt"><p><code><code>ResetAll</code></code></p></span><span class="cmt"><p><code>SquadResponse.AssociateWithSquad</code></p></span><span class="cmt"><p><code>SquadResponse.Detail</code></p></span><span class="cmt"><p><code>SquadService.PublishFullDetails</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#InviteResponseTemplate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InviteResponseTemplate(indirectVacancyFunc:(net.psforever.services.teamwork.SquadService.IndirectInvite,net.psforever.objects.Player,Long,Long,String)=>Boolean)(targetInvite:net.psforever.services.teamwork.SquadService.Invitation,actualInvite:Option[net.psforever.services.teamwork.SquadService.Invitation],invitedPlayer:Long,invitingPlayer:Long,name:String):Unit"></a><a id="InviteResponseTemplate((IndirectInvite,Player,Long,Long,String)=>Boolean)(Invitation,Option[Invitation],Long,Long,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#InviteResponseTemplate(indirectVacancyFunc:(net.psforever.services.teamwork.SquadService.IndirectInvite,net.psforever.objects.Player,Long,Long,String)=>Boolean)(targetInvite:net.psforever.services.teamwork.SquadService.Invitation,actualInvite:Option[net.psforever.services.teamwork.SquadService.Invitation],invitedPlayer:Long,invitingPlayer: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">InviteResponseTemplate</span><span class="params">(<span name="indirectVacancyFunc">indirectVacancyFunc: (<a href="SquadService$$IndirectInvite.html" name="net.psforever.services.teamwork.SquadService.IndirectInvite" id="net.psforever.services.teamwork.SquadService.IndirectInvite" class="extype">IndirectInvite</a>, <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>, <span name="scala.Long" class="extype">Long</span>, <span name="scala.Long" class="extype">Long</span>, <span name="scala.Predef.String" class="extype">String</span>) => <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="params">(<span name="targetInvite">targetInvite: <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a></span>, <span name="actualInvite">actualInvite: <span name="scala.Option" class="extype">Option</span>[<a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a>]</span>, <span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">A branched response for processing (new) invitation objects that have been submitted to the system.<br>
|
|
<br>
|
|
A comparison is performed between the original invitation object and an invitation object
|
|
that represents the potential modification or redirection of the current active invitation obect.</p><div class="fullcomment"><div class="comment cmt"><p>A branched response for processing (new) invitation objects that have been submitted to the system.<br>
|
|
<br>
|
|
A comparison is performed between the original invitation object and an invitation object
|
|
that represents the potential modification or redirection of the current active invitation obect.
|
|
Any further action is only performed when an "is equal" comparison is <code>true</code>.
|
|
When passing, the system publishes up to two messages
|
|
to users that would anticipate being informed of squad join activity.</p></div><dl class="paramcmts block"><dt class="param">indirectVacancyFunc</dt><dd class="cmt"><p>the method that cans the respondign behavior should an <code>IndirectVacancy</code> object being consumed</p></dd><dt class="param">targetInvite</dt><dd class="cmt"><p>a comparison invitation object;
|
|
represents the unmodified, unadjusted invite</p></dd><dt class="param">actualInvite</dt><dd class="cmt"><p>a comparaison invitation object;
|
|
proper use of this field should be the output of another process upon the following <code>actualInvite</code></p></dd><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dt class="param">name</dt><dd class="cmt"><p>a name to be used in message composition</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,squad:net.psforever.objects.teamwork.Squad,position:Int):Boolean"></a><a id="JoinSquad(Player,Squad,Int):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#JoinSquad(player:net.psforever.objects.Player,squad:net.psforever.objects.teamwork.Squad,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="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 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>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">squad</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>InitialAssociation</code></p></span><span class="cmt"><p><code>InitSquadDetail</code></p></span><span class="cmt"><p><code>InitWaypoints</code></p></span><span class="cmt"><p><code>Publish</code></p></span><span class="cmt"><p><code>RemoveAllInvitesWithPlayer</code></p></span><span class="cmt"><p><code>SquadDetail</code></p></span><span class="cmt"><p><code>SquadInfo</code></p></span><span class="cmt"><p><code>SquadPositionDetail</code></p></span><span class="cmt"><p><code>SquadPositionEntry</code></p></span><span class="cmt"><p><code>SquadResponse.Join</code></p></span><span class="cmt"><p><code>StatConverter.Health</code></p></span><span class="cmt"><p><code>UpdateSquadListWhenListed</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,squad:net.psforever.objects.teamwork.Squad):Boolean"></a><a id="LeaveSquad(Long,Squad):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#LeaveSquad(charId:Long,squad:net.psforever.objects.teamwork.Squad):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="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.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">squad</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>Publish</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#NextInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NextInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]"></a><a id="NextInvite(Long):Option[Invitation]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#NextInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]" 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">NextInvite</span><span class="params">(<span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a>]</span></span><p class="shortcomment cmt">Select the next invitation object to be shifted into the active position.<br>
|
|
<br>
|
|
The determination for the active position is whether or not something is currently in the active position
|
|
or whether some mechanism tried to shift invitation object into the active position
|
|
but found nothing to shift.</p><div class="fullcomment"><div class="comment cmt"><p>Select the next invitation object to be shifted into the active position.<br>
|
|
<br>
|
|
The determination for the active position is whether or not something is currently in the active position
|
|
or whether some mechanism tried to shift invitation object into the active position
|
|
but found nothing to shift.
|
|
After handling of the previous invitation object has completed or finished,
|
|
the temporary block on adding new invitations is removed
|
|
and any queued inactive invitation on the head of the inactive queue is shifted into the active position.</p></div><dl class="paramcmts block"><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited;
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt>returns</dt><dd class="cmt"><p>an optional invite;
|
|
the invitation object in the active invite position;
|
|
<code>None</code>, if not shifted into the active position</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>NextInviteAndRespond</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#NextInviteAndRespond" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NextInviteAndRespond(invitedPlayer:Long):Unit"></a><a id="NextInviteAndRespond(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#NextInviteAndRespond(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">NextInviteAndRespond</span><span class="params">(<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><p class="shortcomment cmt">Select the next invitation object to be shifted into the active position
|
|
and dispatch a response for any invitation object that is discovered.</p><div class="fullcomment"><div class="comment cmt"><p>Select the next invitation object to be shifted into the active position
|
|
and dispatch a response for any invitation object that is discovered.</p></div><dl class="paramcmts block"><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited;
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt>returns</dt><dd class="cmt"><p>an optional invite;
|
|
the invitation object in the active invite position;
|
|
<code>None</code>, if not shifted into the active position</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>InviteResponseTemplate</code></p></span><span class="cmt"><p><code>NextInvite</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(squad:net.psforever.objects.teamwork.Squad,membership:Iterable[Long]):Unit"></a><a id="PanicDisbandSquad(Squad,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#PanicDisbandSquad(squad:net.psforever.objects.teamwork.Squad,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="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 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">squad</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>Publish</code></p></span><span class="cmt"><p><code>SquadResponse.Membership</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#PanicLeaveSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PanicLeaveSquad(charId:Long,squad:net.psforever.objects.teamwork.Squad,entry:Option[(net.psforever.objects.teamwork.Member,Int)]):Boolean"></a><a id="PanicLeaveSquad(Long,Squad,Option[(Member,Int)]):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#PanicLeaveSquad(charId:Long,squad:net.psforever.objects.teamwork.Squad,entry:Option[(net.psforever.objects.teamwork.Member,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">PanicLeaveSquad</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></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 name="entry">entry: <span name="scala.Option" class="extype">Option</span>[(<a href="../../objects/teamwork/Member.html" name="net.psforever.objects.teamwork.Member" id="net.psforever.objects.teamwork.Member" class="extype">Member</a>, <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 undo the recruitment process for the squad role.<br>
|
|
<br>
|
|
The complement of the prior <code>LeaveSquad</code> method.</p><div class="fullcomment"><div class="comment cmt"><p>Behaviors and exchanges necessary to undo the recruitment process for the squad role.<br>
|
|
<br>
|
|
The complement of the prior <code>LeaveSquad</code> method.
|
|
This method deals entirely with other squad members observing the given squad member leaving the squad
|
|
while the other method handles messaging only for the squad member who is leaving.
|
|
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">charId</dt><dd class="cmt"><p>the player</p></dd><dt class="param">squad</dt><dd class="cmt"><p>the squad</p></dd><dt class="param">entry</dt><dd class="cmt"><p>a paired membership role with its index in the squad</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>LeaveSquad</code></p></span><span class="cmt"><p><code>Publish</code></p></span><span class="cmt"><p><code>SquadDetail</code></p></span><span class="cmt"><p><code>SquadInfo</code></p></span><span class="cmt"><p><code>SquadPositionDetail</code></p></span><span class="cmt"><p><code>SquadPositionEntry</code></p></span><span class="cmt"><p><code>SquadResponse.Leave</code></p></span><span class="cmt"><p><code>UpdateSquadDetail</code></p></span><span class="cmt"><p><code>UpdateSquadListWhenListed</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish[ANY>:Any](ANY,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="tparams">[<span name="ANY">ANY >: <span name="scala.Any" class="extype">Any</span></span>]</span><span class="params">(<span name="to">to: <span name="net.psforever.services.teamwork.SquadService.Publish.ANY" class="extype">ANY</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
No message can be sent using this distinction.
|
|
Log a warning.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>something that was expected to be used as the channel for the message
|
|
but is not handled as such</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish[ANY>:Any](ANY,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="tparams">[<span name="ANY">ANY >: <span name="scala.Any" class="extype">Any</span></span>]</span><span class="params">(<span name="to">to: <span name="net.psforever.services.teamwork.SquadService.Publish.ANY" class="extype">ANY</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
No message can be sent using this distinction.
|
|
Log a warning.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>something that was expected to be used as the channel for the message
|
|
but is not handled as such</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(Long,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Long" class="extype">Long</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(Long,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Long" class="extype">Long</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(String,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Strings come in three accepted patterns.
|
|
The first resolves into a faction name, as determined by <code>PlanetSideEmpire</code> when transformed into a string.
|
|
The second resolves into a squad's dedicated channel, a name that is formulaic.
|
|
The third resolves as a unique character identifier number.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a string used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
|
|
(resolved at destination, usually)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(String,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Strings come in three accepted patterns.
|
|
The first resolves into a faction name, as determined by <code>PlanetSideEmpire</code> when transformed into a string.
|
|
The second resolves into a squad's dedicated channel, a name that is formulaic.
|
|
The third resolves as a unique character identifier number.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a string used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(Type,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <a href="../../types/PlanetSideEmpire$.html#Type=net.psforever.types.PlanetSideEmpire.Value" name="net.psforever.types.PlanetSideEmpire.Type" id="net.psforever.types.PlanetSideEmpire.Type" class="extmbr">Type</a></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>SquadEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
|
|
(resolved at destination)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(Type,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <a href="../../types/PlanetSideEmpire$.html#Type=net.psforever.types.PlanetSideEmpire.Value" name="net.psforever.types.PlanetSideEmpire.Type" id="net.psforever.types.PlanetSideEmpire.Type" class="extmbr">Type</a></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>SquadEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(ActorRef,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
|
|
(resolved at destination)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(ActorRef,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#PublishedLists" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PublishedLists(guids:Iterable[net.psforever.types.PlanetSideGUID]):Vector[net.psforever.packet.game.SquadInfo]"></a><a id="PublishedLists(Iterable[PlanetSideGUID]):Vector[SquadInfo]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#PublishedLists(guids:Iterable[net.psforever.types.PlanetSideGUID]):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="guids">guids: <span name="scala.Iterable" class="extype">Iterable</span>[<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.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">guids</dt><dd class="cmt"><p>the list of squad unique identifier numbers</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#Refused" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Refused(charId:Long,list:List[Long]):List[Long]"></a><a id="Refused(Long,List[Long]):List[Long]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Refused(charId:Long,list:List[Long]):List[Long]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Refused</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="list">list: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span></span><p class="shortcomment cmt">This player has refused to join squad leader's squads or some other players's offers to form a squad.</p><div class="fullcomment"><div class="comment cmt"><p>This player has refused to join squad leader's squads or some other players's offers to form a squad.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the player who is doing the refusal</p></dd><dt class="param">list</dt><dd class="cmt"><p>the players who are refused</p></dd><dt>returns</dt><dd class="cmt"><p>the list of other players who have been refused</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Refused" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Refused(charId:Long,refusedCharId:Long):List[Long]"></a><a id="Refused(Long,Long):List[Long]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Refused(charId:Long,refusedCharId:Long):List[Long]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Refused</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="refusedCharId">refusedCharId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span></span><p class="shortcomment cmt">This player has refused to join squad leader's squads or some other players's offers to form a squad.</p><div class="fullcomment"><div class="comment cmt"><p>This player has refused to join squad leader's squads or some other players's offers to form a squad.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the player who is doing the refusal</p></dd><dt class="param">refusedCharId</dt><dd class="cmt"><p>the player who is refused</p></dd><dt>returns</dt><dd class="cmt"><p>the list of other players who have been refused</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#Refused" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Refused(charId:Long):List[Long]"></a><a id="Refused(Long):List[Long]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#Refused(charId:Long):List[Long]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Refused</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span></span><p class="shortcomment cmt">This player has refused to join squad leader's squads or some other players's offers to form a squad.</p><div class="fullcomment"><div class="comment cmt"><p>This player has refused to join squad leader's squads or some other players's offers to form a squad.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the player who refused other players</p></dd><dt>returns</dt><dd class="cmt"><p>the list of other players who have been refused</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveAllInvitesToSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveAllInvitesToSquad(sguid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="RemoveAllInvitesToSquad(PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveAllInvitesToSquad(sguid: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">RemoveAllInvitesToSquad</span><span class="params">(<span name="sguid">sguid: <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">Remove all active and inactive invitation objects that are related to the particular squad.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all active and inactive invitation objects that are related to the particular squad.
|
|
Specifically used to safely disarm obsolete invitation objects by specific criteria.
|
|
Affects all invitation object types and all data structures that deal with the squad.</p></div><dl class="paramcmts block"><dt class="param">sguid</dt><dd class="cmt"><p>the squad identifier</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RequestRole</code></p></span><span class="cmt"><p><code>IndirectInvite</code></p></span><span class="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><span class="cmt"><p><code>ProximityInvite</code></p></span><span class="cmt"><p><code>RemoveInvite</code></p></span><span class="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveAllInvitesWithPlayer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveAllInvitesWithPlayer(charId:Long):Unit"></a><a id="RemoveAllInvitesWithPlayer(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveAllInvitesWithPlayer(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">RemoveAllInvitesWithPlayer</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><p class="shortcomment cmt">Remove all active and inactive invitation objects that are related to the particular player.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all active and inactive invitation objects that are related to the particular player.
|
|
Specifically used to safely disarm obsolete invitation objects by specific criteria.
|
|
Affects all invitation object types and all data structures that deal with the player.</p></div><dl class="paramcmts block"><dt class="param">charId</dt><dd class="cmt"><p>the player's unique identifier number</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RequestRole</code></p></span><span class="cmt"><p><code>IndirectInvite</code></p></span><span class="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><span class="cmt"><p><code>RemoveInvite</code></p></span><span class="cmt"><p><code>RemoveProximityInvites</code></p></span><span class="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]"></a><a id="RemoveInvite(Long):Option[Invitation]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]" 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">RemoveInvite</span><span class="params">(<span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a>]</span></span><p class="shortcomment cmt">Remove any invitation object from the active position.</p><div class="fullcomment"><div class="comment cmt"><p>Remove any invitation object from the active position.
|
|
Flag the temporary field to indicate that the active position, while technically available,
|
|
should not yet have a new invitation object shifted into it yet.
|
|
This is the "proper" way to demote invitation objects from the active position
|
|
whether or not they are to be handled.</p></div><dl class="paramcmts block"><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited;
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt>returns</dt><dd class="cmt"><p>an optional invite;
|
|
the invitation object formerly in the active invite position;
|
|
<code>None</code>, if no invitation was in the active position</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>NextInvite</code></p></span><span class="cmt"><p><code>NextInviteAndRespond</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveInvitesForSquadAndPosition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveInvitesForSquadAndPosition(guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"></a><a id="RemoveInvitesForSquadAndPosition(PlanetSideGUID,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveInvitesForSquadAndPosition(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">RemoveInvitesForSquadAndPosition</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="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><p class="shortcomment cmt">Remove all active invitation objects that are related to the particular squad and the particular role in the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all active invitation objects that are related to the particular squad and the particular role in the squad.
|
|
Specifically used to safely disarm obsolete invitation objects related to the specific criteria.
|
|
Affects only certain invitation object types.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the squad identifier</p></dd><dt class="param">position</dt><dd class="cmt"><p>the role position index</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RequestRole</code></p></span><span class="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><span class="cmt"><p><code>RemoveInvite</code></p></span><span class="cmt"><p><code>RemoveQueuedInvitesForSquadAndPosition</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveProximityInvites" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveProximityInvites(guid:net.psforever.types.PlanetSideGUID):Iterable[(Long,String)]"></a><a id="RemoveProximityInvites(PlanetSideGUID):Iterable[(Long,String)]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveProximityInvites(guid:net.psforever.types.PlanetSideGUID):Iterable[(Long,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">RemoveProximityInvites</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Iterable" class="extype">Iterable</span>[(<span name="scala.Long" class="extype">Long</span>, <span name="scala.Predef.String" class="extype">String</span>)]</span></span><p class="shortcomment cmt">Remove all active and inactive proximity squad invites for a specific squad.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all active and inactive proximity squad invites for a specific squad.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the squad</p></dd><dt>returns</dt><dd class="cmt"><p>a list of all players (unique character identifier number and name) who had active proximity invitations</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveProximityInvites" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveProximityInvites(list:Iterable[(Long,net.psforever.types.PlanetSideGUID)]):Unit"></a><a id="RemoveProximityInvites(Iterable[(Long,PlanetSideGUID)]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveProximityInvites(list:Iterable[(Long,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">RemoveProximityInvites</span><span class="params">(<span name="list">list: <span name="scala.Iterable" class="extype">Iterable</span>[(<span name="scala.Long" class="extype">Long</span>, <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">Remove all queued proximity squad invite information retained by the squad object.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all queued proximity squad invite information retained by the squad object.</p></div><dl class="paramcmts block"><dt class="param">list</dt><dd class="cmt"><p>a list of players to squads with expected entry redundancy</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RemoveProximityInvites(Long)</code></p></span><span class="cmt"><p><code>SquadFeatures.ProxyInvites</code></p></span><span class="cmt"><p><code>SquadFeatures.SearchForRole</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveProximityInvites" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveProximityInvites(invitingPlayer:Long):Iterable[(Long,String)]"></a><a id="RemoveProximityInvites(Long):Iterable[(Long,String)]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveProximityInvites(invitingPlayer:Long):Iterable[(Long,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">RemoveProximityInvites</span><span class="params">(<span name="invitingPlayer">invitingPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Iterable" class="extype">Iterable</span>[(<span name="scala.Long" class="extype">Long</span>, <span name="scala.Predef.String" class="extype">String</span>)]</span></span><p class="shortcomment cmt">Remove all active and inactive proximity squad invites related to the recruiter.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all active and inactive proximity squad invites related to the recruiter.</p></div><dl class="paramcmts block"><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the player who did the recruiting</p></dd><dt>returns</dt><dd class="cmt"><p>a list of all players (unique character identifier number and name) who had active proximity invitations</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RemoveProximityInvites(Iterable[(Long, PlanetSideGUID)])</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveQueuedInvites" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveQueuedInvites(invitedPlayer:Long):List[net.psforever.services.teamwork.SquadService.Invitation]"></a><a id="RemoveQueuedInvites(Long):List[Invitation]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveQueuedInvites(invitedPlayer:Long):List[net.psforever.services.teamwork.SquadService.Invitation]" 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">RemoveQueuedInvites</span><span class="params">(<span name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a>]</span></span><p class="shortcomment cmt">Remove all inactive invites.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all inactive invites.</p></div><dl class="paramcmts block"><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited;
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt>returns</dt><dd class="cmt"><p>a list of the removed inactive invitation objects</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveQueuedInvitesForSquadAndPosition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveQueuedInvitesForSquadAndPosition(guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"></a><a id="RemoveQueuedInvitesForSquadAndPosition(PlanetSideGUID,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveQueuedInvitesForSquadAndPosition(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">RemoveQueuedInvitesForSquadAndPosition</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="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><p class="shortcomment cmt">Remove all inactive invitation objects that are related to the particular squad and the particular role in the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Remove all inactive invitation objects that are related to the particular squad and the particular role in the squad.
|
|
Specifically used to safely disarm obsolete invitation objects by specific criteria.
|
|
Affects only certain invitation object types.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the squad identifier</p></dd><dt class="param">position</dt><dd class="cmt"><p>the role position index</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RequestRole</code></p></span><span class="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><span class="cmt"><p><code>RemoveInvitesForSquadAndPosition</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#RemoveWaypoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveWaypoint(guid:net.psforever.types.PlanetSideGUID,waypointType:net.psforever.types.SquadWaypoints.Value):Unit"></a><a id="RemoveWaypoint(PlanetSideGUID,types.SquadWaypoints.Value):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#RemoveWaypoint(guid:net.psforever.types.PlanetSideGUID,waypointType:net.psforever.types.SquadWaypoints.Value):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">RemoveWaypoint</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="waypointType">waypointType: <a href="../../types/SquadWaypoints$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.SquadWaypoints.Value" id="net.psforever.types.SquadWaypoints.Value" class="extmbr">types.SquadWaypoints.Value</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Hide the indicated waypoint.</p><div class="fullcomment"><div class="comment cmt"><p>Hide the indicated waypoint.
|
|
Unused waypoints are marked by having a non-zero z-coordinate.<br>
|
|
<br>
|
|
Despite the name, no waypoints are actually "removed."
|
|
All of the waypoints constantly exist as long as the squad to which they are attached exists.
|
|
They are merely "activated" and "deactivated."</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the squad's unique identifier</p></dd><dt class="param">waypointType</dt><dd class="cmt"><p>the type of the waypoint</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(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone,guid:net.psforever.types.PlanetSideGUID,line:Int,action:net.psforever.packet.game.SquadAction,sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinition(Player,Zone,PlanetSideGUID,Int,packet.game.SquadAction,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinition(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone,guid:net.psforever.types.PlanetSideGUID,line:Int,action:net.psforever.packet.game.SquadAction,sendTo: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">SquadActionDefinition</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="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="line">line: <span name="scala.Int" class="extype">Int</span></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="sendTo">sendTo: <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#SquadActionDefinitionAddSquadMemberPosition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionAddSquadMemberPosition(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int):Unit"></a><a id="SquadActionDefinitionAddSquadMemberPosition(Player,Option[Squad],Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionAddSquadMemberPosition(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],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">SquadActionDefinitionAddSquadMemberPosition</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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#SquadActionDefinitionAssignSquadMemberToRole" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionAssignSquadMemberToRole(squad:net.psforever.objects.teamwork.Squad,guid:net.psforever.types.PlanetSideGUID,char_id:Long,position:Int):Unit"></a><a id="SquadActionDefinitionAssignSquadMemberToRole(Squad,PlanetSideGUID,Long,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionAssignSquadMemberToRole(squad:net.psforever.objects.teamwork.Squad,guid:net.psforever.types.PlanetSideGUID,char_id:Long,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">SquadActionDefinitionAssignSquadMemberToRole</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 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="char_id">char_id: <span name="scala.Long" class="extype">Long</span></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><p class="shortcomment cmt">the following action can be performed by ???</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionAutoApproveInvitationRequests" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionAutoApproveInvitationRequests(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],state:Boolean):Unit"></a><a id="SquadActionDefinitionAutoApproveInvitationRequests(Player,Option[Squad],Boolean):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionAutoApproveInvitationRequests(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],state:Boolean):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">SquadActionDefinitionAutoApproveInvitationRequests</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="state">state: <span name="scala.Boolean" class="extype">Boolean</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#SquadActionDefinitionCancelFind" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionCancelFind(lSquadOpt:Option[net.psforever.objects.teamwork.Squad]):Unit"></a><a id="SquadActionDefinitionCancelFind(Option[Squad]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionCancelFind(lSquadOpt:Option[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">SquadActionDefinitionCancelFind</span><span class="params">(<span name="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<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></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionCancelSelectRoleForYourself" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionCancelSelectRoleForYourself(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="SquadActionDefinitionCancelSelectRoleForYourself(Player,PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionCancelSelectRoleForYourself(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">SquadActionDefinitionCancelSelectRoleForYourself</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 who has tried to join a squad</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionChangeSquadMemberRequirementsCertifications" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionChangeSquadMemberRequirementsCertifications(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int,certs:Set[net.psforever.objects.avatar.Certification]):Unit"></a><a id="SquadActionDefinitionChangeSquadMemberRequirementsCertifications(Player,Option[Squad],Int,Set[Certification]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionChangeSquadMemberRequirementsCertifications(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int,certs:Set[net.psforever.objects.avatar.Certification]):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">SquadActionDefinitionChangeSquadMemberRequirementsCertifications</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="position">position: <span name="scala.Int" class="extype">Int</span></span>, <span name="certs">certs: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="../../objects/avatar/Certification.html" name="net.psforever.objects.avatar.Certification" id="net.psforever.objects.avatar.Certification" class="extype">Certification</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#SquadActionDefinitionChangeSquadMemberRequirementsDetailedOrders" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionChangeSquadMemberRequirementsDetailedOrders(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int,orders:String):Unit"></a><a id="SquadActionDefinitionChangeSquadMemberRequirementsDetailedOrders(Player,Option[Squad],Int,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionChangeSquadMemberRequirementsDetailedOrders(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int,orders: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">SquadActionDefinitionChangeSquadMemberRequirementsDetailedOrders</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="position">position: <span name="scala.Int" class="extype">Int</span></span>, <span name="orders">orders: <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#SquadActionDefinitionChangeSquadMemberRequirementsRole" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionChangeSquadMemberRequirementsRole(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int,role:String):Unit"></a><a id="SquadActionDefinitionChangeSquadMemberRequirementsRole(Player,Option[Squad],Int,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionChangeSquadMemberRequirementsRole(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int,role: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">SquadActionDefinitionChangeSquadMemberRequirementsRole</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="position">position: <span name="scala.Int" class="extype">Int</span></span>, <span name="role">role: <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#SquadActionDefinitionChangeSquadPurpose" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionChangeSquadPurpose(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],purpose:String):Unit"></a><a id="SquadActionDefinitionChangeSquadPurpose(Player,Option[Squad],String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionChangeSquadPurpose(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],purpose: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">SquadActionDefinitionChangeSquadPurpose</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="purpose">purpose: <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#SquadActionDefinitionChangeSquadZone" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionChangeSquadZone(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],zone_id:net.psforever.packet.game.PlanetSideZoneID,sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinitionChangeSquadZone(Player,Option[Squad],PlanetSideZoneID,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionChangeSquadZone(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],zone_id:net.psforever.packet.game.PlanetSideZoneID,sendTo: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">SquadActionDefinitionChangeSquadZone</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="zone_id">zone_id: <a href="../../packet/game/PlanetSideZoneID.html" name="net.psforever.packet.game.PlanetSideZoneID" id="net.psforever.packet.game.PlanetSideZoneID" class="extype">PlanetSideZoneID</a></span>, <span name="sendTo">sendTo: <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#SquadActionDefinitionCloseSquadMemberPosition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionCloseSquadMemberPosition(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int):Unit"></a><a id="SquadActionDefinitionCloseSquadMemberPosition(Player,Option[Squad],Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionCloseSquadMemberPosition(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],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">SquadActionDefinitionCloseSquadMemberPosition</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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#SquadActionDefinitionDeleteSquadFavorite" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionDeleteSquadFavorite(tplayer:net.psforever.objects.Player,line:Int,sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinitionDeleteSquadFavorite(Player,Int,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionDeleteSquadFavorite(tplayer:net.psforever.objects.Player,line:Int,sendTo: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">SquadActionDefinitionDeleteSquadFavorite</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="line">line: <span name="scala.Int" class="extype">Int</span></span>, <span name="sendTo">sendTo: <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#SquadActionDefinitionDisplaySquad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionDisplaySquad(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID,sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinitionDisplaySquad(Player,PlanetSideGUID,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionDisplaySquad(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID,sendTo: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">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 name="sendTo">sendTo: <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">the following action can be performed by anyone</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionFindLfsSoldiersForRole" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionFindLfsSoldiersForRole(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],position:Int):Unit"></a><a id="SquadActionDefinitionFindLfsSoldiersForRole(Player,Zone,Option[Squad],Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionFindLfsSoldiersForRole(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],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">SquadActionDefinitionFindLfsSoldiersForRole</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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#SquadActionDefinitionLoadSquadFavorite" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionLoadSquadFavorite(tplayer:net.psforever.objects.Player,line:Int,pSquadOpt:Option[net.psforever.objects.teamwork.Squad],lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinitionLoadSquadFavorite(Player,Int,Option[Squad],Option[Squad],ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionLoadSquadFavorite(tplayer:net.psforever.objects.Player,line:Int,pSquadOpt:Option[net.psforever.objects.teamwork.Squad],lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo: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">SquadActionDefinitionLoadSquadFavorite</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="line">line: <span name="scala.Int" class="extype">Int</span></span>, <span name="pSquadOpt">pSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="sendTo">sendTo: <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#SquadActionDefinitionLocationFollowsSquadLead" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionLocationFollowsSquadLead(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],state:Boolean):Unit"></a><a id="SquadActionDefinitionLocationFollowsSquadLead(Player,Option[Squad],Boolean):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionLocationFollowsSquadLead(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],state:Boolean):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">SquadActionDefinitionLocationFollowsSquadLead</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="state">state: <span name="scala.Boolean" class="extype">Boolean</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#SquadActionDefinitionRequestListSquad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionRequestListSquad(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinitionRequestListSquad(Player,Option[Squad],ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionRequestListSquad(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo: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">SquadActionDefinitionRequestListSquad</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="sendTo">sendTo: <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#SquadActionDefinitionResetAll" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionResetAll(lSquadOpt:Option[net.psforever.objects.teamwork.Squad]):Unit"></a><a id="SquadActionDefinitionResetAll(Option[Squad]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionResetAll(lSquadOpt:Option[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">SquadActionDefinitionResetAll</span><span class="params">(<span name="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<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></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionSaveSquadFavorite" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionSaveSquadFavorite(tplayer:net.psforever.objects.Player,line:Int,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinitionSaveSquadFavorite(Player,Int,Option[Squad],ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionSaveSquadFavorite(tplayer:net.psforever.objects.Player,line:Int,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo: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">SquadActionDefinitionSaveSquadFavorite</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="line">line: <span name="scala.Int" class="extype">Int</span></span>, <span name="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="sendTo">sendTo: <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#SquadActionDefinitionSelectRoleForYourself" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionSelectRoleForYourself(tplayer:net.psforever.objects.Player,guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"></a><a id="SquadActionDefinitionSelectRoleForYourself(Player,PlanetSideGUID,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionSelectRoleForYourself(tplayer:net.psforever.objects.Player,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">SquadActionDefinitionSelectRoleForYourself</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 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><p class="shortcomment cmt">the following action can be performed by an unaffiliated player</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#SquadActionDefinitionStopListSquad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionDefinitionStopListSquad(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionDefinitionStopListSquad(Player,Option[Squad],ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionDefinitionStopListSquad(tplayer:net.psforever.objects.Player,lSquadOpt:Option[net.psforever.objects.teamwork.Squad],sendTo: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">SquadActionDefinitionStopListSquad</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="lSquadOpt">lSquadOpt: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a>]</span>, <span name="sendTo">sendTo: <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#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#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(promotingPlayer:Long,_promotedPlayer:Long,promotedName:String):Unit"></a><a id="SquadActionMembershipPromote(Long,Long,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipPromote(promotingPlayer:Long,_promotedPlayer:Long,promotedName: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">SquadActionMembershipPromote</span><span class="params">(<span name="promotingPlayer">promotingPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="_promotedPlayer">_promotedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="promotedName">promotedName: <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#SquadActionMembershipProximityInvite" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadActionMembershipProximityInvite(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone,invitingPlayer:Long):Unit"></a><a id="SquadActionMembershipProximityInvite(Player,Zone,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionMembershipProximityInvite(tplayer:net.psforever.objects.Player,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="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="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(charId:Long,health:Int,maxHealth:Int,armor:Int,maxArmor:Int,pos:net.psforever.types.Vector3,zoneNumber:Int,sendTo:akka.actor.ActorRef):Unit"></a><a id="SquadActionUpdate(Long,Int,Int,Int,Int,Vector3,Int,ActorRef):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionUpdate(charId:Long,health:Int,maxHealth:Int,armor:Int,maxArmor:Int,pos:net.psforever.types.Vector3,zoneNumber:Int,sendTo: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="charId">charId: <span name="scala.Long" class="extype">Long</span></span>, <span name="health">health: <span name="scala.Int" class="extype">Int</span></span>, <span name="maxHealth">maxHealth: <span name="scala.Int" class="extype">Int</span></span>, <span name="armor">armor: <span name="scala.Int" class="extype">Int</span></span>, <span name="maxArmor">maxArmor: <span name="scala.Int" class="extype">Int</span></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="zoneNumber">zoneNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="sendTo">sendTo: <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(tplayer:net.psforever.objects.Player,waypointType:net.psforever.types.SquadWaypoints.Value,info:Option[net.psforever.packet.game.WaypointInfo]):Unit"></a><a id="SquadActionWaypoint(Player,types.SquadWaypoints.Value,Option[WaypointInfo]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SquadActionWaypoint(tplayer:net.psforever.objects.Player,waypointType:net.psforever.types.SquadWaypoints.Value,info:Option[net.psforever.packet.game.WaypointInfo]):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="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="waypointType">waypointType: <a href="../../types/SquadWaypoints$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.SquadWaypoints.Value" id="net.psforever.types.SquadWaypoints.Value" class="extmbr">types.SquadWaypoints.Value</a></span>, <span name="info">info: <span name="scala.Option" class="extype">Option</span>[<a href="../../packet/game/WaypointInfo.html" name="net.psforever.packet.game.WaypointInfo" id="net.psforever.packet.game.WaypointInfo" class="extype">WaypointInfo</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#StartSquad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartSquad(player:net.psforever.objects.Player):net.psforever.objects.teamwork.Squad"></a><a id="StartSquad(Player):Squad"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#StartSquad(player:net.psforever.objects.Player):net.psforever.objects.teamwork.Squad" 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/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</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#SwapMemberPosition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SwapMemberPosition(toMember:net.psforever.objects.teamwork.Member,fromMember:net.psforever.objects.teamwork.Member):Unit"></a><a id="SwapMemberPosition(Member,Member):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#SwapMemberPosition(toMember:net.psforever.objects.teamwork.Member,fromMember:net.psforever.objects.teamwork.Member):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">SwapMemberPosition</span><span class="params">(<span name="toMember">toMember: <a href="../../objects/teamwork/Member.html" name="net.psforever.objects.teamwork.Member" id="net.psforever.objects.teamwork.Member" class="extype">Member</a></span>, <span name="fromMember">fromMember: <a href="../../objects/teamwork/Member.html" name="net.psforever.objects.teamwork.Member" id="net.psforever.objects.teamwork.Member" class="extype">Member</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Move one player into one squad role and,
|
|
if encountering a player already recruited to the destination role,
|
|
swap that other player into the first player's position.</p><div class="fullcomment"><div class="comment cmt"><p>Move one player into one squad role and,
|
|
if encountering a player already recruited to the destination role,
|
|
swap that other player into the first player's position.
|
|
If no encounter, just blank the original role.</p></div><dl class="paramcmts block"><dt class="param">toMember</dt><dd class="cmt"><p>the squad role where the player is being placed</p></dd><dt class="param">fromMember</dt><dd class="cmt"><p>the squad role where the player is being encountered;
|
|
if a conflicting player is discovered, swap that player into <code>fromMember</code></p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AssignSquadMemberToRole</code></p></span><span class="cmt"><p><code>SelectRoleForYourself</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 (1) if no squads are active and no players are logged on.</p><div class="fullcomment"><div class="comment cmt"><p>Set the unique squad identifier back to the start (1) if no squads are active and no players are logged on.</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#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,toGuid:net.psforever.types.PlanetSideGUID,excluding:Iterable[Long],details:net.psforever.packet.game.SquadDetail):Unit"></a><a id="UpdateSquadDetail(PlanetSideGUID,PlanetSideGUID,Iterable[Long],SquadDetail):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,toGuid:net.psforever.types.PlanetSideGUID,excluding:Iterable[Long],details:net.psforever.packet.game.SquadDetail):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">UpdateSquadDetail</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="toGuid">toGuid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="excluding">excluding: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>, <span name="details">details: <a href="../../packet/game/SquadDetail.html" name="net.psforever.packet.game.SquadDetail" id="net.psforever.packet.game.SquadDetail" class="extype">SquadDetail</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing some of the strategic information and the composition to the existing members of the squad.
|
|
Also send the same information to any users who are watching the squad, potentially for want to join it.
|
|
The squad-specific message is contingent on finding the squad's features using the unique identifier number
|
|
and, from that, reporting to the specific squad's messaging channel.
|
|
Anyone watching the squad will always be updated the given details.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier number to be used for the squad detail message</p></dd><dt class="param">toGuid</dt><dd class="cmt"><p>the unique squad identifier number indicating the squad broadcast channel name</p></dd><dt class="param">excluding</dt><dd class="cmt"><p>the explicit unique character identifier numbers of individuals who should not receive the message</p></dd><dt class="param">details</dt><dd class="cmt"><p>the squad details to be included in the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>DisplaySquad</code></p></span><span class="cmt"><p><code>Publish</code></p></span><span class="cmt"><p><code>SquadDetail</code></p></span><span class="cmt"><p><code>SquadResponse.Detail</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,details:net.psforever.packet.game.SquadDetail):Unit"></a><a id="UpdateSquadDetail(PlanetSideGUID,SquadDetail):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,details:net.psforever.packet.game.SquadDetail):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">UpdateSquadDetail</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="details">details: <a href="../../packet/game/SquadDetail.html" name="net.psforever.packet.game.SquadDetail" id="net.psforever.packet.game.SquadDetail" class="extype">SquadDetail</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique identifier number of the squad</p></dd><dt class="param">details</dt><dd class="cmt"><p>the squad details to be included in the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadResponse.Detail</code></p></span><span class="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="UpdateSquadDetail(PlanetSideGUID,Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadDetail(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">UpdateSquadDetail</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="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">Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.
|
|
Rather than using the squad's existing unique identifier number,
|
|
a meaningful substitute identifier will be employed in the message.
|
|
The "meaningful substitute" is usually <code>PlanetSideGUID(0)</code>
|
|
which indicates the local non-squad squad data on the client of a squad leader.</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>SquadService.PublishFullDetails</code></p></span><span class="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="UpdateSquadDetail(Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadDetail(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">UpdateSquadDetail</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">Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.</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>SquadService.PublishFullDetails</code></p></span><span class="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#UpdateSquadList" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadList(squad:net.psforever.objects.teamwork.Squad,changes:Option[net.psforever.packet.game.SquadInfo]):Unit"></a><a id="UpdateSquadList(Squad,Option[SquadInfo]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadList(squad:net.psforever.objects.teamwork.Squad,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="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 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">squad</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="net.psforever.services.teamwork.SquadService#altIndirectInviteResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="altIndirectInviteResp(invite:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player,invitedPlayer:Long,invitingPlayer:Long,name:String):Boolean"></a><a id="altIndirectInviteResp(IndirectInvite,Player,Long,Long,String):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#altIndirectInviteResp(invite:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player,invitedPlayer:Long,invitingPlayer:Long,name:String):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">altIndirectInviteResp</span><span class="params">(<span name="invite">invite: <a href="SquadService$$IndirectInvite.html" name="net.psforever.services.teamwork.SquadService.IndirectInvite" id="net.psforever.services.teamwork.SquadService.IndirectInvite" class="extype">IndirectInvite</a></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 name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="invitingPlayer">invitingPlayer: <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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Component method used for the response behavior for processing the invitation object as an <code>IndirectInvite</code> object.</p><div class="fullcomment"><div class="comment cmt"><p>Component method used for the response behavior for processing the invitation object as an <code>IndirectInvite</code> object.</p></div><dl class="paramcmts block"><dt class="param">invite</dt><dd class="cmt"><p>the original invitation object that started this process</p></dd><dt class="param">player</dt><dd class="cmt"><p>the target of the response and invitation</p></dd><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited
|
|
in actuality, represents the player who will address the invitation object</p></dd><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dt class="param">name</dt><dd class="cmt"><p>a name to be used in message composition</p></dd><dt>returns</dt><dd class="cmt"><p>na</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>HandleRequestRole</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="net.psforever.services.teamwork.SquadService#indirectInviteResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="indirectInviteResp(invite:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player,invitedPlayer:Long,invitingPlayer:Long,name:String):Boolean"></a><a id="indirectInviteResp(IndirectInvite,Player,Long,Long,String):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService.html#indirectInviteResp(invite:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player,invitedPlayer:Long,invitingPlayer:Long,name:String):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">indirectInviteResp</span><span class="params">(<span name="invite">invite: <a href="SquadService$$IndirectInvite.html" name="net.psforever.services.teamwork.SquadService.IndirectInvite" id="net.psforever.services.teamwork.SquadService.IndirectInvite" class="extype">IndirectInvite</a></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 name="invitedPlayer">invitedPlayer: <span name="scala.Long" class="extype">Long</span></span>, <span name="invitingPlayer">invitingPlayer: <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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Component method used for the response behavior for processing the invitation object as an <code>IndirectInvite</code> object.</p><div class="fullcomment"><div class="comment cmt"><p>Component method used for the response behavior for processing the invitation object as an <code>IndirectInvite</code> object.</p></div><dl class="paramcmts block"><dt class="param">invite</dt><dd class="cmt"><p>the original invitation object that started this process</p></dd><dt class="param">player</dt><dd class="cmt"><p>the target of the response and invitation</p></dd><dt class="param">invitedPlayer</dt><dd class="cmt"><p>the unique character identifier for the player being invited;
|
|
in actuality, represents the player who will address the invitation object;
|
|
not useful here</p></dd><dt class="param">invitingPlayer</dt><dd class="cmt"><p>the unique character identifier for the player who invited the former;
|
|
not useful here</p></dd><dt class="param">name</dt><dd class="cmt"><p>a name to be used in message composition;
|
|
not useful here</p></dd><dt>returns</dt><dd class="cmt"><p>na</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>HandleRequestRole</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></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="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>
|