SimTX API v24/Packets/CatalogEntry: Difference between revisions
SimTX API documentation |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{SimTX API navigation}} | {{SimTX API v24 navigation}} | ||
{{SimTX packet | {{SimTX packet v24 | ||
| name = CatalogEntry | | name = CatalogEntry | ||
| id = 25 | | id = 25 | ||
| hex = 0x19 | | hex = 0x19 | ||
| direction = s2c | | direction = s2c | ||
| session = [[SimTX API/Extension catalog protocol|Control (catalog)]] | | session = [[SimTX API v24/Extension catalog protocol|Control (catalog)]] | ||
| size = Variable | | size = Variable | ||
| permission = None | | permission = None | ||
| answers = [[SimTX API/Packets/CatalogFetch|CatalogFetch]] | | answers = [[SimTX API v24/Packets/CatalogFetch|CatalogFetch]] | ||
| group = catalog | | group = catalog | ||
}} | }} | ||
'''CatalogEntry''' returns the files of one [[SimTX API/Extension catalog protocol|catalog]] entry requested with [[SimTX API/Packets/CatalogFetch|CatalogFetch]]. | '''CatalogEntry''' returns the files of one [[SimTX API v24/Extension catalog protocol|catalog]] entry requested with [[SimTX API v24/Packets/CatalogFetch|CatalogFetch]]. | ||
== Layout == | == Layout == | ||
| Line 39: | Line 39: | ||
* File contents are text. Each is at most 60,000 bytes of UTF-8, which fits the <code>UTF</code> encoding. | * File contents are text. Each is at most 60,000 bytes of UTF-8, which fits the <code>UTF</code> encoding. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:13, 24 October 2026
| Packet ID | 25(0x19)
|
|---|---|
| Direction | Server → client |
| Session | Control (catalog) |
| Body size | Variable |
| Permission | None |
| Answers | CatalogFetch |
CatalogEntry returns the files of one catalog entry requested with CatalogFetch.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 25.
|
entryId |
i32 |
The requested ID. |
found |
bool |
False if no entry has that ID. The remaining fields are then empty. |
kind |
UTF |
extension or preset; empty if not found.
|
name |
UTF |
Entry name; empty if not found. |
revision |
i32 |
Revision number; 0 if not found. |
fileCount |
i32 |
Number of files, at most 1,000. |
files |
fileCount × { UTF path, UTF content } |
Relative path and full text of each file. |
Usage[edit | edit source]
- For an extension, the files form a package as described in Lua extension manifest. Install it by writing each file to its path below an extension directory.
- For a preset, there is exactly one
.stxpresetfile. - File contents are text. Each is at most 60,000 bytes of UTF-8, which fits the
UTFencoding.