summaryrefslogtreecommitdiff
path: root/docs/command.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/command.md')
-rw-r--r--docs/command.md76
1 files changed, 71 insertions, 5 deletions
diff --git a/docs/command.md b/docs/command.md
index b0f3b36..f3bdf7e 100644
--- a/docs/command.md
+++ b/docs/command.md
@@ -1,7 +1,73 @@
[Database Structure](Database-Structure) > [World-Database](World-Database) > [command](command)
-Column | Type | Description
---- | --- | ---
-Name | varchar(50) |
-Security | tinyint(3) unsigned |
-Help | longtext |
+<p><strong>The `command` table</strong></p>
+
+<p>Holds help and security information for commands. This table does NOT create new commands, it only sets / overrides security and provides help.</p>
+
+</p><strong>Structure</strong></p>
+
+<table>
+<colgroup>
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+<col width="12%" />
+</colgroup>
+<tbody>
+<tr class="odd">
+<td><p><strong>Field</strong></p></td>
+<td><p><strong>Type</strong></p></td>
+<td><p><strong>Attributes</strong></p></td>
+<td><p><strong>Key</strong></p></td>
+<td><p><strong>Null</strong></p></td>
+<td><p><strong>Default</strong></p></td>
+<td><p><strong>Extra</strong></p></td>
+<td><p><strong>Comment</strong></p></td>
+</tr>
+<tr class="even">
+<td><p>name</p></td>
+<td><p>varchar(50)</p></td>
+<td><p>signed</p></td>
+<td><p>PRI</p></td>
+<td><p>NO</p></td>
+<td><p>NULL</p></td>
+<td><p></p></td>
+<td><p></p></td>
+</tr>
+<tr class="odd">
+<td><p>security</p></td>
+<td><p>tinyint(3)</p></td>
+<td><p>unsigned</p></td>
+<td><p></p></td>
+<td><p>NO</p></td>
+<td><p>0</p></td>
+<td><p></p></td>
+<td><p></p></td>
+</tr>
+<tr class="odd">
+<td><p>help</p></td>
+<td><p>longtext</p></td>
+<td><p>signed</p></td>
+<td><p></p></td>
+<td><p>YES</p></td>
+<td><p>NULL</p></td>
+<td><p></p></td>
+<td><p></p></td>
+</tr>
+</tbody>
+</table>
+
+<p><strong>Description of the fields</strong></p>
+
+<h3>name</h3>
+<p>The name of the command.</p>
+
+<h3>security</h3>
+<p>The security level required to use the command. Corresponds with account_access.gmlevel in the realm database.</p>
+
+<h3>help</h3>
+<p>The help text displayed by the .help command.</p>