Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Structured command reply

Overview

All commands are capable of returning replies in two differnt forms: A regular reply or a structured reply. A structured reply is basically like the regular reply but with three differences:

  • Structured reply string type DebugIOInterface::StructuredCmdReply
  • There is a 1:1 mapping between command and result i.e. no matter how long a command result is there will always be only one call to the DebugIOInterface::Write method for that result.
  • The result format is fixed for any given command i.e. it must not change.

A structured reply is given if the command is invoked with a '!' as first character.

The motivation behind having structured command replies is to make it possible to hide some of the debug command complexity behind a UI.

List of structured command replies for debug command group

The reply for a structured command always consists of first repeating the given command, a CR and then additional optional reply data.

Command

Reply

612