Dumpdoc

From GTA Connected
Revision as of 16:42, 30 June 2021 by Mex (talk | contribs) (Created page with "{{DISPLAYTITLE:Dumpdoc}} ==Summary== dumpdoc is a command for dumping scripting documentation to disk, on both the server and the client.<br> The content generated reflects wh...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Summary

dumpdoc is a command for dumping scripting documentation to disk, on both the server and the client.
The content generated reflects what is supported of the build that processes the dumpdoc command.
4 XML files are generated into a folder called Documentation, when the command is used.
For the client, the generated content will differ per game.

Command Usage

Client

/dumpdoc can be typed in-game.
The dumpdoc command will work when not connected to a server in-game, or when connected to a server in-game with client.administrator set to true for the client.
See Client Commands.
To be in-game and not connected to a server, unselect any server that may be selected in the launcher and then press Launch, or connect to a server and then type /disconnect in-game.

Server

dumpdoc can be typed in the server console.

Documentation Output

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.