PSF-LoginServer/net/psforever/packet/game/objectcreate/CharacterAppearanceData.html

31 lines
64 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.CharacterAppearanceData</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.objectcreate.CharacterAppearanceData" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.objectcreate.CharacterAppearanceData" 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
<br>
This is a shared partition of the data used to represent how the player's avatar is presented.
It is utilized by both <code>0x17 ObjectCreateMessage CharacterData</code> and <code>0x18 ObjectCreateDetailedMessage DetailedCharacterData</code>.
This can be considered the data that goes into creating the player's model.<br>
<br>
Only a few changes would occur depending on which packet would deal with the data.
One example is <code>facingYawUpper</code> which, when depicting avatars, can be set to represent non-trivial turning angles.
When depicting other players, it is limited to a small range of angles in the direction of that model's forward-facing.
Another example is the outfit information: not usually represented for avatars; but, always represented for other players.<br>
<br>
One way the player's model can be changed dramatically involves being depicted as "released."
In this form, their body appears as a backpack (or pumpkin or pastry) that can be looted for the equipment carried while alive.
Companion data will describe how the player is represented while he is "dead," usually a requirement for being "released."
Without that requirement here, it is possible to depicte the player as a "living backpack."
The said equipment is also defined elsewhere.
Another dramatic change replaces the player's model with a ball of plasma that masks the player while riding zip lines.<br>
<br>
Exploration:<br>
How do I crouch?</p></div><dl class="paramcmts block"><dt class="param">ribbons</dt><dd class="cmt"><p>the four merit commendation ribbon medals</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/objectcreate/CharacterAppearanceData.scala" target="_blank">CharacterAppearanceData.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>CharacterData</code></p></span><span class="cmt"><p><code>DetailedCharacterData</code></p></span></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>, <a href="StreamBitSize.html" name="net.psforever.packet.game.objectcreate.StreamBitSize" id="net.psforever.packet.game.objectcreate.StreamBitSize" class="extype">StreamBitSize</a>, <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.objectcreate.CharacterAppearanceData"><span>CharacterAppearanceData</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="net.psforever.packet.game.objectcreate.StreamBitSize"><span>StreamBitSize</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.objectcreate.CharacterAppearanceData#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(a:net.psforever.packet.game.objectcreate.CharacterAppearanceA,b:net.psforever.packet.game.objectcreate.CharacterAppearanceB,ribbons:net.psforever.packet.game.objectcreate.RibbonBars)(name_padding:Int):net.psforever.packet.game.objectcreate.CharacterAppearanceData"></a><a id="&lt;init&gt;:CharacterAppearanceData"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/CharacterAppearanceData.html#&lt;init&gt;(a:net.psforever.packet.game.objectcreate.CharacterAppearanceA,b:net.psforever.packet.game.objectcreate.CharacterAppearanceB,ribbons:net.psforever.packet.game.objectcreate.RibbonBars)(name_padding:Int):net.psforever.packet.game.objectcreate.CharacterAppearanceData" 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">CharacterAppearanceData</span><span class="params">(<span name="a">a: <a href="
The padding will always be a number 0-7.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the pad length in bits</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.CharacterAppearanceData#a" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="a:net.psforever.packet.game.objectcreate.CharacterAppearanceA"></a><a id="a:CharacterAppearanceA"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/CharacterAppearanceData.html#a:net.psforever.packet.game.objectcreate.CharacterAppearanceA" 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">a</span><span class="result">: <a href="CharacterAppearanceA.html" name="net.psforever.packet.game.objectcreate.CharacterAppearanceA" id="net.psforever.packet.game.objectcreate.CharacterAppearanceA" class="extype">CharacterAppearanceA</a></span></span></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.CharacterAppearanceData#altModelBit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="altModelBit:Option[Int]"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/CharacterAppearanceData.html#altModelBit: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">altModelBit</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">When a player is released-dead or attached to a zipline, their basic infantry model is replaced with a different one.</p><div class="fullcomment"><div class="comment cmt"><p>When a player is released-dead or attached to a zipline, their basic infantry model is replaced with a different one.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the length of the variable field that exists when using alternate models</p></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/CharacterAppearanceData.html#asInstanceOf[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">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.CharacterAppearanceData#b" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="b:net.psforever.packet.game.objectcreate.CharacterAppearanceB"></a><a id="b:CharacterAppearanceB"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/CharacterAppearanceData.html#b:net.psforever.packet.game.objectcreate.CharacterAppearanceB" 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">b</span><span class="result">: <a href="CharacterAppearanceB.html" name="net.psforever.packet.game.objectcreate.CharacterAppearanceB" id="net.psforever.packet.game.objectcreate.CharacterAppearanceB" class="extype">CharacterAppearanceB</a></span></span></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.CharacterAppearanceData#bitsize" group="Ungrouped" fullComment="yes" data-isabs
<br>
The calculation reflects the <code>scodec Codec</code> definition rather than the explicit parameter fields.</p><div class="fullcomment"><div class="comment cmt"><p>Performs a "sizeof()" analysis of the given object.<br>
<br>
The calculation reflects the <code>scodec Codec</code> definition rather than the explicit parameter fields.
For example, a traditional <code>Int</code> is normally a 32-bit number, often rendered as a <code>32u</code> number.
When parsed with a <code>uintL(7)</code>, it's length will be considered 7 bits (<code>7u</code>).
(Note: being permanently signed, an <code>scodec</code> value of <code>32u</code> or longer must fit into a <code>Long</code> type.)</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the number of bits necessary to measure an object of this class;
defaults to <code>0L</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.packet.game.objectcreate.CharacterAppearanceData" id="net.psforever.packet.game.objectcreate.CharacterAppearanceData" class="extype">CharacterAppearanceData</a><a href="StreamBitSize.html" name="net.psforever.packet.game.objectcreate.StreamBitSize" id="net.psforever.packet.game.objectcreate.StreamBitSize" class="extype">StreamBitSize</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/CharacterAppearanceData.html#clone():Object" 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">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><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.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </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/CharacterAppearanceData.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#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/CharacterAppearanceData.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 name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_&lt;:AnyRef]"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/CharacterAppearanceData.html#getClass():Class[_]" 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">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.C