SimTX API/Packets/CatalogEntry
| Frame | ServerFrame, field 37
|
|---|---|
| Member | catalog_entry
|
| Direction | Server → client |
| Session | Control (catalog) |
| Roles | ROLE_CONTROL.
|
| Permission | None |
| Answers | CatalogFetch |
| Defined in | control.proto
|
CatalogEntry returns the files of one catalog entry requested with CatalogFetch. An unknown entry is answered with Error instead.
Definition[edit | edit source]
message CatalogEntry {
reserved 3;
int64 request_id = 1;
int32 entry_id = 2;
string kind = 4;
string name = 5;
int32 revision = 6;
repeated CatalogFile files = 7;
}
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | request_id |
int64 |
The request this answers. |
| 2 | entry_id |
int32 |
The entry ID. |
| 4 | kind |
string |
extension or preset.
|
| 5 | name |
string |
Entry name. |
| 6 | revision |
int32 |
Revision number. |
| 7 | files |
repeated CatalogFile |
The entry's files, at most 1,000. |
Field number 3 is reserved; do not use it.
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.