Dumpdoc

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

What is it?

The dumpdoc system is a mechanism for dumping scripting documentation to disk, in a folder called "Documentation"

How do I use it?

For the client, /dumpdoc can be typed in-game in the chatbox.
For the server, dumpdoc (no slash) can be typed in the server console

What are these documentation files?

The dumpdoc system creates four XML files:

  • Documentation.xml contains a list of all available script types and functions
  • EventTypes.xml contains a list of all events, to be used with addEventHandler or bindEventHandler
  • Defines.xml contains a list of all static defines/constants
  • Commands.xml contains a list of all commands that were available at the time (including commands added by running scripts)

Where can I find them?

Client

A folder called Documentation is generated in GTAC client's local app data directory, when the command is used.
The directory can be accessed in Windows Explorer using: %localappdata%\Jack's Mini Network\Grand Theft Auto Connected\

Server

A folder called Documentation is generated in the root server directory, when the command is used.