mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-03-25 23:29:11 +00:00
22 lines
83 KiB
HTML
22 lines
83 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.VehicleData</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.objectcreate.VehicleData" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.objectcreate.VehicleData" 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
|
||
|
|
then calculate the new padding value for that next entry's <code>name</code> field.</p><div class="fullcomment"><div class="comment cmt"><p>Increment the distance to the next mounted player's <code>name</code> field with the length of the previous entry,
|
||
|
|
then calculate the new padding value for that next entry's <code>name</code> field.</p></div><dl class="paramcmts block"><dt class="param">base</dt><dd class="cmt"><p>the original distance to the last entry</p></dd><dt class="param">next</dt><dd class="cmt"><p>the length of the last entry, if one was parsed</p></dd><dt>returns</dt><dd class="cmt"><p>the padding value, 0-7 bits</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.VehicleData#InitialStreamLengthToSeatEntries" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitialStreamLengthToSeatEntries(hasVelocity:Boolean,format:net.psforever.packet.game.objectcreate.VehicleFormat.Type):Long"></a><a id="InitialStreamLengthToSeatEntries(Boolean,Type):Long"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/VehicleData$.html#InitialStreamLengthToSeatEntries(hasVelocity:Boolean,format:net.psforever.packet.game.objectcreate.VehicleFormat.Type):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">InitialStreamLengthToSeatEntries</span><span class="params">(<span name="hasVelocity">hasVelocity: <span name="scala.Boolean" class="extype">Boolean</span></span>, <span name="format">format: <a href="VehicleFormat$.html#Type=net.psforever.packet.game.objectcreate.VehicleFormat.Value" name="net.psforever.packet.game.objectcreate.VehicleFormat.Type" id="net.psforever.packet.game.objectcreate.VehicleFormat.Type" class="extmbr">Type</a></span>)</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span><p class="shortcomment cmt">Distance from the length field of a vehicle creation packet up until the start of the vehicle's inventory data.</p><div class="fullcomment"><div class="comment cmt"><p>Distance from the length field of a vehicle creation packet up until the start of the vehicle's inventory data.
|
||
|
|
The only field excluded belongs to the original opcode for the packet.
|
||
|
|
The parameters outline reasons why the length of the stream would be different
|
||
|
|
and are used to determine the exact difference value.<br>
|
||
|
|
Note:<br>
|
||
|
|
198 includes the <code>ObjectCreateMessage</code> packet fields, without parent data,
|
||
|
|
the <code>VehicleData</code> fields,
|
||
|
|
and the first three fields of the <code>InternalSlot</code>.</p></div><dl class="paramcmts block"><dt class="param">hasVelocity</dt><dd class="cmt"><p>the presence of a velocity field - <code>vel</code> - in the <code>PlacementData</code> object for this vehicle</p></dd><dt class="param">format</dt><dd class="cmt"><p>the <code>Codec</code> subtype for this vehicle</p></dd><dt>returns</dt><dd class="cmt"><p>the length of the bitstream</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ObjectCreateMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.VehicleData#PlayerData" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayerData(basic_appearance:Int=>net.psforever.packet.game.objectcreate.CharacterAppearanceData,character_data:(Boolean,Boolean)=>net.psforever.packet.game.objectcreate.CharacterData,drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Type,accumulative:Long):net.psforever.packet.game.objectcreate.PlayerData"></a><a id="PlayerData((Int)=>CharacterAppearanceData,(Boolean,Boolean)=>CharacterData,Type,Long):PlayerData"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/VehicleData$.html#PlayerData(basic_appearance:Int=>net.psforever.packet.game.objectcreate.CharacterAppearanceData,character_data:(Boolean,Boolean)=>net.psforever.packet.game.objectcreate.CharacterData,drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Type,accumulative:Long):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">def</span></span> <span class="symbol"><span class="name">PlayerData</span><span class="params">(<span name="basic_appearance">basic_appearance: (<span name="scala.Int" class="extype">Int</span>) => <a href="CharacterAppearanceData.html" name="net.psforever.packet.game.objectcreate.CharacterAppearanceData" id="net.psforever.packet.game.objectcreate.CharacterAppearanceData" class="extype">CharacterAppearanceData</a></span>, <span name="character_data">character_data: (<span name="scala.Boolean" class="extype">Boolean</span>, <span name="scala.Boolean" class="extype">Boolean</span>) => <a href="CharacterData.html" name="net.psforever.packet.game.objectcreate.CharacterData" id="net.psforever.packet.game.objectcreate.CharacterData" class="extype">CharacterData</a></span>, <span name="drawn_slot">drawn_slot: <a href="DrawnSlot$.html#Type=net.psforever.packet.game.objectcreate.DrawnSlot.Value" name="net.psforever.packet.game.objectcreate.DrawnSlot.Type" id="net.psforever.packet.game.objectcreate.DrawnSlot.Type" class="extmbr">Type</a></span>, <span name="accumulative">accumulative: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <a href="PlayerData.html" name="net.psforever.packet.game.objectcreate.PlayerData" id="net.psforever.packet.game.objectcreate.PlayerData" class="extype">PlayerData</a></span></span><p class="shortcomment cmt">Constructor for <code>PlayerData</code> that ignores the coordinate information and the inventory
|
||
|
|
and performs a vehicle-unique calculation of the padding value.</p><div class="fullcomment"><div class="comment cmt"><p>Constructor for <code>PlayerData</code> that ignores the coordinate information and the inventory
|
||
|
|
and performs a vehicle-unique calculation of the padding value.
|
||
|
|
It passes information between the three major divisions for the purposes of offset calculations.
|
||
|
|
This constructor should be used for players that are mounted.</p></div><dl class="paramcmts block"><dt class="param">basic_appearance</dt><dd class="cmt"><p>a curried function for the common fields regarding the the character's appearance</p></dd><dt class="param">character_data</dt><dd class="cmt"><p>a curried function for the class-specific data that explains about the character</p></dd><dt class="param">drawn_slot</dt><dd class="cmt"><p>the holster that is initially drawn</p></dd><dt class="param">accumulative</dt><dd class="cmt"><p>the input position for the stream up to which this entry;
|
||
|
|
used to calculate the padding value for the player's name in <code>CharacterAppearanceData</code></p></dd><dt>returns</dt><dd class="cmt"><p>a <code>PlayerData</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.VehicleData#PlayerData" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayerData(basic_appearance:Int=>net.psforever.packet.game.objectcreate.CharacterAppearanceData,character_data:(Boolean,Boolean)=>net.psforever.packet.game.objectcreate.CharacterData,inventory:net.psforever.packet.game.objectcreate.InventoryData,drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Type,accumulative:Long):net.psforever.packet.game.objectcreate.PlayerData"></a><a id="PlayerData((Int)=>CharacterAppearanceData,(Boolean,Boolean)=>CharacterData,InventoryData,Type,Long):PlayerData"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/VehicleData$.html#PlayerData(basic_appearance:Int=>net.psforever.packet.game.objectcreate.CharacterAppearanceData,character_data:(Boolean,Boolean)=>net.psforever.packet.game.objectcreate.CharacterData,inventory:net.psforever.packet.game.objectcreate.InventoryData,drawn_slot:net.psforever.packet.game.objectcreate.DrawnSlot.Type,accumulative:Long):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">def</span></span> <span class="symbol"><span class="name">PlayerData</span><span class="params">(<span name="basic_appearance">basic_appearance: (<span name="scala.Int" class="extype">Int</span>) => <a href="CharacterAppearanceData.html" name="net.psforever.packet.game.objectcreate.CharacterAppearanceData" id="net.psforever.packet.game.objectcreate.CharacterAppearanceData" class="extype">CharacterAppearanceData</a></span>, <span name="character_data">character_data: (<span name="scala.Boolean" class="extype">Boolean</span>, <span name="scala.Boolean" class="extype">Boolean</span>) => <a href="CharacterData.html" name="net.psforever.packet.game.objectcreate.CharacterData" id="net.psforever.packet.game.objectcreate.CharacterData" class="extype">CharacterData</a></span>, <span name="inventory">inventory: <a href="InventoryData.html" name="net.psforever.packet.game.objectcreate.InventoryData" id="net.psforever.packet.game.objectcreate.InventoryData" class="extype">InventoryData</a></span>, <span name="drawn_slot">drawn_slot: <a href="DrawnSlot$.html#Type=net.psforever.packet.game.objectcreate.DrawnSlot.Value" name="net.psforever.packet.game.objectcreate.DrawnSlot.Type" id="net.psforever.packet.game.objectcreate.DrawnSlot.Type" class="extmbr">Type</a></span>, <span name="accumulative">accumulative: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <a href="PlayerData.html" name="net.psforever.packet.game.objectcreate.PlayerData" id="net.psforever.packet.game.objectcreate.PlayerData" class="extype">PlayerData</a></span></span><p class="shortcomment cmt">Constructor that ignores the coordinate information
|
||
|
|
and performs a vehicle-unique calculation of the padding value.</p><div class="fullcomment"><div class="comment cmt"><p>Constructor that ignores the coordinate information
|
||
|
|
and performs a vehicle-unique calculation of the padding value.
|
||
|
|
It passes information between the three major divisions for the purposes of offset calculations.
|
||
|
|
This constructor should be used for players that are mounted.</p></div><dl class="paramcmts block"><dt class="param">basic_appearance</dt><dd class="cmt"><p>a curried function for the common fields regarding the the character's appearance</p></dd><dt class="param">character_data</dt><dd class="cmt"><p>a curried function for the class-specific data that explains about the character</p></dd><dt class="param">inventory</dt><dd class="cmt"><p>the player's inventory</p></dd><dt class="param">drawn_slot</dt><dd class="cmt"><p>the holster that is initially drawn</p></dd><dt class="param">accumulative</dt><dd class="cmt"><p>the input position for the stream up to which this entry;
|
||
|
|
used to calculate the padding value for the player's name in <code>CharacterAppearanceData</code></p></dd><dt>returns</dt><dd class="cmt"><p>a <code>PlayerData</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.packet.game.objectcreate.VehicleData#apply" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="apply(pos:net.psforever.packet.game.objectcreate.PlacementData,basic:net.psforever.packet.game.objectcreate.CommonFieldData,health:Int,driveState:net.psforever.types.DriveState.Value,cloak:Boolean,format:net.psforever.packet.game.objectcreate.VariantVehicleData,inventory:Option[net.psforever.packet.game.objectcreate.InventoryData]):net.psforever.packet.game.objectcreate.VehicleData"></a><a id="apply(PlacementData,CommonFieldData,Int,types.DriveState.Value,Boolean,VariantVehicleData,Option[InventoryData]):VehicleData"></a> <span class="permalink"><a href="../../../../../net/psforever/packet/game/objectcreate/VehicleData$.html#apply(pos:net.psforever.packet.game.objectcreate.PlacementData,basic:net.psforever.packet.game.objectcreate.CommonFieldData,health:Int,driveState:net.psforever.types.DriveState.Value,cloak:Boolean,format:net.psforever.packet.game.objectcreate.VariantVehicleData,inventory:Option[net.psforever.packet.game.objectcreate.InventoryData]):net.psforever.packet.game.objectcreate.VehicleData" 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">apply</span><span class="params">(<span name="pos">pos: <a href="PlacementData.html" name="net.psforever.packet.game.objectcreate.PlacementData" id="net.psforever.packet.game.objectcreate.PlacementData" class="extype">PlacementData</a></span>, <span name="basic">basic: <a href="CommonFieldData.html" name="net.psforever.packet.game.objectcreate.CommonFieldData" id="net.psforever.packet.game.objectcreate.CommonFieldData" class="extype">CommonFieldData</a></span>, <span name="health">health: <span name="scala.Int" class="extype">Int</span></span>, <span name="driveState">driveState: <a href="../../../types/DriveState$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.DriveState.Value" id="net.psforever.types.DriveState.Value" class="extmbr">types.DriveState.Value</a></span>, <span name="cloak">cloak: <span name="scala.Boolean" class="extype">Boolean</span></span>, <span name="format">format: <a href="VariantVehicleData.html" name="net.psforever.packet.game.objectcreate.VariantVehicleData" id="net.psforever.packet.game.objectcreate.VariantVehicleData" class="extype">VariantVehicleData</a></span>, <span name="inventory">inventory: <span name="scala.Option" class="extype">Option</span>[<a href="InventoryData.html" name="net.psforever.packet.game.objectcreate.InventoryData" id="net.psforever.packet.game.objectcreate.InventoryData" class="extype">InventoryData</a>]</span>)</span><span class="result">: <a href="VehicleData.html" name="net.psforever.packet.game.objectcreate.VehicleData" id="net.psforever.packet.game.objectcreate.VehicleData" class="extype">VehicleData</a></span></span><p class="shortcomment cmt">Overloaded constructor for specifically handling <code>Variant</code> vehicle format.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded constructor for specifically handling <code>Variant</code> vehicle format.</p></div><dl class="paramcmts block"><dt class="param">basic</dt><dd class="cmt"><p>a field that encompasses some data used by the vehicle, including <code>faction</code> and <code>owner</code></p></dd><dt class="param">health</dt><dd class="cmt"><p>the amount of health the vehicle has, as a percentage of a filled bar (255)</p></dd><dt class="param">driveState</dt><dd class="cmt"><p>a representation for the current mobility state</p></dd><dt class="param">cloak</dt><dd class="cmt"><p>if a vehicle (that can cloak) is cloaked</p></dd><dt class="param">inventory</dt><dd class="cmt"><p>the seats
|