mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-03-15 18:30:40 +00:00
30 lines
67 KiB
HTML
30 lines
67 KiB
HTML
|
<!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.PlayerData</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.objectcreate.PlayerData" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.objectcreate.PlayerData" 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"><</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
|
||
|
|
In general, this packet is used to describe other players.<br>
|
||
|
|
<br>
|
||
|
|
Divisions exist to make the data more manageable.
|
||
|
|
The first division defines the player's location within the game coordinate system.
|
||
|
|
The second division defines features of the character
|
||
|
|
that are shared by both the <code>ObjectCreateDetailedMessage</code> version of a controlled player character
|
||
|
|
and the <code>ObjectCreateMessage</code> version of a player character (this).
|
||
|
|
The third field provides further information on the appearance of the player character, albeit condensed.
|
||
|
|
The fourth field involves the player's <code>Equipment</code> holsters and their inventory.
|
||
|
|
The hand that the player has exposed is last.
|
||
|
|
One of the most compact forms of a player character description is transcribed using this information.<br>
|
||
|
|
<br>
|
||
|
|
The presence or absence of position data as the first division creates a cascading effect
|
||
|
|
causing all of fields in the other two divisions to gain offset values.
|
||
|
|
These offsets exist in the form of <code>String</code> and <code>List</code> padding.</p></div><dl class="paramcmts block"><dt class="param">pos</dt><dd class="cmt"><p>the optional position of the character in the world environment</p></dd><dt class="param">basic_appearance</dt><dd class="cmt"><p>common fields regarding the the character's appearance</p></dd><dt class="param">character_data</dt><dd class="cmt"><p>the class-specific data that explains about the character</p></dd><dt class="param">inventory</dt><dd class="cmt"><p>the player's inventory;
|
||
|
|
typically, only the tools and weapons in the equipment holster slots</p></dd><dt class="param">drawn_slot</dt><dd class="cmt"><p>the holster that is initially drawn</p></dd><dt class="param">position_defined</dt><dd class="cmt"><p>used by the <code>Codec</code> to seed the state of the optional <code>pos</code> field</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/PlayerData.scala" target="_blank">PlayerData.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>CharacterData</code><br>
|
||
|
|
<code>InventoryData</code><br>
|
||
|
|
<code>DrawnSlot</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="ConstructorData.html" name="net.psforever.packet.game.objectcreate.ConstructorData" id="net.psforever.packet.game.objectcreate.ConstructorData" class="extype">ConstructorData</a>, <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.PlayerData"><span>PlayerData</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.ConstructorData"><span>ConstructorData</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.PlayerData#<init>" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="<init>(pos:Option[net.psforever.packet.game.objectcreate.PlacementData],basic_appearance:net.psforever.packet.game.objectcreate.CharacterAppearanceData,character_data:net.psforever.packet.game.objectcreate.CharacterData,inventory:Option[net.psforever.packet.game.objectcreate.InventoryData],drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Value)(position_defined:Boolean):net.psforever.packet.game.objectcreate.PlayerData"></a><a id="<init>:PlayerData"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/PlayerData.html#<init>(pos:Option[net.psforever.packet.game.objectcreate.PlacementData],basic_appearance:net.psforever.packet.game.objectcreate.CharacterAppearanceData,character_data:net.psforever.packet.game.objectcreate.CharacterData,inventory:Option[net.psforever.packet.game.objectcreate.InventoryData],drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Value)(position_defined:Boolean):net.psforever.packet.game.objectcreate.PlayerData" 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">PlayerData</span><span class="params">(<span name="pos">pos: <span name="scala.Option
|
||
|
|
typically, only the tools and weapons in the equipment holster slots</p></dd><dt class="param">drawn_slot</dt><dd class="cmt"><p>the holster that is initially drawn</p></dd><dt class="param">position_defined</dt><dd class="cmt"><p>used by the <code>Codec</code> to seed the state of the optional <code>pos</code> field</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"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/PlayerData.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/packet/game/objectcreate/PlayerData.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/packet/game/objectcreate/PlayerData.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="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/PlayerData.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.PlayerData#basic_appearance" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="basic_appearance:net.psforever.packet.game.objectcreate.CharacterAppearanceData"></a><a id="basic_appearance:CharacterAppearanceData"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/PlayerData.html#basic_appearance:net.psforever.packet.game.objectcreate.CharacterAppearanceData" title="Perm
|
||
|
|
<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.PlayerData" id="net.psforever.packet.game.objectcreate.PlayerData" class="extype">PlayerData</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="net.psforever.packet.game.objectcreate.PlayerData#character_data" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="character_data:net.psforever.packet.game.objectcreate.CharacterData"></a><a id="character_data:CharacterData"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/PlayerData.html#character_data:net.psforever.packet.game.objectcreate.CharacterData" 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">character_data</span><span class="result">: <a href="CharacterData.html" name="net.psforever.packet.game.objectcreate.CharacterData" id="net.psforever.packet.game.objectcreate.CharacterData" class="extype">CharacterData</a></span></span></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/PlayerData.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="net.psforever.packet.game.objectcreate.PlayerData#drawn_slot" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Value"></a><a id="drawn_slot:DrawnSlot.Value"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/PlayerData.html#drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Value" 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">drawn_slot</span><span class="result">: <a href="DrawnSlot$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.packet.game.objectcreate.DrawnSlot.Value" id="net.psforever.packet.game.objectcreate.DrawnSlot.Value" class="extmbr">DrawnSlot.Value</a></span></span></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/PlayerData.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></sp
|