PSF-LoginServer/net/psforever/objects/teamwork/SquadFeatures.html

16 lines
51 KiB
HTML
Raw Normal View History

<!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.objects.teamwork.SquadFeatures</title><meta content="PSF - LoginServer - master - net.psforever.objects.teamwork.SquadFeatures" name="description"/><meta content="PSF LoginServer master net.psforever.objects.teamwork.SquadFeatures" 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.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../../net/psforever/objects/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">objects</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.objects.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/objects/teamwork/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">teamwork</span>
<br>
Despite the name, no waypoints are actually "added."
All of the waypoints constantly exist as long as the squad to which they are attached exists.</p><div class="fullcomment"><div class="comment cmt"><p>Display the indicated waypoint.<br>
<br>
Despite the name, no waypoints are actually "added."
All of the waypoints constantly exist as long as the squad to which they are attached exists.
They are merely "activated" and "deactivated."
No waypoint is ever remembered for the laze-indicated target.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the squad's unique identifier</p></dd><dt class="param">waypointType</dt><dd class="cmt"><p>the type of the waypoint</p></dd><dt class="param">info</dt><dd class="cmt"><p>information about the waypoint, as was reported by the client's packet</p></dd><dt>returns</dt><dd class="cmt"><p>the waypoint data, if the waypoint type is changed</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadWaypointRequest</code></p></span><span class="cmt"><p><code>WaypointInfo</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#AllowedPlayers" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AllowedPlayers(list:List[Long]):List[Long]"></a><a id="AllowedPlayers(List[Long]):List[Long]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#AllowedPlayers(list:List[Long]):List[Long]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">AllowedPlayers</span><span class="params">(<span name="list">list: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#AllowedPlayers" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AllowedPlayers(charId:Long):List[Long]"></a><a id="AllowedPlayers(Long):List[Long]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#AllowedPlayers(charId:Long):List[Long]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">AllowedPlayers</span><span class="params">(<span name="charId">charId: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<span name="scala.Long" class="extype">Long</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#AutoApproveInvitationRequests" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AutoApproveInvitationRequests:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#AutoApproveInvitationRequests:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">AutoApproveInvitationRequests</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#AutoApproveInvitationRequests_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AutoApproveInvitationRequests_=(autoApprove:Boolean):Boolean"></a><a id="AutoApproveInvitationRequests_=(Boolean):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#AutoApproveInvitationRequests_=(autoApprove:Boolean):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: AutoApproveInvitationRequests_$eq">AutoApproveInvitationRequests_=</span><span class="params">(<span name="autoApprove">autoApprove: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Boo
Unused waypoints are marked by having a non-zero z-coordinate.<br>
<br>
Despite the name, no waypoints are actually "removed."
All of the waypoints constantly exist as long as the squad to which they are attached exists.
They are merely "activated" and "deactivated."</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the squad's unique identifier</p></dd><dt class="param">waypointType</dt><dd class="cmt"><p>the type of the waypoint</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#SearchForRole" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SearchForRole:Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#SearchForRole:Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">SearchForRole</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#SearchForRole_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SearchForRole_=(role:Option[Int]):Option[Int]"></a><a id="SearchForRole_=(Option[Int]):Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#SearchForRole_=(role:Option[Int]):Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: SearchForRole_$eq">SearchForRole_=</span><span class="params">(<span name="role">role: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#SearchForRole_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SearchForRole_=(role:Int):Option[Int]"></a><a id="SearchForRole_=(Int):Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#SearchForRole_=(role:Int):Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: SearchForRole_$eq">SearchForRole_=</span><span class="params">(<span name="role">role: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#Squad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Squad:net.psforever.objects.teamwork.Squad"></a><a id="Squad:Squad"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#Squad:net.psforever.objects.teamwork.Squad" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">Squad</span><span class="result">: <a href="Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a></span></span></li><li class="indented0 " name="net.psforever.objects.teamwork.SquadFeatures#Start" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Start(implicitcontext:akka.actor.ActorContext,implicitsubs:net.psforever.services.teamwork.SquadSubscriptionEntity):net.psforever.objects.teamwork.SquadFeatures"></a><a id="Start(ActorContext,SquadSubscriptionEntity):SquadFeatures"></a> <span class="permalink"><a href="../../../../net/psforever/objects/teamwork/SquadFeatures.html#Start(implicitcontext:akka.actor.Acto