PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-04-25 22:35:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/services/teamwork/SquadService$.html

15 lines
46 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.services.teamwork.SquadService</title><meta content="PSF - LoginServer - master - net.psforever.services.teamwork.SquadService" name="description"/><meta content="PSF LoginServer master net.psforever.services.teamwork.SquadService" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../lib/index.js"></script><script type="text/javascript" src="../../../../index.js"></script><script type="text/javascript" src="../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.services" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="services"></a><a id="services:services"></a> <span class="permalink"><a href="../../../../net/psforever/services/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">services</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.services.teamwork" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="teamwork"></a><a id="teamwork:teamwork"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">teamwor
No direct action causes this message.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player who would be joining the squad;
may or may not have actually requested it in the first place</p></dd><dt class="param">squad_guid</dt><dd class="cmt"><p>the squad</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService.Invitation" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="InvitationextendsAnyRef"></a><a id="Invitation:Invitation"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$$Invitation.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="SquadService$$Invitation.html" title="The base of all objects that exist for the purpose of communicating invitation from one player to the next."><span class="name">Invitation</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">The base of all objects that exist for the purpose of communicating invitation from one player to the next.</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService.LookingForSquadRoleInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LookingForSquadRoleInviteextendsSquadService.InvitationwithProductwithSerializable"></a><a id="LookingForSquadRoleInvite:LookingForSquadRoleInvite"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$$LookingForSquadRoleInvite.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SquadService$$LookingForSquadRoleInvite.html" title="Utilized in conjunction with an external queuing data structure to search for and submit requests to other players for the purposes of fill out an unoccupied squad role."><span class="name">LookingForSquadRoleInvite</span></a><span class="params">(<span name="char_id">char_id: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="squad_guid">squad_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="position">position: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Utilized in conjunction with an external queuing data structure
to search for and submit requests to other players
for the purposes of fill out an unoccupied squad role.</p><div class="fullcomment"><div class="comment cmt"><p>Utilized in conjunction with an external queuing data structure
to search for and submit requests to other players
for the purposes of fill out an unoccupied squad role.</p></div><dl class="paramcmts block"><dt class="param">char_id</dt><dd class="cmt"><p>the unique character identifier of the squad leader</p></dd><dt class="param">name</dt><dd class="cmt"><p>the name of the squad leader</p></dd><dt class="param">squad_guid</dt><dd class="cmt"><p>the squad with the role</p></dd><dt class="param">position</dt><dd class="cmt"><p>the index of the role</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService.ProximityInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ProximityInviteextendsSquadService.InvitationwithProductwithSerializable"></a><a id="ProximityInvite:ProximityInvite"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$$ProximityInvite.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SquadService$$ProximityInvite.html" title="Utilized in conjunction with an external queuing data structure to search for and submit requests to other players for the purposes of fill out unoccupied squad roles."><span class="name">ProximityInvite</span></a><span class="params">(<span name="char_id">char_id: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="squad_guid">squad_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result"> extends <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Utilized in conjunction with an external queuing data structure
to search for and submit requests to other players
for the purposes of fill out unoccupied squad roles.</p><div class="fullcomment"><div class="comment cmt"><p>Utilized in conjunction with an external queuing data structure
to search for and submit requests to other players
for the purposes of fill out unoccupied squad roles.</p></div><dl class="paramcmts block"><dt class="param">char_id</dt><dd class="cmt"><p>the unique character identifier of the squad leader</p></dd><dt class="param">name</dt><dd class="cmt"><p>the name of the squad leader</p></dd><dt class="param">squad_guid</dt><dd class="cmt"><p>the squad</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService.RequestRole" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RequestRoleextendsSquadService.InvitationwithProductwithSerializable"></a><a id="RequestRole:RequestRole"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$$RequestRole.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SquadService$$RequestRole.html" title="Utilized when one player attempts to join an existing squad in a specific role."><span class="name">RequestRole</span></a><span class="params">(<span name="player">player: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="squad_guid">squad_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="position">position: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result"> extends <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Utilized when one player attempts to join an existing squad in a specific role.</p><div class="fullcomment"><div class="comment cmt"><p>Utilized when one player attempts to join an existing squad in a specific role.
Accessed by the joining player from the squad detail window.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player who requested the role</p></dd><dt class="param">squad_guid</dt><dd class="cmt"><p>the squad with the role</p></dd><dt class="param">position</dt><dd class="cmt"><p>the index of the role</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService.SpontaneousInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SpontaneousInviteextendsSquadService.InvitationwithProductwithSerializable"></a><a id="SpontaneousInvite:SpontaneousInvite"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$$SpontaneousInvite.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SquadService$$SpontaneousInvite.html" title="Utilized when one player issues an invite for some other player for a squad that does not yet exist."><span class="name">SpontaneousInvite</span></a><span class="params">(<span name="player">player: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result"> extends <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Utilized when one player issues an invite for some other player for a squad that does not yet exist.</p><div class="fullcomment"><div class="comment cmt"><p>Utilized when one player issues an invite for some other player for a squad that does not yet exist.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService.VacancyInvite" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VacancyInviteextendsSquadService.InvitationwithProductwithSerializable"></a><a id="VacancyInvite:VacancyInvite"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$$VacancyInvite.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SquadService$$VacancyInvite.html" title="Utilized when one squad member issues an invite for some other player."><span class="name">VacancyInvite</span></a><span class="params">(<span name="char_id">char_id: <span name="scala.Long" class="extype">Long</span></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="squad_guid">squad_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result"> extends <a href="SquadService$$Invitation.html" name="net.psforever.services.teamwork.SquadService.Invitation" id="net.psforever.services.teamwork.SquadService.Invitation" class="extype">Invitation</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Utilized when one squad member issues an invite for some other player.</p><div class="fullcomment"><div class="comment cmt"><p>Utilized when one squad member issues an invite for some other player.
Deploying to gh-pages from @ psforever/PSF-LoginServer@430c5d8890015cc6ac669d2656774d7e42794540 🚀
2021-04-07 13:44:17 +00:00
Accessed by an existing squad member using the "Invite" menu option on another player.</p></div><dl class="paramcmts block"><dt class="param">char_id</dt><dd class="cmt"><p>the unique character identifier of the player who sent the invite</p></dd><dt class="param">name</dt><dd class="cmt"><p>the name the player who sent the invite</p></dd><dt class="param">squad_guid</dt><dd class="cmt"><p>the squad</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService.WaypointData" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="WaypointDataextendsAnyRef"></a><a id="WaypointData:WaypointData"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$$WaypointData.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="SquadService$$WaypointData.html" title="Information necessary to display a specific map marker."><span class="name">WaypointData</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Information necessary to display a specific map marker.</p></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadService$.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadService#LoadSquadDefinition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadSquadDefinition(squad:net.psforever.objects.teamwork.Squad,favorite:net.psforever.objects.loadouts.SquadLoadout):Unit"></a><a id="LoadSquadDefinition(Squad,SquadLoadout):Unit"></a> <span cla
Reference in a new issue Copy permalink