Dumpdoc: Difference between revisions
Jump to navigation
Jump to search
(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...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Dumpdoc}} | {{DISPLAYTITLE:Dumpdoc}} | ||
== | == What is it? == | ||
dumpdoc is a | 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.<br> | |||
'''/dumpdoc''' can be typed in-game.<br> | For the server, '''dumpdoc''' (no slash) can be typed in the server console | ||
The dumpdoc | |||
== 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|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) | |||
== | == Where can I find them? == | ||
====Client==== | ====Client==== | ||
A folder called '''Documentation''' is generated in GTAC | 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\''' | The directory can be accessed in Windows Explorer using: '''%localappdata%\Jack's Mini Network\Grand Theft Auto Connected\''' | ||
====Server==== | ====Server==== | ||
A folder called '''Documentation''' is generated in the root server directory, when the command is used. | A folder called '''Documentation''' is generated in the root server directory, when the command is used. | ||
Latest revision as of 21:17, 7 September 2022
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.