PSF-LoginServer/net/psforever/packet/game/objectcreate/DetailedCharacterData$.html

12 lines
76 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.packet.game.objectcreate.DetailedCharacterData</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.objectcreate.DetailedCharacterData" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.objectcreate.DetailedCharacterData" 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.packet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="packet"></a><a id="packet:packet"></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"></a><a id="game:game"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/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
If a condition is met, the current <code>Optional</code> value is incremented by a specific amount.</p></div><dl class="paramcmts block"><dt class="param">start</dt><dd class="cmt"><p>the original amount</p></dd><dt class="param">test</dt><dd class="cmt"><p>the test on whether to add to <code>start</code></p></dd><dt class="param">value</dt><dd class="cmt"><p>how much to add to <code>start</code></p></dd><dt>returns</dt><dd class="cmt"><p>the amount after testing</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.Marshallable#encode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="encode(a:T):scodec.Attempt[scodec.bits.BitVector]"></a><a id="encode(DetailedCharacterData):Attempt[BitVector]"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#encode(a:T):scodec.Attempt[scodec.bits.BitVector]" 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">encode</span><span class="params">(<span name="a">a: <a href="DetailedCharacterData.html" name="net.psforever.packet.game.objectcreate.DetailedCharacterData" id="net.psforever.packet.game.objectcreate.DetailedCharacterData" class="extype">DetailedCharacterData</a></span>)</span><span class="result">: <span name="scodec.Attempt" class="extype">Attempt</span>[<span name="scodec.bits.BitVector" class="extype">BitVector</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../Marshallable.html" name="net.psforever.packet.Marshallable" id="net.psforever.packet.Marshallable" class="extype">Marshallable</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#equals(x$1:Object):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#finalize():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">finalize</span><span class="params">()</span><span class="result">: <span nam
for whichever of the groups of <code>List</code> objects of <code>String</code> objects are found in a <code>DetailedCharacterData</code> object.</p><div class="fullcomment"><div class="comment cmt"><p>A curried function to calculate a cumulative padding value
for whichever of the groups of <code>List</code> objects of <code>String</code> objects are found in a <code>DetailedCharacterData</code> object.
The specific <code>String</code> object being considered is determined by the number of input lists.</p></div><dl class="paramcmts block"><dt class="param">base</dt><dd class="cmt"><p>the starting value with no implant entries, or bits from context</p></dd><dt class="param">contextOffset</dt><dd class="cmt"><p>an inherited modification of the <code>base</code> padding value</p></dd><dt class="param">implants</dt><dd class="cmt"><p>the list of implants in the stream</p></dd><dt class="param">prevLists</dt><dd class="cmt"><p>all of the important previous lists</p></dd><dt class="param">currListLen</dt><dd class="cmt"><p>the length of the current list</p></dd><dt>returns</dt><dd class="cmt"><p>the padding value for the target list;
a value clamped between 0 and 7</p></dd></dl><dl class="attributes block"><dt>Exceptions thrown</dt><dd><span class="cmt"><p><span name="Exception" class="extype"><code>Exception</code></span> if the number of input lists (<code>prevLists</code>) exceeds the number of expected bit distances between known lists</p></span></dd><dt>See also</dt><dd><span class="cmt"><p><code>paddingCalculations(Option[Int], List[ImplantEntry], List[List[Any/]/])(Long)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.DetailedCharacterData#paddingCalculations" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="paddingCalculations(contextOffset:Option[Int],implants:List[net.psforever.packet.game.objectcreate.ImplantEntry],prevLists:List[List[Any]])(currListLen:Long):Int"></a><a id="paddingCalculations(Option[Int],List[ImplantEntry],List[List[Any]])(Long):Int"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#paddingCalculations(contextOffset:Option[Int],implants:List[net.psforever.packet.game.objectcreate.ImplantEntry],prevLists:List[List[Any]])(currListLen:Long):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">paddingCalculations</span><span class="params">(<span name="contextOffset">contextOffset: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span>, <span name="implants">implants: <span name="scala.List" class="extype">List</span>[<a href="ImplantEntry.html" name="net.psforever.packet.game.objectcreate.ImplantEntry" id="net.psforever.packet.game.objectcreate.ImplantEntry" class="extype">ImplantEntry</a>]</span>, <span name="prevLists">prevLists: <span name="scala.List" class="extype">List</span>[<span name="scala.List" class="extype">List</span>[<span name="scala.Any" class="extype">Any</span>]]</span>)</span><span class="params">(<span name="currListLen">currListLen: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">A curried function to calculate a cumulative padding value
for whichever of the groups of <code>List</code> objects of <code>String</code> objects are found in a <code>DetailedCharacterData</code> object.</p><div class="fullcomment"><div class="comment cmt"><p>A curried function to calculate a cumulative padding value
for whichever of the groups of <code>List</code> objects of <code>String</code> objects are found in a <code>DetailedCharacterData</code> object.
Defines the expected base value - the starting value for determining the padding.
The specific <code>String</code> object being considered is determined by the number of input lists.</p></div><dl class="paramcmts block"><dt class="param">contextOffset</dt><dd class="cmt"><p>an inherited modification of the <code>base</code> padding value</p></dd><dt class="param">implants</dt><dd class="cmt"><p>the list of implants in the stream</p></dd><dt class="param">prevLists</dt><dd class="cmt"><p>all of the important previous lists</p></dd><dt class="param">currListLen</dt><dd class="cmt"><p>the length of the current list</p></dd><dt>returns</dt><dd class="cmt"><p>the padding value for the target list</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>paddingCalculations(Int, Option[Int], List[ImplantEntry], List[List[Any]])(Long)</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#synchronized[T0](x$1:=&gt;T0):T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: =&gt; <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#toString():String" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#wait():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/DetailedCharacterData$.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait