Dumpdoc: Difference between revisions

← Older edit

Dumpdoc (view source)

Revision as of 21:17, 7 September 2022

135 bytes removed , 7 September 2022

no edit summary

Vortrex

Interface administrators, moderator

2,603

edits

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Dumpdoc}}
-==Summary==
+== What is it? ==
-dumpdoc is a command for dumping scripting documentation to disk, on both the server and the client.<br>
+The ''dumpdoc'' system is a mechanism for dumping scripting documentation to disk, in a folder called "Documentation"
-The content generated reflects what is supported of the build that processes the dumpdoc command.<br>
-XML files are generated into a folder called '''Documentation''', when the command is used.<br>
-For the client, the generated content will differ per game.
-==Command Usage==
+== How do I use it? ==
-====Client====
+For the client, '''/dumpdoc''' can be typed in-game in the chatbox.<br>
-'''/dumpdoc''' can be typed in-game.<br>
+For the server, '''dumpdoc''' (no slash) can be typed in the server console
-The dumpdoc command will work when not connected to a server in-game, or when connected to a server in-game with [[client.administrator|client.administrator]] set to '''true''' for the client.<br>
-See [[ClientCommands|Client Commands]].<br>
+== What are these documentation files? ==
-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.
+The dumpdoc system creates four XML files:
-====Server====
+* Documentation.xml contains a list of all available script types and functions
-'''dumpdoc''' can be typed in the server console.
+* EventTypes.xml contains a list of all events, to be used with [[addEventHandler|addEventHandler]] or [[bindEventHandler|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)
-==Documentation Output==
+== 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.<br>
+A folder called '''Documentation''' is generated in GTAC client's local app data directory, when the command is used.<br>
 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.