PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-07-16 00:44:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/packet/game/SquadPositionDetail.html

14 lines
147 KiB
HTML
Raw Permalink 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.packet.game.SquadPositionDetail</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.SquadPositionDetail" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.SquadPositionDetail" 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 */
Deploying to gh-pages from @ psforever/PSF-LoginServer@006dd201ba2d622e1de43dfc633f3a55f2a6b8b3 🚀
2023-05-30 17:07:06 +00:00
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_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></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" class="anchorToMember"></a><a id="net:net" class="anchorToMember"></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" class="anchorToMember"></a><a id="psforever:psforever" class="anchorToMember"></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.packet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="packet" class="anchorToMember"></a><a id="packet:packet" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/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">packet</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.packet.game" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="game" class="anchorToMember"></a><a id="game:game" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/index.html" title="Permalink"><i class="material-icons"><EFBFBD><EFBFBD>
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
When parsed in an itemized way, only the important fields are represented.
When parsed in a continuous manner, all of the fields are populated.
All fields are optional for that reason.</p></div><dl class="paramcmts block"><dt class="param">is_closed</dt><dd class="cmt"><p>availability, whether the position can be occupied by a player;
an unavailable position is referenced as "Closed" and no other position detail is displayed;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
an available unoccupied position is "Available"</p></dd><dt class="param">role</dt><dd class="cmt"><p>the title of the position</p></dd><dt class="param">detailed_orders</dt><dd class="cmt"><p>the suggested responsibilities of the position</p></dd><dt class="param">requirements</dt><dd class="cmt"><p>the actual responsibilities of the position</p></dd><dt class="param">char_id</dt><dd class="cmt"><p>the unique character identification number for the player that is occupying this position</p></dd><dt class="param">name</dt><dd class="cmt"><p>the name of the player who is occupying this position</p></dd></dl><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/packet/game/SquadDetailDefinitionUpdateMessage.scala" target="_blank">SquadDetailDefinitionUpdateMessage.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a>, <span name="scala.Product" class="extype">Product</span>, <span name="scala.Equals" class="extype">Equals</span>, <span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.packet.game.SquadPositionDetail"><span>SquadPositionDetail</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(is_closed:Option[Boolean],role:Option[String],detailed_orders:Option[String],requirements:Option[Set[net.psforever.objects.avatar.Certification]],char_id:Option[Long],name:Option[String]):net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="&lt;init&gt;:SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#&lt;init&gt;(is_closed:Option[Boolean],role:Option[String],detailed_orders:Option[String],requirements:Option[Set[net.psforever.objects.avatar.Certification]],char_id:Option[Long],name:Option[String]):net.psforever.packet.game.SquadPositionDetail" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">SquadPositionDetail</span><span class="params">(<span name="is_closed">is_closed: <span name="scala.Option" cl
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
an unavailable position is referenced as "Closed" and no other position detail is displayed;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
an available unoccupied position is "Available"</p></dd><dt class="param">role</dt><dd class="cmt"><p>the title of the position</p></dd><dt class="param">detailed_orders</dt><dd class="cmt"><p>the suggested responsibilities of the position</p></dd><dt class="param">requirements</dt><dd class="cmt"><p>the actual responsibilities of the position</p></dd><dt class="param">char_id</dt><dd class="cmt"><p>the unique character identification number for the player that is occupying this position</p></dd><dt class="param">name</dt><dd class="cmt"><p>the name of the player who is occupying this position</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.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" class="anchorToMember"></a><a id="==(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.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.packet.game.SquadPositionDetail#And" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="And(info:net.psforever.packet.game.SquadPositionDetail):net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="And(SquadPositionDetail):SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#And(info:net.psforever.packet.game.SquadPositionDetail):net.psforever.packet.game.SquadPositionDetail" 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">And</span><span class="params">(<span name="info">info: <a href="" name="net.psforever.packet.game.SquadPositionDetail" id="net.psf
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Most fields that are not empty are assigned.
Even if the current object reports the squad position being open - <code>is_closed = Some(false)</code> -
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
just one instance of the squad position being closed overwrites all future updates.</p></div><dl class="paramcmts block"><dt class="param">info</dt><dd class="cmt"><p>the object being combined</p></dd><dt>returns</dt><dd class="cmt"><p>the combined <code>SquadDetail</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#CharId" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="CharId(char_id:Long):net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="CharId(Long):SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#CharId(char_id:Long):net.psforever.packet.game.SquadPositionDetail" 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">CharId</span><span class="params">(<span name="char_id">char_id: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <a href="" name="net.psforever.packet.game.SquadPositionDetail" id="net.psforever.packet.game.SquadPositionDetail" class="extype">SquadPositionDetail</a></span></span></li><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#Close" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Close:net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="Close:SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#Close:net.psforever.packet.game.SquadPositionDetail" 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">Close</span><span class="result">: <a href="" name="net.psforever.packet.game.SquadPositionDetail" id="net.psforever.packet.game.SquadPositionDetail" class="extype">SquadPositionDetail</a></span></span></li><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#Complete" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Complete:net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="Complete:SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#Complete:net.psforever.packet.game.SquadPositionDetail" 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">Complete</span><span class="result">: <a href="" name="net.psforever.packet.game.SquadPositionDetail" id="net.psforever.packet.game.SquadPositionDetail" class="extype">SquadPositionDetail</a></span></span><p class="shortcomment cmt">Complete the object by providing placeholder values for all fields.</p><div class="fullcomment"><div class="comment cmt"><p>Complete the object by providing placeholder values for all fields.
</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a <code>SquadPositionDetail</code> object with all of its field populated</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#DetailedOrders" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="DetailedOrders(orders:String):net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="DetailedOrders(String):SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#DetailedOrders(orders:String):net.psforever.packet.game.SquadPositionDetail" 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">DetailedOrders</span><span class="params">(<span name="orders">orders: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="" name="net.psforever.packet.game.SquadPositionDetail" id="net.psforever.packet.game.SquadPositionDetail" class="extype">SquadPositionDetail</a></span></span></li><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#Name" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Name(name:String):net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="Name(String):SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#Name(name:String):net.psforever.packet.game.SquadPositionDetail" 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">Name</span><span class="params">(<span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <a href="" name="net.psforever.packet.game.SquadPositionDetail" id="net.psforever.packet.game.SquadPositionDetail" class="extype">SquadPositionDetail</a></span></span></li><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#Open" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Open:net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="Open:SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#Open:net.psforever.packet.game.SquadPositionDetail" 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">Open</span><span class="result">: <a href="" name="net.psforever.packet.game.SquadPositionDetail" id="net.psforever.packet.game.SquadPositionDetail" class="extype">SquadPositionDetail</a></span></span></li><li class="indented0 " name="net.psforever.packet.game.SquadPositionDetail#Player" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Player(char_id:Long,name:String):net.psforever.packet.game.SquadPositionDetail" class="anchorToMember"></a><a id="Player(Long,String):SquadPositionDetail" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/SquadPositionDetail.html#Player(char_id:Long,name:String):net.psforever.packet.game.SquadPositionDetail" 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">Player</span><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><span class="result">: <a href="" name="net.psforever.packet.game.SquadPosi
Reference in a new issue Copy permalink