mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-03-15 18:30:40 +00:00
36 lines
127 KiB
HTML
36 lines
127 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.ObjectCreateMessage</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.ObjectCreateMessage" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.ObjectCreateMessage" 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">game</span></a></span><div class="fullcomme
|
||
|
|
In general, <code>ObjectCreateMessage</code> and its counterpart <code>ObjectCreateDetailedMessage</code> should look similar.<br>
|
||
|
|
<br>
|
||
|
|
<code>ObjectCreateMessage</code> is capable of creating every non-environmental object in the game through the use of encoding patterns.
|
||
|
|
The objects produced by this packet generally do not always fully express all the complexities of the object class.
|
||
|
|
With respect to a client's avatar, all of the items in his inventory are given thorough detail so that the client can account for their interaction.
|
||
|
|
The "shallow" objects produced by this packet are not like that.
|
||
|
|
They express only the essential information necessary for client interaction when the client interacts with them.
|
||
|
|
For example, a weapon defined by this packet may not care internally what fire mode it is in or how much ammunition it has.
|
||
|
|
Such a weapon is not in the client's player's holster or inventory.
|
||
|
|
It is imperceptive information to which he would not currently have access.
|
||
|
|
An <code>0x17</code> game object is, therefore, a game object with only the essential data exposed.<br>
|
||
|
|
<br>
|
||
|
|
When interacting with an <code>0x17</code> game object, the server will swap back and forth between it and an <code>0x18</code> object.
|
||
|
|
(Or it will be removed when it is placed somewhere a given client will no longer be able to see it.)
|
||
|
|
The purpose of this conversion is to control network traffic and object agency.
|
||
|
|
It is not necessary to keep track of all objects on every player on every client individually.
|
||
|
|
This relates to the goal of this packet exposing only "essential data."
|
||
|
|
One player does not need to know how much ammunition remains in a weapon belonging to another player normally.
|
||
|
|
One player also does not need to know how much ammunition is used up when another player reloads their weapon.
|
||
|
|
The only way the first player will know is when the weapon is transferred into his own inventory.
|
||
|
|
All other clients are spared micromanagement of the hypothetical other player's weapon.
|
||
|
|
Updated information is only made available when and where it is needed.<br>
|
||
|
|
<br>
|
||
|
|
Knowing the object's type is necessary for proper parsing.
|
||
|
|
If the object does not have encoding information or is unknown, it will not translate between byte data and a game object.</p></div><dl class="paramcmts block"><dt class="param">streamLength</dt><dd class="cmt"><p>the total length of the data that composes this packet in bits;
|
||
|
|
exclude the opcode (1 byte) and end padding (0-7 bits);
|
||
|
|
when encoding, it will be calculated automatically</p></dd><dt class="param">objectClass</dt><dd class="cmt"><p>the code for the type of object being constructed;
|
||
|
|
always an 11-bit LE value</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the GUID this object will be assigned</p></dd><dt class="param">parentInfo</dt><dd class="cmt"><p>if defined, the relationship between this object and another object (its parent)</p></dd><dt class="param">data</dt><dd class="cmt"><p>the data used to construct this type of object;
|
||
|
|
on decoding, set to <code>None</code> if the process failed</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/ObjectCreateMessage.scala" target="_blank">ObjectCreateMessage.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p>ObjectCreateDetailedMessage</p></span><span class="cmt"><p>ObjectCreateMessageParent</p></span></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.Product" class="extype">Product</span>, <span name="scala.Equals" class="extype">Equals</span>, <a href="../PlanetSideGamePacket.html" name="net.psforever.packet.PlanetSideGamePacket" id="net.psforever.packet.PlanetSideGamePacket" class="extype">PlanetSideGamePacket</a>, <a href="../PlanetSidePacket.html" name="net.psforever.packet.PlanetSidePacket" id="net.psforever.packet.PlanetSidePacket" class="extype">PlanetSidePacket</a>, <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.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.ObjectCreateMessage"><span>ObjectCreateMessage</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.PlanetSideGamePacket"><span>PlanetSideGamePacket</span></li><li class="in" name="net.psforever.packet.PlanetSidePacket"><span>PlanetSidePacket</span></li><li class="in" name="java.io.Serializable"><span>Serializable</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.ObjectCreateMessage#<init>" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="<init>(streamLength:Long,objectClass:Int,guid:net.psforever.types.PlanetSideGUID,parentInfo:Option[net.psforever.packet.game.objectcreate.ObjectCreateMessageParent],data:net.psforever.packet.game.objectcreate.ConstructorData):net.psforever.packet.game.ObjectCreateMessage"></a><a id="<init>:ObjectCreateMessage"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/ObjectCreateMessage.html#<init>(streamLength:Long,objectClass:Int,guid:net.psforever.types.PlanetSideGUID,parentInfo:Option[net.psforever.packet.game.objectcreate.ObjectCreateMessageParent],data:net.psforever.packet.game.objectcreate.ConstructorData):net.psforever.packet.game.ObjectCreateMessage" 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="na
|
||
|
|
exclude the opcode (1 byte) and end padding (0-7 bits);
|
||
|
|
when encoding, it will be calculated automatically</p></dd><dt class="param">objectClass</dt><dd class="cmt"><p>the code for the type of object being constructed;
|
||
|
|
always an 11-bit LE value</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the GUID this object will be assigned</p></dd><dt class="param">parentInfo</dt><dd class="cmt"><p>if defined, the relationship between this object and another object (its parent)</p></dd><dt class="param">data</dt><dd class="cmt"><p>the data used to construct this type of object;
|
||
|
|
on decoding, set to <code>None</code> if the process failed</p></dd></dl></div></li></ol></div><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="net.psforever.packet.game.ObjectCreateMessage.Packet" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Packet=net.psforever.packet.game.ObjectCreateMessage"></a><a id="Packet:Packet"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/ObjectCreateMessage.html#Packet=net.psforever.packet.game.ObjectCreateMessage" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">type</span></span> <span class="symbol"><span class="name">Packet</span><span class="result alias"> = <a href="" name="net.psforever.packet.game.ObjectCreateMessage" id="net.psforever.packet.game.ObjectCreateMessage" class="extype">ObjectCreateMessage</a></span></span></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/ObjectCreateMessage.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/ObjectCreateMessage.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/ObjectCreateMessage.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/ObjectCreateMessage.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">
|