SimTX API v24/Packets/CatalogUploadResult: 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 = CatalogUploadResult | | name = CatalogUploadResult | ||
| id = 21 | | id = 21 | ||
| hex = 0x15 | | hex = 0x15 | ||
| direction = s2c | | direction = s2c | ||
| session = [[SimTX API/Extension catalog protocol|Control (catalog)]] | | session = [[SimTX API v24/Extension catalog protocol|Control (catalog)]] | ||
| size = 7 + message length | | size = 7 + message length | ||
| permission = None | | permission = None | ||
| answers = [[SimTX API/Packets/CatalogUpload|CatalogUpload]] | | answers = [[SimTX API v24/Packets/CatalogUpload|CatalogUpload]] | ||
| group = catalog | | group = catalog | ||
}} | }} | ||
'''CatalogUploadResult''' reports the outcome of a [[SimTX API/Packets/CatalogUpload|CatalogUpload]]. | '''CatalogUploadResult''' reports the outcome of a [[SimTX API v24/Packets/CatalogUpload|CatalogUpload]]. | ||
== Layout == | == Layout == | ||
| Line 37: | Line 37: | ||
Show the message to the user; it says what to fix. | Show the message to the user; it says what to fix. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:14, 24 October 2026
| Packet ID | 21(0x15)
|
|---|---|
| Direction | Server → client |
| Session | Control (catalog) |
| Body size | 7 + message length |
| Permission | None |
| Answers | CatalogUpload |
CatalogUploadResult reports the outcome of a CatalogUpload.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 21.
|
ok |
bool |
True if the entry was published. |
message |
UTF |
Uploaded for a new entry, Updated for a new revision, otherwise the reason for failure.
|
entryId |
i32 |
The entry's ID on success; −1 on failure. |
Typical failure messages[edit | edit source]
- Publishing requires catalog.publish
- This server has no catalog
- Unknown catalog item kind 'X'
- A preset is exactly one .stxpreset file
- An item named 'X' already exists (by Author)
- Catalog entry quota reached (32), Catalog storage quota reached, Server catalog storage is full
- Manifest validation messages, passed through verbatim.
Show the message to the user; it says what to fix.