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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">invitedPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player being invited;
in actuality, represents the player who will address the invitation object</p></dd><dtclass="param">invite</dt><ddclass="cmt"><p>the "new" invitation envelop object</p></dd><dt>returns</dt><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>AddInviteAndRespond</code></p></span><spanclass="cmt"><p><code>AltAddInviteAndRespond</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#AddInviteAndRespond"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="AddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer:Long,name:String):Unit"></a><aid="AddInviteAndRespond(Long,Invitation,Long,String):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#AddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer:Long,name:String):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">AddInviteAndRespond</span><spanclass="params">(<spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="targetInvite">targetInvite: <ahref="SquadService$$Invitation.html"name="net.psforever.services.teamwork.SquadService.Invitation"id="net.psforever.services.teamwork.SquadService.Invitation"class="extype">Invitation</a></span>, <spanname="invitingPlayer">invitingPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="name">name: <spanname="scala.Predef.String"class="extype">String</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">invitedPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player being invited;
in actuality, represents the player who will address the invitation object</p></dd><dtclass="param">targetInvite</dt><ddclass="cmt"><p>a comparison invitation object</p></dd><dtclass="param">invitingPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dtclass="param">name</dt><ddclass="cmt"><p>a name to be used in message composition</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>AddInvite</code></p></span><spanclass="cmt"><p><code>indirectInviteResp</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#AddWaypoint"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="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><aid="AddWaypoint(PlanetSideGUID,types.SquadWaypoints.Value,WaypointInfo):Option[WaypointData]"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">AddWaypoint</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="waypointType">waypointType: <ahref="../../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>, <spanname="info">info: <ahref="../../packet/game/WaypointInfo.html"name="net.psforever.packet.game.WaypointInfo"id="net.psforever.packet.game.WaypointInfo"class="extype">WaypointInfo</a></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="SquadService$$WaypointData.html"name="net.psforever.services.teamwork.SquadService.WaypointData"id="net.psforever.services.teamwork.SquadService.WaypointData"class="extype">WaypointData</a>]</span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">guid</dt><ddclass="cmt"><p>the squad's unique identifier</p></dd><dtclass="param">waypointType</dt><ddclass="cmt"><p>the type of the waypoint</p></dd><dtclass="param">info</dt><ddclass="cmt"><p>information about the waypoint, as was reported by the client's packet</p></dd><dt>returns</dt><ddclass="cmt"><p>the waypoint data, if the waypoint type is changed</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>SquadWaypointRequest</code></p></span><spanclass="cmt"><p><code>WaypointInfo</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#AltAddInviteAndRespond"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="AltAddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer:Long,name:String):Unit"></a><aid="AltAddInviteAndRespond(Long,Invitation,Long,String):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#AltAddInviteAndRespond(invitedPlayer:Long,targetInvite:net.psforever.services.teamwork.SquadService.Invitation,invitingPlayer:Long,name:String):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">AltAddInviteAndRespond</span><spanclass="params">(<spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="targetInvite">targetInvite: <ahref="SquadService$$Invitation.html"name="net.psforever.services.teamwork.SquadService.Invitation"id="net.psforever.services.teamwork.SquadService.Invitation"class="extype">Invitation</a></span>, <spanname="invitingPlayer">invitingPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="name">name: <spanname="scala.Predef.String"class="extype">String</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">invitedPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player being invited</p></dd><dtclass="param">targetInvite</dt><ddclass="cmt"><p>a comparison invitation object</p></dd><dtclass="param">invitingPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dtclass="param">name</dt><ddclass="cmt"><p>a name to be used in message composition</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>AddInvite</code></p></span><spanclass="cmt"><p><code>altIndirectInviteResp</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#CloseSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="CloseSquad(squad:net.psforever.objects.teamwork.Squad):Unit"></a><aid="CloseSquad(Squad):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#CloseSquad(squad:net.psforever.objects.teamwork.Squad):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">CloseSquad</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">All players are made to leave the squad and the squad will stop existing.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>Publish</code></p></span><spanclass="cmt"><p><code>RemoveAllInvitesToSquad</code></p></span><spanclass="cmt"><p><code>SquadDetail</code></p></span><spanclass="cmt"><p><code>TryResetSquadId</code></p></span><spanclass="cmt"><p><code>UpdateSquadList</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#DisbandSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="DisbandSquad(squad:net.psforever.objects.teamwork.Squad):Unit"></a><aid="DisbandSquad(Squad):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#DisbandSquad(squad:net.psforever.objects.teamwork.Squad):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">DisbandSquad</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">All players are made to leave the squad and the squad will stop existing.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>PanicDisbandSquad</code></p></span><spanclass="cmt"><p><code>Publish</code></p></span><spanclass="cmt"><p><code>SquadResponse.Membership</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#EnsureEmptySquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="EnsureEmptySquad(charId:Long):Boolean"></a><aid="EnsureEmptySquad(Long):Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#EnsureEmptySquad(charId:Long):Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">EnsureEmptySquad</span><spanclass="params">(<spanname="charId">charId: <spanname="scala.Long"class="extype">Long</span></span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">Determine whether a player is sufficiently unemployed
and has no grand delusions of being a squad leader.</p><divclass="fullcomment"><divclass="comment cmt"><p>Determine whether a player is sufficiently unemployed
and has no grand delusions of being a squad leader.</p></div><dlclass="paramcmts block"><dtclass="param">charId</dt><ddclass="cmt"><p>the player</p></dd><dt>returns</dt><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>CloseSquad</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#GetLeadingSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="GetLeadingSquad(charId:Long,opt:Option[net.psforever.objects.teamwork.Squad]):Option[net.psforever.objects.teamwork.Squad]"></a><aid="GetLeadingSquad(Long,Option[Squad]):Option[Squad]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#GetLeadingSquad(charId:Long,opt:Option[net.psforever.objects.teamwork.Squad]):Option[net.psforever.objects.teamwork.Squad]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">GetLeadingSquad</span><spanclass="params">(<spanname="charId">charId: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="opt">opt: <spanname="scala.Option"class="extype">Option</span>[<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>]</span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>]</span></span><pclass="shortcomment cmt">If the player associated with this unique character identifier number is the leader of any squad, discover that squad.</p><divclass="fullcomment"><divclass="comment cmt"><p>If the player associated with this unique character identifier number is the leader of any squad, discover that squad.</p></div><dlclass="paramcmts block"><dtclass="param">charId</dt><ddclass="cmt"><p>the potential member identifier</p></dd><dtclass="param">opt</dt><ddclass="cmt"><p>an optional squad to check;
the expectation is that the provided squad is a known participating squad</p></dd><dt>returns</dt><ddclass="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>GetParticipatingSquad</code></p></span><spanclass="cmt"><p><code>Squad->Leader</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#GetLeadingSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="GetLeadingSquad(player:net.psforever.objects.Player,opt:Option[net.psforever.objects.teamwork.Squad]):Option[net.psforever.objects.teamwork.Squad]"></a><aid="GetLeadingSquad(Player,Option[Squad]):Option[Squad]"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">GetLeadingSquad</span><spanclass="params">(<spanname="player">player: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>, <spanname="opt">opt: <spanname="scala.Option"class="extype">Option</span>[<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>]</span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>]</span></span><pclass="shortcomment cmt">If this player is a member of any squad, discover that squad.</p><divclass="fullcomment"><divclass="comment cmt"><p>If this player is a member of any squad, discover that squad.</p></div><dlclass="paramcmts block"><dtclass="param">player</dt><ddclass="cmt"><p>the potential member</p></dd><dtclass="param">opt</dt><ddclass="cmt"><p>an optional squad to check;
the expectation is that the provided squad is a known participating squad</p></dd><dt>returns</dt><ddclass="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>GetParticipatingSquad</code></p></span><spanclass="cmt"><p><code>Squad::Leader</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#GetNextSquadId"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="GetNextSquadId():net.psforever.types.PlanetSideGUID"></a><aid="GetNextSquadId():PlanetSideGUID"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#GetNextSquadId():net.psforever.types.PlanetSideGUID"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">GetNextSquadId</span><spanclass="params">()</span><spanclass="result">: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span></span><pclass="shortcomment cmt">Produce the next available unique squad identifier.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dt>returns</dt><ddclass="cmt"><p>the current squad unique identifier number</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#GetParticipatingSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="GetParticipatingSquad(charId:Long):Option[net.psforever.objects.teamwork.Squad]"></a><aid="GetParticipatingSquad(Long):Option[Squad]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#GetParticipatingSquad(charId:Long):Option[net.psforever.objects.teamwork.Squad]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">GetParticipatingSquad</span><spanclass="params">(<spanname="charId">charId: <spanname="scala.Long"class="extype">Long</span></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>]</span></span><pclass="shortcomment cmt">If the player associated with this unique character identifier number is a member of any squad, discover that squad.</p><divclass="fullcomment"><divclass="comment cmt"><p>If the player associated with this unique character identifier number is a member of any squad, discover that squad.</p></div><dlclass="paramcmts block"><dtclass="param">charId</dt><ddclass="cmt"><p>the potential member identifier</p></dd><dt>returns</dt><ddclass="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#GetParticipatingSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="GetParticipatingSquad(player:net.psforever.objects.Player):Option[net.psforever.objects.teamwork.Squad]"></a><aid="GetParticipatingSquad(Player):Option[Squad]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#GetParticipatingSquad(player:net.psforever.objects.Player):Option[net.psforever.objects.teamwork.Squad]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">GetParticipatingSquad</span><spanclass="params">(<spanname="player">player: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>]</span></span><pclass="shortcomment cmt">If this player is a member of any squad, discover that squad.</p><divclass="fullcomment"><divclass="comment cmt"><p>If this player is a member of any squad, discover that squad.</p></div><dlclass="paramcmts block"><dtclass="param">player</dt><ddclass="cmt"><p>the potential member</p></dd><dt>returns</dt><ddclass="cmt"><p>the discovered squad, or <code>None</code></p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#GetSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="GetSquad(id:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.teamwork.Squad]"></a><aid="GetSquad(PlanetSideGUID):Option[Squad]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#GetSquad(id:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.teamwork.Squad]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="s
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><divclass="fullcomment"><divclass="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.
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><dlclass="paramcmts block"><dtclass="param">bid</dt><ddclass="cmt"><p>the <code>Invitation</code> object that was the target of this request</p></dd><dtclass="param">guid</dt><ddclass="cmt"><p>the unique squad identifier number</p></dd><dtclass="param">player</dt><ddclass="cmt"><p>the player who wants to join the squad</p></dd><dt>returns</dt><ddclass="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><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#HandleRequestRole"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player):Boolean"></a><aid="HandleRequestRole(IndirectInvite,Player):Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player):Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">HandleRequestRole</span><spanclass="params">(<spanname="bid">bid: <ahref="SquadService$$IndirectInvite.html"name="net.psforever.services.teamwork.SquadService.IndirectInvite"id="net.psforever.services.teamwork.SquadService.IndirectInvite"class="extype">IndirectInvite</a></span>, <spanname="player">player: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">An overloaded entry point to the functionality for handling indirection when messaging the squad leader about an invite.</p><divclass="fullcomment"><divclass="comment cmt"><p>An overloaded entry point to the functionality for handling indirection when messaging the squad leader about an invite.</p></div><dlclass="paramcmts block"><dtclass="param">bid</dt><ddclass="cmt"><p>a specific kind of <code>Invitation</code> object</p></dd><dtclass="param">player</dt><ddclass="cmt"><p>the player who wants to join the squad</p></dd><dt>returns</dt><ddclass="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><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#HandleRequestRole"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.RequestRole,player:net.psforever.objects.Player):Boolean"></a><aid="HandleRequestRole(RequestRole,Player):Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#HandleRequestRole(bid:net.psforever.services.teamwork.SquadService.RequestRole,player:net.psforever.objects.Player):Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">HandleRequestRole</span><spanclass="params">(<spanname="bid">bid: <ahref="SquadService$$RequestRole.html"name="net.psforever.services.teamwork.SquadService.RequestRole"id="net.psforever.services.teamwork.SquadService.RequestRole"class="extype">RequestRole</a></span>, <spanname="player">player: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">An overloaded entry point to the functionality for handling one player requesting a specific squad role.</p><divclass="fullcomment"><divclass="comment cmt"><p>An overloaded entry point to the functionality for handling one player requesting a specific squad role.</p></div><dlclass="paramcmts block"><dtclass="param">bid</dt><ddclass="cmt"><p>a specific kind of <code>Invitation</code> object</p></dd><dtclass="param">player</dt><ddclass="cmt"><p>the player who wants to join the squad</p></dd><dt>returns</dt><ddclass="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><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#HandleVacancyInvite"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="HandleVacancyInvite(squad:net.psforever.objects.teamwork.Squad,invitedPlayer:Long,invitingPlayer:Long,recruit:net.psforever.objects.Player):Option[(net.psforever.objects.teamwork.Squad,Int)]"></a><aid="HandleVacancyInvite(Squad,Long,Long,Player):Option[(Squad,Int)]"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">HandleVacancyInvite</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>, <spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="invitingPlayer">invitingPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="recruit">recruit: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[(<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>, <spanname="scala.Int"class="extype">Int</span>)]</span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd><dtclass="param">invitedPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player being invited</p></dd><dtclass="param">invitingPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dtclass="param">recruit</dt><ddclass="cmt"><p>the player being invited</p></dd><dt>returns</dt><ddclass="cmt"><p>the squad object and a role position index, if properly invited;
<code>None</code>, otherwise</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>AltAddInviteAndRespond</code></p></span><spanclass="cmt"><p><code>IndirectInvite</code></p></span><spanclass="cmt"><p><code>SquadFeatures::AutoApproveInvitationRequests</code></p></span><spanclass="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#HandleVacancyInvite"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="HandleVacancyInvite(squad_guid:net.psforever.types.PlanetSideGUID,invitedPlayer:Long,invitingPlayer:Long,recruit:net.psforever.objects.Player):Option[(net.psforever.objects.teamwork.Squad,Int)]"></a><aid="HandleVacancyInvite(PlanetSideGUID,Long,Long,Player):Option[(Squad,Int)]"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">HandleVacancyInvite</span><spanclass="params">(<spanname="squad_guid">squad_guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="invitingPlayer">invitingPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="recruit">recruit: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[(<ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a>, <spanname="scala.Int"class="extype">Int</span>)]</span></span><pclass="shortcomment cmt">Resolve an invitation to a general, not guaranteed, position in someone else's squad.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad_guid</dt><ddclass="cmt"><p>the unique squad identifier number</p></dd><dtclass="param">invitedPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player being invited</p></dd><dtclass="param">invitingPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dtclass="param">recruit</dt><ddclass="cmt"><p>the player being invited</p></dd><dt>returns</dt><ddclass="cmt"><p>the squad object and a role position index, if properly invited;
<code>None</code>, otherwise</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#InitSquadDetail"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="InitSquadDetail(guid:net.psforever.types.PlanetSideGUID,to:Iterable[Long],squad:net.psforever.objects.teamwork.Squad):Unit"></a><aid="InitSquadDetail(PlanetSideGUID,Iterable[Long],Squad):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#InitSquadDetail(guid:net.psforever.types.PlanetSideGUID,to:Iterable[Long],squad:net.psforever.objects.teamwork.Squad):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">InitSquadDetail</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="to">to: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>, <spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Dispatch an intial message entailing the strategic information and the composition of this squad.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">guid</dt><ddclass="cmt"><p>the unique squad identifier to be used when composing the details for this message</p></dd><dtclass="param">to</dt><ddclass="cmt"><p>the unique character identifier numbers of the players who will receive this message</p></dd><dtclass="param">squad</dt><ddclass="cmt"><p>the squad from which the squad details shall be composed</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>SquadService.PublishFullDetails</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#InitSquadDetail"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="InitSquadDetail(squad:net.psforever.objects.teamwork.Squad):Unit"></a><aid="InitSquadDetail(Squad):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#InitSquadDetail(squad:net.psforever.objects.teamwork.Squad):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">InitSquadDetail</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Dispatch a message entailing the composition of this squad.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>InitSquadDetail(PlanetSideGUID, Iterable[Long], Squad)</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#InitWaypoints"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="InitWaypoints(toCharId:Long,guid:net.psforever.types.PlanetSideGUID):Unit"></a><aid="InitWaypoints(Long,PlanetSideGUID):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#InitWaypoints(toCharId:Long,guid:net.psforever.types.PlanetSideGUID):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">InitWaypoints</span><spanclass="params">(<spanname="toCharId">toCharId: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Dispatch all of the information about a given squad's waypoints to a user.</p><divclass="fullcomment"><divclass="comment cmt"><p>Dispatch all of the information about a given squad's waypoints to a user.</p></div><dlclass="paramcmts block"><dtclass="param">toCharId</dt><ddclass="cmt"><p>the player to whom the waypoint data will be dispatched</p></dd><dtclass="param">guid</dt><ddclass="cmt"><p>the squad's unique identifier</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#InitialAssociation"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="InitialAssociation(squad:net.psforever.objects.teamwork.Squad):Unit"></a><aid="InitialAssociation(Squad):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#InitialAssociation(squad:net.psforever.objects.teamwork.Squad):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">InitialAssociation</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Pertains to the original message of squad synchronicity sent to the squad leader by the server under specific conditions.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>Publish</code></p></span><spanclass="cmt"><p><code><code>ResetAll</code></code></p></span><spanclass="cmt"><p><code>SquadResponse.AssociateWithSquad</code></p></span><spanclass="cmt"><p><code>SquadResponse.Detail</code></p></span><spanclass="cmt"><p><code>SquadService.PublishFullDetails</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#InviteResponseTemplate"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="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><aid="InviteResponseTemplate((IndirectInvite,Player,Long,Long,String)=>Boolean)(Invitation,Option[Invitation],Long,Long,String):Unit"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">InviteResponseTemplate</span><spanclass="params">(<spanname="indirectVacancyFunc">indirectVacancyFunc: (<ahref="SquadService$$IndirectInvite.html"name="net.psforever.services.teamwork.SquadService.IndirectInvite"id="net.psforever.services.teamwork.SquadService.IndirectInvite"class="extype">IndirectInvite</a>, <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a>, <spanname="scala.Long"class="extype">Long</span>, <spanname="scala.Long"class="extype">Long</span>, <spanname="scala.Predef.String"class="extype">String</span>) =><spanname="scala.Boolean"class="extype">Boolean</span></span>)</span><spanclass="params">(<spanname="targetInvite">targetInvite: <ahref="SquadService$$Invitation.html"name="net.psforever.services.teamwork.SquadService.Invitation"id="net.psforever.services.teamwork.SquadService.Invitation"class="extype">Invitation</a></span>, <spanname="actualInvite">actualInvite: <spanname="scala.Option"class="extype">Option</span>[<ahref="SquadService$$Invitation.html"name="net.psforever.services.teamwork.SquadService.Invitation"id="net.psforever.services.teamwork.SquadService.Invitation"class="extype">Invitation</a>]</span>, <spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="invitingPlayer">invitingPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="name">name: <spanname="scala.Predef.String"class="extype">String</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">A branched response for processing (new) invitation objects that have been submitted to the system.<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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">indirectVacancyFunc</dt><ddclass="cmt"><p>the method that cans the respondign behavior should an <code>IndirectVacancy</code> object being consumed</p></dd><dtclass="param">targetInvite</dt><ddclass="cmt"><p>a comparison invitation object;
represents the unmodified, unadjusted invite</p></dd><dtclass="param">actualInvite</dt><ddclass="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><dtclass="param">invitedPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player being invited
in actuality, represents the player who will address the invitation object</p></dd><dtclass="param">invitingPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dtclass="param">name</dt><ddclass="cmt"><p>a name to be used in message composition</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#JoinByCharacterId"group="Ungrouped"fullComment="no"data-isabs="false"visbl="pub"><aid="JoinByCharacterId(charId:String,sender:akka.actor.ActorRef):Unit"></a><aid="JoinByCharacterId(String,ActorRef):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#JoinByCharacterId(charId:String,sender:akka.actor.ActorRef):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">JoinByCharacterId</span><spanclass="params">(<spanname="charId">charId: <spanname="scala.Predef.String"class="extype">String</span></span>, <spanname="sender">sender: <spanname="akka.actor.ActorRef"class="extype">ActorRef</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#JoinByFaction"group="Ungrouped"fullComment="no"data-isabs="false"visbl="pub"><aid="JoinByFaction(faction:String,sender:akka.actor.ActorRef):Unit"></a><aid="JoinByFaction(String,ActorRef):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#JoinByFaction(faction:String,sender:akka.actor.ActorRef):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">JoinByFaction</span><spanclass="params">(<spanname="faction">faction: <spanname="scala.Predef.String"class="extype">String</span></span>, <spanname="sender">sender: <spanname="akka.actor.ActorRef"class="extype">ActorRef</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#JoinSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="JoinSquad(player:net.psforever.objects.Player,squad:net.psforever.objects.teamwork.Squad,position:Int):Boolean"></a><aid="JoinSquad(Player,Squad,Int):Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#JoinSquad(player:net.psforever.objects.Player,squad:net.psforever.objects.teamwork.Squad,position:Int):Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">JoinSquad</span><spanclass="params">(<spanname="player">player: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>, <spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>, <spanname="position">position: <spanname="scala.Int"class="extype">Int</span></span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">Behaviors and exchanges necessary to complete the fulfilled recruitment process for the squad role.<br>
This operation is fairly safe to call whenever a player is to be inducted into a squad.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">player</dt><ddclass="cmt"><p>the new squad member;
this player is NOT the squad leader</p></dd><dtclass="param">squad</dt><ddclass="cmt"><p>the squad the player is joining</p></dd><dtclass="param">position</dt><ddclass="cmt"><p>the squad member role that the player will be filling</p></dd><dt>returns</dt><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>InitialAssociation</code></p></span><spanclass="cmt"><p><code>InitSquadDetail</code></p></span><spanclass="cmt"><p><code>InitWaypoints</code></p></span><spanclass="cmt"><p><code>Publish</code></p></span><spanclass="cmt"><p><code>RemoveAllInvitesWithPlayer</code></p></span><spanclass="cmt"><p><code>SquadDetail</code></p></span><spanclass="cmt"><p><code>SquadInfo</code></p></span><spanclass="cmt"><p><code>SquadPositionDetail</code></p></span><spanclass="cmt"><p><code>SquadPositionEntry</code></p></span><spanclass="cmt"><p><code>SquadResponse.Join</code></p></span><spanclass="cmt"><p><code>StatConverter.Health</code></p></span><spanclass="cmt"><p><code>UpdateSquadListWhenListed</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#LeaveByCharacterId"group="Ungrouped"fullComment="no"data-isabs="false"visbl="pub"><aid="LeaveByCharacterId(charId:String,sender:akka.actor.ActorRef):Unit"></a><aid="LeaveByCharacterId(String,ActorRef):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#LeaveByCharacterId(charId:String,sender:akka.actor.ActorRef):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">LeaveByCharacterId</span><spanclass="params">(<spanname="charId">charId: <spanname="scala.Predef.String"class="extype">String</span></span>, <spanname="sender">sender: <spanname="akka.actor.ActorRef"class="extype">ActorRef</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#LeaveByFaction"group="Ungrouped"fullComment="no"data-isabs="false"visbl="pub"><aid="LeaveByFaction(faction:String,sender:akka.actor.ActorRef):Unit"></a><aid="LeaveByFaction(String,ActorRef):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#LeaveByFaction(faction:String,sender:akka.actor.ActorRef):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">LeaveByFaction</span><spanclass="params">(<spanname="faction">faction: <spanname="scala.Predef.String"class="extype">String</span></span>, <spanname="sender">sender: <spanname="akka.actor.ActorRef"class="extype">ActorRef</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#LeaveInGeneral"group="Ungrouped"fullComment="no"data-isabs="false"visbl="pub"><aid="LeaveInGeneral(sender:akka.actor.ActorRef):Unit"></a><aid="LeaveInGeneral(ActorRef):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#LeaveInGeneral(sender:akka.actor.ActorRef):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">LeaveInGeneral</span><spanclass="params">(<spanname="sender">sender: <spanname="akka.actor.ActorRef"class="extype">ActorRef</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#LeaveService"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="LeaveService(charId:Long,sender:akka.actor.ActorRef):Unit"></a><aid="LeaveService(Long,ActorRef):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadServic
<code>false</code>, otherwise</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>PanicLeaveSquad</code></p></span><spanclass="cmt"><p><code>Publish</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#NextInvite"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="NextInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]"></a><aid="NextInvite(Long):Option[Invitation]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#NextInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">NextInvite</span><spanclass="params">(<spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="SquadService$$Invitation.html"name="net.psforever.services.teamwork.SquadService.Invitation"id="net.psforever.services.teamwork.SquadService.Invitation"class="extype">Invitation</a>]</span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">invitedPlayer</dt><ddclass="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><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>NextInviteAndRespond</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#NextInviteAndRespond"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="NextInviteAndRespond(invitedPlayer:Long):Unit"></a><aid="NextInviteAndRespond(Long):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#NextInviteAndRespond(invitedPlayer:Long):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">NextInviteAndRespond</span><spanclass="params">(<spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">invitedPlayer</dt><ddclass="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><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>InviteResponseTemplate</code></p></span><spanclass="cmt"><p><code>NextInvite</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#PanicDisbandSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="PanicDisbandSquad(squad:net.psforever.objects.teamwork.Squad,membership:Iterable[Long]):Unit"></a><aid="PanicDisbandSquad(Squad,Iterable[Long]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#PanicDisbandSquad(squad:net.psforever.objects.teamwork.Squad,membership:Iterable[Long]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">PanicDisbandSquad</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>, <spanname="membership">membership: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd><dtclass="param">membership</dt><ddclass="cmt"><p>the unique character identifier numbers of the other squad members</p></dd><dt>returns</dt><ddclass="cmt"><p>if a role/index pair is provided</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>CloseSquad</code></p></span><spanclass="cmt"><p><code>DisbandSquad</code></p></span><spanclass="cmt"><p><code>Publish</code></p></span><spanclass="cmt"><p><code>SquadResponse.Membership</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#PanicLeaveSquad"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="PanicLeaveSquad(charId:Long,squad:net.psforever.objects.teamwork.Squad,entry:Option[(net.psforever.objects.teamwork.Member,Int)]):Boolean"></a><aid="PanicLeaveSquad(Long,Squad,Option[(Member,Int)]):Boolean"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">PanicLeaveSquad</span><spanclass="params">(<spanname="charId">charId: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>, <spanname="entry">entry: <spanname="scala.Option"class="extype">Option</span>[(<ahref="../../objects/teamwork/Member.html"name="net.psforever.objects.teamwork.Member"id="net.psforever.objects.teamwork.Member"class="extype">Member</a>, <spanname="scala.Int"class="extype">Int</span>)]</span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">charId</dt><ddclass="cmt"><p>the player</p></dd><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd><dtclass="param">entry</dt><ddclass="cmt"><p>a paired membership role with its index in the squad</p></dd><dt>returns</dt><ddclass="cmt"><p>if a role/index pair is provided</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>LeaveSquad</code></p></span><spanclass="cmt"><p><code>Publish</code></p></span><spanclass="cmt"><p><code>SquadDetail</code></p></span><spanclass="cmt"><p><code>SquadInfo</code></p></span><spanclass="cmt"><p><code>SquadPositionDetail</code></p></span><spanclass="cmt"><p><code>SquadPositionEntry</code></p></span><spanclass="cmt"><p><code>SquadResponse.Leave</code></p></span><spanclass="cmt"><p><code>UpdateSquadDetail</code></p></span><spanclass="cmt"><p><code>UpdateSquadListWhenListed</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#Publish"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><aid="Publish[ANY>:Any](ANY,Response,Iterable[Long]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Publish</span><spanclass="tparams">[<spanname="ANY">ANY >: <spanname="scala.Any"class="extype">Any</span></span>]</span><spanclass="params">(<spanname="to">to: <spanname="net.psforever.services.teamwork.SquadService.Publish.ANY"class="extype">ANY</span></span>, <spanname="msg">msg: <ahref="SquadResponse$$Response.html"name="net.psforever.services.teamwork.SquadResponse.Response"id="net.psforever.services.teamwork.SquadResponse.Response"class="extype">Response</a></span>, <spanname="excluded">excluded: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Overloaded message-sending operation.</p><divclass="fullcomment"><divclass="comment cmt"><p>Overloaded message-sending operation.
No message can be sent using this distinction.
Log a warning.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>something that was expected to be used as the channel for the message
but is not handled as such</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dtclass="param">excluded</dt><ddclass="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#Publish"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><aid="Publish[ANY>:Any](ANY,Response):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Publish</span><spanclass="tparams">[<spanname="ANY">ANY >: <spanname="scala.Any"class="extype">Any</span></span>]</span><spanclass="params">(<spanname="to">to: <spanname="net.psforever.services.teamwork.SquadService.Publish.ANY"class="extype">ANY</span></span>, <spanname="msg">msg: <ahref="SquadResponse$$Response.html"name="net.psforever.services.teamwork.SquadResponse.Response"id="net.psforever.services.teamwork.SquadResponse.Response"class="extype">Response</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Overloaded message-sending operation.</p><divclass="fullcomment"><divclass="comment cmt"><p>Overloaded message-sending operation.
No message can be sent using this distinction.
Log a warning.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>something that was expected to be used as the channel for the message
but is not handled as such</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#Publish"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><aid="Publish(Long,Response,Iterable[Long]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Publish</span><spanclass="params">(<spanname="to">to: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="msg">msg: <ahref="SquadResponse$$Response.html"name="net.psforever.services.teamwork.SquadResponse.Response"id="net.psforever.services.teamwork.SquadResponse.Response"class="extype">Response</a></span>, <spanname="excluded">excluded: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Overloaded message-sending operation.</p><divclass="fullcomment"><divclass="comment cmt"><p>Overloaded message-sending operation.
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dtclass="param">excluded</dt><ddclass="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#Publish"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><aid="Publish(Long,Response):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Publish</span><spanclass="params">(<spanname="to">to: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="msg">msg: <ahref="SquadResponse$$Response.html"name="net.psforever.services.teamwork.SquadResponse.Response"id="net.psforever.services.teamwork.SquadResponse.Response"class="extype">Response</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Overloaded message-sending operation.</p><divclass="fullcomment"><divclass="comment cmt"><p>Overloaded message-sending operation.
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#Publish"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><aid="Publish(String,Response,Iterable[Long]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Publish</span><spanclass="params">(<spanname="to">to: <spanname="scala.Predef.String"class="extype">String</span></span>, <spanname="msg">msg: <ahref="SquadResponse$$Response.html"name="net.psforever.services.teamwork.SquadResponse.Response"id="net.psforever.services.teamwork.SquadResponse.Response"class="extype">Response</a></span>, <spanname="excluded">excluded: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Overloaded message-sending operation.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>a string used as the channel for the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dtclass="param">excluded</dt><ddclass="cmt"><p>a group of character identifier numbers who should not receive the message
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><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>a string used as the channel for the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#Publish"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><aid="Publish(Type,Response,Iterable[Long]):Unit"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Publish</span><spanclass="params">(<spanname="to">to: <ahref="../../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>, <spanname="msg">msg: <ahref="SquadResponse$$Response.html"name="net.psforever.services.teamwork.SquadResponse.Response"id="net.psforever.services.teamwork.SquadResponse.Response"class="extype">Response</a></span>, <spanname="excluded">excluded: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Overloaded message-sending operation.</p><divclass="fullcomment"><divclass="comment cmt"><p>Overloaded message-sending operation.
Always publishes on the <code>SquadEvents</code> object.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dtclass="param">excluded</dt><ddclass="cmt"><p>a group of character identifier numbers who should not receive the message
Always publishes on the <code>SquadEvents</code> object.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#Publish"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><aid="Publish(ActorRef,Response,Iterable[Long]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">Publish</span><spanclass="params">(<spanname="to">to: <spanname="akka.actor.ActorRef"class="extype">ActorRef</span></span>, <spanname="msg">msg: <ahref="SquadResponse$$Response.html"name="net.psforever.services.teamwork.SquadResponse.Response"id="net.psforever.services.teamwork.SquadResponse.Response"class="extype">Response</a></span>, <spanname="excluded">excluded: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Overloaded message-sending operation.</p><divclass="fullcomment"><divclass="comment cmt"><p>Overloaded message-sending operation.
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dtclass="param">excluded</dt><ddclass="cmt"><p>a group of character identifier numbers who should not receive the message
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dlclass="paramcmts block"><dtclass="param">to</dt><ddclass="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dtclass="param">msg</dt><ddclass="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#PublishedLists"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="PublishedLists(guids:Iterable[net.psforever.types.PlanetSideGUID]):Vector[net.psforever.packet.game.SquadInfo]"></a><aid="PublishedLists(Iterable[PlanetSideGUID]):Vector[SquadInfo]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#PublishedLists(guids:Iterable[net.psforever.types.PlanetSideGUID]):Vector[net.psforever.packet.game.SquadInfo]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">PublishedLists</span><spanclass="params">(<spanname="guids">guids: <spanname="scala.Iterable"class="extype">Iterable</span>[<ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a>]</span>)</span><spanclass="result">: <spanname="scala.Vector"class="extype">Vector</span>[<ahref="../../packet/game/SquadInfo.html"name="net.psforever.packet.game.SquadInfo"id="net.psforever.packet.game.SquadInfo"class="extype">SquadInfo</a>]</span></span><pclass="shortcomment cmt">Transform a list of squad unique identifiers into a list of <code>SquadInfo</code> objects for updating the squad list window.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">guids</dt><ddclass="cmt"><p>the list of squad unique identifier numbers</p></dd><dt>returns</dt><ddclass="cmt"><p>a <code>Vector</code> of transformed squad data</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#PublishedLists"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="PublishedLists(faction:net.psforever.types.PlanetSideEmpire.Type):Vector[net.psforever.packet.game.SquadInfo]"></a><aid="PublishedLists(Type):Vector[SquadInfo]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#PublishedLists(faction:net.psforever.types.PlanetSideEmpire.Type):Vector[net.psforever.packet.game.SquadInfo]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">PublishedLists</span><spanclass="params">(<spanname="faction">faction: <ahref="../../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><spanclass="result">: <spanname="scala.Vector"class="extype">Vector</span>[<ahref="../../packet/game/SquadInfo.html"name="net.psforever.packet.game.SquadInfo"id="net.psforever.packet.game.SquadInfo"class="extype">SquadInfo</a>]</span></span><pclass="shortcomment cmt">Transform a list of squad unique identifiers into a list of <code>SquadInfo</code> objects for updating the squad list window.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">faction</dt><ddclass="cmt"><p>the faction to which the squads belong</p></dd><dt>returns</dt><ddclass="cmt"><p>a <code>Vector</code> of transformed squad dat
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><dlclass="paramcmts block"><dtclass="param">sguid</dt><ddclass="cmt"><p>the squad identifier</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>RequestRole</code></p></span><spanclass="cmt"><p><code>IndirectInvite</code></p></span><spanclass="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><spanclass="cmt"><p><code>ProximityInvite</code></p></span><spanclass="cmt"><p><code>RemoveInvite</code></p></span><spanclass="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#RemoveAllInvitesWithPlayer"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="RemoveAllInvitesWithPlayer(charId:Long):Unit"></a><aid="RemoveAllInvitesWithPlayer(Long):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#RemoveAllInvitesWithPlayer(charId:Long):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">RemoveAllInvitesWithPlayer</span><spanclass="params">(<spanname="charId">charId: <spanname="scala.Long"class="extype">Long</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Remove all active and inactive invitation objects that are related to the particular player.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">charId</dt><ddclass="cmt"><p>the player's unique identifier number</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>RequestRole</code></p></span><spanclass="cmt"><p><code>IndirectInvite</code></p></span><spanclass="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><spanclass="cmt"><p><code>RemoveInvite</code></p></span><spanclass="cmt"><p><code>RemoveProximityInvites</code></p></span><spanclass="cmt"><p><code>VacancyInvite</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#RemoveInvite"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="RemoveInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]"></a><aid="RemoveInvite(Long):Option[Invitation]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#RemoveInvite(invitedPlayer:Long):Option[net.psforever.services.teamwork.SquadService.Invitation]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">RemoveInvite</span><spanclass="params">(<spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>)</span><spanclass="result">: <spanname="scala.Option"class="extype">Option</span>[<ahref="SquadService$$Invitation.html"name="net.psforever.services.teamwork.SquadService.Invitation"id="net.psforever.services.teamwork.SquadService.Invitation"class="extype">Invitation</a>]</span></span><pclass="shortcomment cmt">Remove any invitation object from the active position.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">invitedPlayer</dt><ddclass="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><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>NextInvite</code></p></span><spanclass="cmt"><p><code>NextInviteAndRespond</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#RemoveInvitesForSquadAndPosition"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="RemoveInvitesForSquadAndPosition(guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"></a><aid="RemoveInvitesForSquadAndPosition(PlanetSideGUID,Int):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#RemoveInvitesForSquadAndPosition(guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">RemoveInvitesForSquadAndPosition</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="position">position: <spanname="scala.Int"class="extype">Int</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Remove all active invitation objects that are related to the particular squad and the particular role in the squad.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">guid</dt><ddclass="cmt"><p>the squad identifier</p></dd><dtclass="param">position</dt><ddclass="cmt"><p>the role position index</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>RequestRole</code></p></span><spanclass="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><spanclass="cmt"><p><code>RemoveInvite</code></p></span><spanclass="cmt"><p><code>RemoveQueuedInvitesForSquadAndPosition</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#RemoveProximityInvites"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="RemoveProximityInvites(guid:net.psforever.types.PlanetSideGUID):Iterable[(Long,String)]"></a><aid="RemoveProximityInvites(PlanetSideGUID):Iterable[(Long,String)]"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#RemoveProximityInvites(guid:net.psforever.types.PlanetSideGUID):Iterable[(Long,String)]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">RemoveProximityInvites</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>)</span><spanclass="result">: <spanname="scala.Iterable"class="extype">Iterable</span>[(<spanname="scala.Long"class="extype">Long</span>, <spanname="scala.Predef.String"class="extype">String</span>)]</span></span><pclass="shortcomment cmt">Remove all active and inactive proximity squad invites for a specific squad.</p><divclass="fullcomment"><divclass="comment cmt"><p>Remove all active and inactive proximity squad invites for a specific squad.</p></div><dlclass="paramcmts block"><dtclass="param">guid</dt><ddclass="cmt"><p>the squad</p></dd><dt>returns</dt><ddclass="cmt"><p>a list of all players (unique character identifier number and name) who had active proximity invitations</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#RemoveProximityInvites"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="RemoveProximityInvites(list:Iterable[(Long,net.psforever.types.PlanetSideGUID)]):Unit"></a><aid="RemoveProximityInvites(Iterable[(Long,PlanetSideGUID)]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#RemoveProximityInvites(list:Iterable[(Long,net.psforever.types.PlanetSideGUID)]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">RemoveProximityInvites</span><spanclass="params">(<spanname="list">list: <spanname="scala.Iterable"class="extype">Iterable</span>[(<spanname="scala.Long"class="extype">Long</span>, <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a>)]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Remove all queued proximity squad invite information retained by the squad object.</p><divclass="fullcomment"><divclass="comment cmt"><p>Remove all queued proximity squad invite information retained by the squad object.</p></div><dlclass="paramcmts block"><dtclass="param">list</dt><ddclass="cmt"><p>a list of players to squads with expected entry redundancy</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>RemoveProximityInvites(Long)</code></p></span><spanclass="cmt"><p><code>SquadFeatures.ProxyInvites</code></p></span><spanclass="cmt"><p><code>SquadFeatures.SearchForRole</code><
in actuality, represents the player who will address the invitation object</p></dd><dt>returns</dt><ddclass="cmt"><p>a list of the removed inactive invitation objects</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#RemoveQueuedInvitesForSquadAndPosition"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="RemoveQueuedInvitesForSquadAndPosition(guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"></a><aid="RemoveQueuedInvitesForSquadAndPosition(PlanetSideGUID,Int):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#RemoveQueuedInvitesForSquadAndPosition(guid:net.psforever.types.PlanetSideGUID,position:Int):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">RemoveQueuedInvitesForSquadAndPosition</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="position">position: <spanname="scala.Int"class="extype">Int</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Remove all inactive invitation objects that are related to the particular squad and the particular role in the squad.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">guid</dt><ddclass="cmt"><p>the squad identifier</p></dd><dtclass="param">position</dt><ddclass="cmt"><p>the role position index</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>RequestRole</code></p></span><spanclass="cmt"><p><code>LookingForSquadRoleInvite</code></p></span><spanclass="cmt"><p><code>RemoveInvitesForSquadAndPosition</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#RemoveWaypoint"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="RemoveWaypoint(guid:net.psforever.types.PlanetSideGUID,waypointType:net.psforever.types.SquadWaypoints.Value):Unit"></a><aid="RemoveWaypoint(PlanetSideGUID,types.SquadWaypoints.Value):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#RemoveWaypoint(guid:net.psforever.types.PlanetSideGUID,waypointType:net.psforever.types.SquadWaypoints.Value):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">RemoveWaypoint</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="waypointType">waypointType: <ahref="../../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><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Hide the indicated waypoint.</p><divclass="fullcomment"><divclass="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.
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><dlclass="paramcmts block"><dtclass="param">player</dt><ddclass="cmt"><p>the player who would become the squad leader</p></dd><dt>returns</dt><ddclass="cmt"><p>the squad that has been created</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>GetNextSquadId</code></p></span><spanclass="cmt"><p><code>Squad</code></p></span><spanclass="cmt"><p><code>SquadFeatures</code></p></span><spanclass="cmt"><p><code>SquadFeatures::Start</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#SwapMemberPosition"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="SwapMemberPosition(toMember:net.psforever.objects.teamwork.Member,fromMember:net.psforever.objects.teamwork.Member):Unit"></a><aid="SwapMemberPosition(Member,Member):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#SwapMemberPosition(toMember:net.psforever.objects.teamwork.Member,fromMember:net.psforever.objects.teamwork.Member):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">SwapMemberPosition</span><spanclass="params">(<spanname="toMember">toMember: <ahref="../../objects/teamwork/Member.html"name="net.psforever.objects.teamwork.Member"id="net.psforever.objects.teamwork.Member"class="extype">Member</a></span>, <spanname="fromMember">fromMember: <ahref="../../objects/teamwork/Member.html"name="net.psforever.objects.teamwork.Member"id="net.psforever.objects.teamwork.Member"class="extype">Member</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">toMember</dt><ddclass="cmt"><p>the squad role where the player is being placed</p></dd><dtclass="param">fromMember</dt><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>AssignSquadMemberToRole</code></p></span><spanclass="cmt"><p><code>SelectRoleForYourself</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#TerminatedBy"group="Ungrouped"fullComment="no"data-isabs="false"visbl="pub"><aid="TerminatedBy(requestee:akka.actor.ActorRef):Unit"></a><aid="TerminatedBy(ActorRef):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#TerminatedBy(requestee:akka.actor.ActorRef):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">TerminatedBy</span><spanclass="params">(<spanname="requestee">requestee: <spanname="akka.actor.ActorRef"class="extype">ActorRef</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#TryResetSquadId"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="TryResetSquadId():Boolean"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#TryResetSquadId():Boolean"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">TryResetSquadId</span><spanclass="params">()</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">Set the unique squad identifier back to the start (1) if no squads are active and no players are logged on.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dt>returns</dt><ddclass="cmt"><p><code>true</code>, if the identifier is reset; <code>false</code>, otherwise</p></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#UpdateSquadDetail"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,toGuid:net.psforever.types.PlanetSideGUID,excluding:Iterable[Long],details:net.psforever.packet.game.SquadDetail):Unit"></a><aid="UpdateSquadDetail(PlanetSideGUID,PlanetSideGUID,Iterable[Long],SquadDetail):Unit"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">UpdateSquadDetail</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="toGuid">toGuid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="excluding">excluding: <spanname="scala.Iterable"class="extype">Iterable</span>[<spanname="scala.Long"class="extype">Long</span>]</span>, <spanname="details">details: <ahref="../../packet/game/SquadDetail.html"name="net.psforever.packet.game.SquadDetail"id="net.psforever.packet.game.SquadDetail"class="extype">SquadDetail</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span>
Anyone watching the squad will always be updated the given details.</p></div><dlclass="paramcmts block"><dtclass="param">guid</dt><ddclass="cmt"><p>the unique squad identifier number to be used for the squad detail message</p></dd><dtclass="param">toGuid</dt><ddclass="cmt"><p>the unique squad identifier number indicating the squad broadcast channel name</p></dd><dtclass="param">excluding</dt><ddclass="cmt"><p>the explicit unique character identifier numbers of individuals who should not receive the message</p></dd><dtclass="param">details</dt><ddclass="cmt"><p>the squad details to be included in the message</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>DisplaySquad</code></p></span><spanclass="cmt"><p><code>Publish</code></p></span><spanclass="cmt"><p><code>SquadDetail</code></p></span><spanclass="cmt"><p><code>SquadResponse.Detail</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#UpdateSquadDetail"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,details:net.psforever.packet.game.SquadDetail):Unit"></a><aid="UpdateSquadDetail(PlanetSideGUID,SquadDetail):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,details:net.psforever.packet.game.SquadDetail):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">UpdateSquadDetail</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="details">details: <ahref="../../packet/game/SquadDetail.html"name="net.psforever.packet.game.SquadDetail"id="net.psforever.packet.game.SquadDetail"class="extype">SquadDetail</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p><divclass="fullcomment"><divclass="comment cmt"><p>Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p></div><dlclass="paramcmts block"><dtclass="param">guid</dt><ddclass="cmt"><p>the unique identifier number of the squad</p></dd><dtclass="param">details</dt><ddclass="cmt"><p>the squad details to be included in the message</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>SquadResponse.Detail</code></p></span><spanclass="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#UpdateSquadDetail"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,squad:net.psforever.objects.teamwork.Squad):Unit"></a><aid="UpdateSquadDetail(PlanetSideGUID,Squad):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,squad:net.psforever.objects.teamwork.Squad):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">UpdateSquadDetail</span><spanclass="params">(<spanname="guid">guid: <ahref="../../types/PlanetSideGUID.html"name="net.psforever.types.PlanetSideGUID"id="net.psforever.types.PlanetSideGUID"class="extype">PlanetSideGUID</a></span>, <spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psfo
which indicates the local non-squad squad data on the client of a squad leader.</p></div><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>SquadService.PublishFullDetails</code></p></span><spanclass="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#UpdateSquadDetail"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="UpdateSquadDetail(squad:net.psforever.objects.teamwork.Squad):Unit"></a><aid="UpdateSquadDetail(Squad):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadDetail(squad:net.psforever.objects.teamwork.Squad):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">UpdateSquadDetail</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="shortcomment cmt">Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.</p><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>SquadService.PublishFullDetails</code></p></span><spanclass="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#UpdateSquadList"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="UpdateSquadList(squad:net.psforever.objects.teamwork.Squad,changes:Option[net.psforever.packet.game.SquadInfo]):Unit"></a><aid="UpdateSquadList(Squad,Option[SquadInfo]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#UpdateSquadList(squad:net.psforever.objects.teamwork.Squad,changes:Option[net.psforever.packet.game.SquadInfo]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">UpdateSquadList</span><spanclass="params">(<spanname="squad">squad: <ahref="../../objects/teamwork/Squad.html"name="net.psforever.objects.teamwork.Squad"id="net.psforever.objects.teamwork.Squad"class="extype">Squad</a></span>, <spanname="changes">changes: <spanname="scala.Option"class="extype">Option</span>[<ahref="../../packet/game/SquadInfo.html"name="net.psforever.packet.game.SquadInfo"id="net.psforever.packet.game.SquadInfo"class="extype">SquadInfo</a>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><pclass="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><divclass="fullcomment"><divclass="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><dlclass="paramcmts block"><dtclass="param">squad</dt><ddclass="cmt"><p>the squad</p></dd><dtclass="param">changes</dt><ddclass="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><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>SquadResponse.InitList</code></p></span><spanclass="cmt"><p><code>SquadResponse.UpdateList</code></p></span><spanclass="cmt"><p><code>SquadService.SquadList.Publish</code></p></span></dd></dl></div></li><liclass="indented0 "name="net.psforever.services.teamwork.SquadService#altIndirectInviteResp"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="altIndirectInviteResp(invite:net.psforever.services.teamwork.SquadService.IndirectInvite,player:net.psforever.objects.Player,invitedPlayer:Long,invitingPlayer:Long,name:String):Boolean"></a><aid="altIndirectInviteResp(IndirectInvite,Player,Long,Long,String):Boolean"></a><spanclass="permalink"><ahref="../../../../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"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">altIndirectInviteResp</span><spanclass="params">(<spanname="invite">invite: <ahref="SquadService$$IndirectInvite.html"name="net.psforever.services.teamwork.SquadService.IndirectInvite"id="net.psforever.services.teamwork.SquadService.IndirectInvite"class="extype">IndirectInvite</a></span>, <spanname="player">player: <ahref="../../objects/Player.html"name="net.psforever.objects.Player"id="net.psforever.objects.Player"class="extype">Player</a></span>, <spanname="invitedPlayer">invitedPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="invitingPlayer">invitingPlayer: <spanname="scala.Long"class="extype">Long</span></span>, <spanname="name">name: <spanname="scala.Predef.String"class="extype">String</span></span>)</span><spanclass="result">: <spanname="scala.Boolean"class="extype">Boolean</span></span></span><pclass="shortcomment cmt">Component method used for the response behavior for processing the invitation object as an <code>IndirectInvite</code> object.</p><divclass="fullcomment"><divclass="comment cmt"><p>Component method used for the response behavior for processing the invitation object as an <code>IndirectInvite</code> object.</p></div><dlclass="paramcmts block"><dtclass="param">invite</dt><ddclass="cmt"><p>the original invitation object that started this process</p></dd><dtclass="param">player</dt><ddclass="cmt"><p>the target of the response and invitation</p></dd><dtclass="param">invitedPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player being invited
in actuality, represents the player who will address the invitation object</p></dd><dtclass="param">invitingPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player who invited the former</p></dd><dtclass="param">name</dt><ddclass="cmt"><p>a name to be used in message composition</p></dd><dt>returns</dt><ddclass="cmt"><p>na</p></dd></dl><dlclass="attributes block"><dt>See also</dt><dd><spanclass="cmt"><p><code>HandleRequestRole</code></p></span></dd></dl></div></li><liclass="indented0 "name="akka.actor.Actor#aroundPostRestart"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="prt"><aid="aroundPostRestart(reason:Throwable):Unit"></a><aid="aroundPostRestart(Throwable):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#aroundPostRestart(reason:Throwable):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">aroundPostRestart</span><spanclass="params">(<spanname="reason">reason: <spanname="scala.Throwable"class="extype">Throwable</span></span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><divclass="fullcomment"><dlclass="attributes block"><dt>Attributes</dt><dd>protected[<ahref="../../../../akka/index.html"name="akka"id="akka"class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><spanclass="name">@InternalApi</span><spanclass="args">()</span></dd></dl></div></li><liclass="indented0 "name="akka.actor.Actor#aroundPostStop"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="prt"><aid="aroundPostStop():Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#aroundPostStop():Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">aroundPostStop</span><spanclass="params">()</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><divclass="fullcomment"><dlclass="attributes block"><dt>Attributes</dt><dd>protected[<ahref="../../../../akka/index.html"name="akka"id="akka"class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><spanclass="name">@InternalApi</span><spanclass="args">()</span></dd></dl></div></li><liclass="indented0 "name="akka.actor.Actor#aroundPreRestart"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="prt"><aid="aroundPreRestart(reason:Throwable,message:Option[Any]):Unit"></a><aid="aroundPreRestart(Throwable,Option[Any]):Unit"></a><spanclass="permalink"><ahref="../../../../net/psforever/services/teamwork/SquadService.html#aroundPreRestart(reason:Throwable,message:Option[Any]):Unit"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">aroundPreRestart</span><spanclass="params">(<spanname="reason">reason: <spanname="scala.Throwable"class="extype">Throwable</span></span>, <spanname="message">message: <spanname="scala.Option"class="extype">Option</span>[<spanname="scala.Any"class="extype">Any</span>]</span>)</span><spanclass="result">: <spanname="scala.Unit"class="extype">Unit</span></span></span><divclass="fullcomment"><dlclass="attributes block"><dt>Attributes</dt><dd>protected[<ahref="../../../../akka/index.html"name="akka"id="akka"class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><spanclass="name">@InternalApi</span><spanclass="args">()</span></dd></dl></div></li><liclass="indented0 "name="akka.actor.Actor#aroundPreStart"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="prt"><aid="aroundPreStart():Unit"></a><spanc
in actuality, represents the player who will address the invitation object;
not useful here</p></dd><dtclass="param">invitingPlayer</dt><ddclass="cmt"><p>the unique character identifier for the player who invited the former;
not useful here</p></dd><dtclass="param">name</dt><ddclass="cmt"><p>a name to be used in message composition;
