Skip to content

Commit 3a0ca90

Browse files
NoseyNickNoseyNick
committed
Hull ID
fixes #165
1 parent bf1c987 commit 3a0ca90

File tree

1 file changed

+41
-37
lines changed

1 file changed

+41
-37
lines changed

‎index.html

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1390,7 +1390,7 @@ <h4>Packet type (int)</h4>
13901390
the various packet types. Note that many packets also have a subtype value; for those
13911391
packets, the subtype will be the first value transmitted in the payload. This value
13921392
is a JamCRC hash of the internal name of the packet type.
1393-
JamCRC is a bitwise not of a CRC32 hash.
1393+
JamCRC is a bitwise not of a CRC32 hash.
13941394
</p>
13951395
</section>
13961396
<section id="packet-structure-payload">
@@ -1706,10 +1706,12 @@ <h4>Payload</h4>
17061706
Whether the ship has warp or jump drive
17071707
</p>
17081708
</dd>
1709-
<dt>Ship type (int)</dt>
1709+
<dt>Hull ID (int)</dt>
17101710
<dd>
17111711
<p>
1712-
ID from vesselData.xml
1712+
The <code>&lt;vessel uniqueID&gt;</code> for the
1713+
ship as found in <code>vesselData.xml</code>,
1714+
referred to as the <code>hullID</code> in mission scripts.
17131715
</p>
17141716
</dd>
17151717
<dt>Accent color (float) (v2.4 or later)</dt>
@@ -1921,7 +1923,6 @@ <h4>Payload</h4>
19211923
</p>
19221924
</dd>
19231925
<dt>Unknown (int)</dt>
1924-
<dd></dd>
19251926
</dl>
19261927
</dd>
19271928
<dt>Struct type 9</dt>
@@ -2082,7 +2083,7 @@ <h4>Payload</h4>
20822083
<p>
20832084
A hash value identifying the button. This is a hash of the button's label
20842085
computed using the JamCRC hash algorithm.
2085-
JamCRC is a bitwise not of a CRC32 hash.
2086+
JamCRC is a bitwise not of a CRC32 hash.
20862087
(<a href="https://github.com/rjwut/ian/blob/master/src/main/java/com/walkertribe/ian/util/JamCrc.java" target="_blank">sample Java implementation</a>)
20872088
</p>
20882089
</dd>
@@ -2164,7 +2165,6 @@ <h4>Payload</h4>
21642165
<dt>X-coordinate (float)</dt>
21652166
<dt>Y-coordinate (float)</dt>
21662167
<dt>Z-coordinate (float)</dt>
2167-
<dd></dd>
21682168
</dl>
21692169
</section>
21702170
<section id="commsbuttonpacket">
@@ -2401,7 +2401,6 @@ <h4>Payload</h4>
24012401
</p>
24022402
</dd>
24032403
<dt>Unknown (12 bytes)</dt>
2404-
<dd></dd>
24052404
</dl>
24062405
</section>
24072406
</section>
@@ -3334,7 +3333,7 @@ <h4>Payload</h4>
33343333
<dd>
33353334
<p>
33363335
The coordinate of the selected location on the Y axis.
3337-
Always <code>0</code>.
3336+
Always <code>0</code>.
33383337
</p>
33393338
</dd>
33403339
<dt>X-coordinate (float)</dt>
@@ -3944,7 +3943,6 @@ <h4>Payload</h4>
39443943
</dd>
39453944
<dt>Unknown (int)</dt>
39463945
<dt>Unknown (int)</dt>
3947-
<dd></dd>
39483946
</dl>
39493947
</section>
39503948
</section>
@@ -4344,10 +4342,12 @@ <h4>Payload</h4>
43444342
entry is a struct as follows:
43454343
</p>
43464344
<dl>
4347-
<dt>Vessel type (int)</dt>
4345+
<dt>Hull ID (int)</dt>
43484346
<dd>
43494347
<p>
4350-
The ID of the vessel from <code>vesselData.xml</code>.
4348+
The <code>&lt;vessel uniqueID&gt;</code> for the
4349+
single-seat craft as found in <code>vesselData.xml</code>,
4350+
referred to as the <code>hullID</code> in mission scripts.
43514351
</p>
43524352
</dd>
43534353
<dt>Bay index (int)</dt>
@@ -4572,13 +4572,13 @@ <h4>Payload</h4>
45724572
<dd>
45734573
<p>
45744574
The "priority" of the smoke. The game maintains a buffer
4575-
of smoke objects; this buffer is an array of size 8, and
4576-
smoke objects are inserted into the array at the index
4577-
indicated by this value (between 0 and 7 inclusive),
4578-
overwriting any previously-existing smoke object at that
4579-
index. Smoke objects with a low index in the buffer, if
4580-
they exist, will appear to emit more smoke than objects
4581-
with a higher index.
4575+
of smoke objects; this buffer is an array of size 8, and
4576+
smoke objects are inserted into the array at the index
4577+
indicated by this value (between 0 and 7 inclusive),
4578+
overwriting any previously-existing smoke object at that
4579+
index. Smoke objects with a low index in the buffer, if
4580+
they exist, will appear to emit more smoke than objects
4581+
with a higher index.
45824582
</p>
45834583
</dd>
45844584
<dt>X-coordinate (float)</dt>
@@ -4975,10 +4975,12 @@ <h3>Base</h3>
49754975
etc.
49764976
</p>
49774977
</dd>
4978-
<dt>Vessel type (bit 1.5, int)</dt>
4978+
<dt>Hull ID (bit 1.5, int)</dt>
49794979
<dd>
49804980
<p>
4981-
The vessel type ID, as found in <code>vesselData.xml</code>.
4981+
The <code>&lt;vessel uniqueID&gt;</code> for the
4982+
base as found in <code>vesselData.xml</code>,
4983+
referred to as the <code>hullID</code> in mission scripts.
49824984
</p>
49834985
</dd>
49844986
<dt>X coordinate (bit 1.6, float)</dt>
@@ -5005,14 +5007,14 @@ <h3>Base</h3>
50055007
<dt>Unknown (bit 2.4, 4 bytes)</dt>
50065008
<dt>Unknown (bit 2.5, byte)</dt>
50075009
<dt>Side (bit 2.6, byte)</dt>
5008-
<dd>
5009-
<p>
5010+
<dd>
5011+
<p>
50105012
The side index for this base. Ships / bases which
5011-
have the same side index are friendly to one another.
5012-
There is no side 0.
5013-
The default friendly side is 2.
5014-
</p>
5015-
</dd>
5013+
have the same side index are friendly to one another.
5014+
There is no side 0.
5015+
The default friendly side is 2.
5016+
</p>
5017+
</dd>
50165018
</dl>
50175019
</section>
50185020

@@ -5143,7 +5145,6 @@ <h3>Drone</h3>
51435145
<dt>Heading (bit 1.7, float)</dt>
51445146
<dt>Side (bit 1.8, int)</dt>
51455147
<dt>Unknown (bit 2.1, float?, v2.1.5+)</dt>
5146-
<dd></dd>
51475148
</dl>
51485149
</section>
51495150

@@ -5273,7 +5274,6 @@ <h3>Generic Mesh</h3>
52735274
<dt>Unknown (bit 4.1, string?)</dt>
52745275
<dt>Unknown (bit 4.2, string?)</dt>
52755276
<dt>Unknown (bit 4.3, int, since v2.7.0)</dt>
5276-
<dd></dd>
52775277
</dl>
52785278
</section>
52795279

@@ -5363,11 +5363,12 @@ <h3>NPC Ship</h3>
53635363
not.
53645364
</p>
53655365
</dd>
5366-
<dt>Vessel type (bit 1.7, int)</dt>
5366+
<dt>Hull ID (bit 1.7, int)</dt>
53675367
<dd>
53685368
<p>
5369-
The ID corresponding to the <code>&lt;vessel&gt;</code> entry in
5370-
<code>vesselData.xml</code> that describes the vessel type for this ship.
5369+
The <code>&lt;vessel uniqueID&gt;</code> for the
5370+
ship as found in <code>vesselData.xml</code>,
5371+
referred to as the <code>hullID</code> in mission scripts.
53715372
</p>
53725373
</dd>
53735374
<dt>X coordinate (bit 1.8, float)</dt>
@@ -5520,7 +5521,7 @@ <h3>NPC Ship</h3>
55205521

55215522
<section id="object-player-ship">
55225523
<h3>Player Ship</h3>
5523-
<dl>
5524+
<dl>
55245525
<dt>Bit field (6 bytes, 5 bytes before v2.3.0)</dt>
55255526
<dt>Weapons target (bit 1.1, int)</dt>
55265527
<dd>
@@ -5559,7 +5560,9 @@ <h3>Player Ship</h3>
55595560
<dt>Hull ID (bit 2.3, int)</dt>
55605561
<dd>
55615562
<p>
5562-
The ID of the vessel entry for this ship in <code>vesselData.xml</code>.
5563+
The <code>&lt;vessel uniqueID&gt;</code> for the
5564+
ship as found in <code>vesselData.xml</code>,
5565+
referred to as the <code>hullID</code> in mission scripts.
55635566
</p>
55645567
</dd>
55655568
<dt>X coordinate (bit 2.4, float)</dt>
@@ -5794,7 +5797,7 @@ <h3>Player Ship</h3>
57945797
the configured type of creature.
57955798
</p>
57965799
</dd>
5797-
</dl>
5800+
</dl>
57985801
</section>
57995802

58005803
<section id="object-player-ship-upgrades">
@@ -6412,7 +6415,6 @@ <h3>fleet_ai</h3>
64126415
<h4>Attributes</h4>
64136416
<dl>
64146417
<dt>commonality (integer)</dt>
6415-
<dd></dd>
64166418
</dl>
64176419
</section>
64186420
<section id="vessel-data-hullRace">
@@ -6856,7 +6858,9 @@ <h4>Attributes</h4>
68566858
<dt>uniqueID (integer, 0-n)</dt>
68576859
<dd>
68586860
<p>
6859-
An ID assigned to this vessel. Player ships must start at 0 and increase sequentially;
6861+
An ID assigned to this vessel,
6862+
referred to as the <code>hullID</code> in mission scripts.
6863+
Player ships must start at 0 and increase sequentially,
68606864
others can use whatever ID they like.
68616865
</p>
68626866
</dd>

0 commit comments

Comments
 (0)