summaryrefslogtreecommitdiff
path: root/docs/instance.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/instance.md')
-rw-r--r--docs/instance.md131
1 files changed, 121 insertions, 10 deletions
diff --git a/docs/instance.md b/docs/instance.md
index 21f1eba..bd7e124 100644
--- a/docs/instance.md
+++ b/docs/instance.md
@@ -1,10 +1,121 @@
-[Database Structure](Database-Structure) > [Character-Database](Character-Database) > [instance](instance)
-
-Column | Type | Description
---- | --- | ---
-Id | int(10) unsigned |
-Map | smallint(5) unsigned |
-Resettime | int(10) unsigned |
-Difficulty | tinyint(3) unsigned |
-CompletedEncounters | int(10) unsigned |
-Data | tinytext |
+# instance
+
+`Back-to:Characters`
+
+**The \`instance\` table**
+
+This table holds static information on all current instances that have not yet been reset.
+
+**Structure**
+
+<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><a href="#instance-id">id</a></p></td>
+<td><p>int(10)</p></td>
+<td><p>unsigned</p></td>
+<td><p>PRI</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><a href="#instance-map">map</a></p></td>
+<td><p>smallint(5)</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="even">
+<td><p><a href="#instance-resettime">resettime</a></p></td>
+<td><p>int(10)</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><a href="#instance-difficulty">difficulty</a></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="even">
+<td><p><a href="#instance-completedEncounters">completedEncounters</a></p></td>
+<td><p>int(10)</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><a href="#instance-data">data</a></p></td>
+<td><p>tinytext</p></td>
+<td><p>signed</p></td>
+<td><p> </p></td>
+<td><p>NO</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+</tr>
+</tbody>
+</table>
+
+**Description of the fields**
+
+### id
+
+The instance ID. This number is unique to every instance.
+
+### map
+
+The map ID the instance is in. See Map.dbc
+
+### resettime
+
+The time when the instance will be reset, in Unix time. This field is zero for raid and heroic instances.
+The resettime of raid and heroic instances for every specific group is stored in table instance\_reset.
+
+### difficulty
+
+The difficulty of the current instance. 0 = 10-man Normal, 1 = 25-man Normal, 2 = 10-man Heroic, 3 = 25-man Heroic.
+
+### completedEncounters
+
+`field-no-description|5`
+
+### data
+
+Specific data belonging to the individual instance.