Jump to content

SimTX API v24/Packets/TxUpdateAck

From SimTX Wiki
This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
TxUpdateAck
Packet ID 23(0x17)
Direction Server → client
Session Transmitter
Body size 1 + 6 × n bytes
Permission None
Answered by
Answers TxUpdate

TxUpdateAck reports the outcome of a TxUpdate, one result per field, in the order the fields were sent.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 23.
n u8 Number of results.
results n × { u8 fieldId, bool accepted, f32 appliedValue } One entry per field of the update.

Interpreting results[edit | edit source]

Situation accepted appliedValue
Applied true The value now in effect, after any clamping or power limit.
Value already in effect true The current value.
Refused (out of range or too soon) false The current, unchanged value.
Not a live field false The requested value, echoed.

Always update the user interface from appliedValue, not from the value that was requested. A power request of 1,500 W on an account limited to 400 W is accepted with appliedValue = 400.

SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference