Template:SimTX packet: Difference between revisions
SimTX API documentation |
Protocol v25 reference |
||
| Line 2: | Line 2: | ||
|+ style="font-size:115%;" | {{{name|{{SUBPAGENAME}}}}} | |+ style="font-size:115%;" | {{{name|{{SUBPAGENAME}}}}} | ||
|- | |- | ||
! style="text-align:left; width:7.5em;" | | ! style="text-align:left; width:7.5em;" | Frame | ||
| <code>{{{ | | <code>{{{frame}}}</code>, field {{{field}}} | ||
|- | |||
! style="text-align:left;" | Member | |||
| <code>{{{member}}}</code> | |||
|- | |- | ||
! style="text-align:left;" | Direction | ! style="text-align:left;" | Direction | ||
| Line 11: | Line 14: | ||
| {{{session}}} | | {{{session}}} | ||
|- | |- | ||
! style="text-align:left;" | | ! style="text-align:left;" | Roles | ||
| {{{ | | {{{roles|}}} | ||
|- | |- | ||
! style="text-align:left;" | Permission | ! style="text-align:left;" | Permission | ||
| Line 22: | Line 25: | ||
! style="text-align:left;" | Answers | ! style="text-align:left;" | Answers | ||
| {{{answers|}}} | | {{{answers|}}} | ||
|- | |||
! style="text-align:left;" | Defined in | |||
| <code>{{{file|}}}</code> | |||
|}<includeonly>[[Category:SimTX API packets]]{{#if:{{{group|}}}|[[Category:SimTX API {{{group}}} packets]]}}{{#switch:{{{direction}}}|c2s=[[Category:SimTX API client-to-server packets]]|s2c=[[Category:SimTX API server-to-client packets]]}}</includeonly><noinclude> | |}<includeonly>[[Category:SimTX API packets]]{{#if:{{{group|}}}|[[Category:SimTX API {{{group}}} packets]]}}{{#switch:{{{direction}}}|c2s=[[Category:SimTX API client-to-server packets]]|s2c=[[Category:SimTX API server-to-client packets]]}}</includeonly><noinclude> | ||
Infobox for | Infobox for one message of the [[SimTX API]] game protocol, version 25. Every <code>ClientFrame</code> and <code>ServerFrame</code> member has a page at <code>SimTX API/Packets/''MessageName''</code> that uses it. | ||
<syntaxhighlight lang="text"> | <syntaxhighlight lang="text"> | ||
{{SimTX packet | {{SimTX packet | ||
| name = | | name = ReceiverStart | ||
| | | frame = ClientFrame (ClientFrame or ServerFrame) | ||
| | | field = 10 (number of the oneof member) | ||
| direction = c2s | | member = receiver_start (name of the oneof member) | ||
| session = Receiver | | direction = c2s (c2s or s2c) | ||
| | | session = [[SimTX API/Receiver session|Receiver]] | ||
| roles = <code>ROLE_RECEIVER</code> | |||
| permission = None | | permission = None | ||
| reply = [[SimTX API/Packets/ | | reply = [[SimTX API/Packets/SessionStatus|SessionStatus]] | ||
| answers = (for responses: the request this | | answers = (for responses: the request this message answers) | ||
| group = receiver | | group = receiver (connection, session, receiver, transmitter, control, catalog, moderation) | ||
| file = session.proto | |||
}} | }} | ||
</syntaxhighlight> | </syntaxhighlight> | ||
The template adds the page to [[:Category:SimTX API packets]], to the category for its direction, and to <code>Category:SimTX API ''group'' packets</code>. | The template adds the page to [[:Category:SimTX API packets]], to the category for its direction, and to <code>Category:SimTX API ''group'' packets</code>. The archived v24 packet pages use [[Template:SimTX packet v24]]. | ||
[[Category:SimTX API templates]] | [[Category:SimTX API templates]] | ||
</noinclude> | </noinclude> | ||
Latest revision as of 16:30, 24 October 2026
| Frame | {{{frame}}}, field {{{field}}}
|
|---|---|
| Member | {{{member}}}
|
| Direction | {{{direction}}} |
| Session | {{{session}}} |
| Roles | |
| Permission | None |
| Defined in | |
Infobox for one message of the SimTX API game protocol, version 25. Every ClientFrame and ServerFrame member has a page at SimTX API/Packets/MessageName that uses it.
{{SimTX packet
| name = ReceiverStart
| frame = ClientFrame (ClientFrame or ServerFrame)
| field = 10 (number of the oneof member)
| member = receiver_start (name of the oneof member)
| direction = c2s (c2s or s2c)
| session = [[SimTX API/Receiver session|Receiver]]
| roles = <code>ROLE_RECEIVER</code>
| permission = None
| reply = [[SimTX API/Packets/SessionStatus|SessionStatus]]
| answers = (for responses: the request this message answers)
| group = receiver (connection, session, receiver, transmitter, control, catalog, moderation)
| file = session.proto
}}
The template adds the page to Category:SimTX API packets, to the category for its direction, and to Category:SimTX API group packets. The archived v24 packet pages use Template:SimTX packet v24.