summaryrefslogtreecommitdiff
path: root/docs/autobroadcast.md
diff options
context:
space:
mode:
authorFrancescoBorzi <borzifrancesco@gmail.com>2019-02-25 19:24:20 +0100
committerFrancescoBorzi <borzifrancesco@gmail.com>2019-02-25 19:24:20 +0100
commita35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3 (patch)
tree91e0cde00f6f27b730b0df3f4338fcf99fa8447a /docs/autobroadcast.md
parentd8d1823802ded97300fa57405d80b16736603489 (diff)
downloadwiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.tar.gz
wiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.tar.bz2
wiki-a35d4f08a3f9f086eae94dccbfda2ff0c8eb5ae3.zip
Import DB wiki from TC 335
Diffstat (limited to 'docs/autobroadcast.md')
-rw-r--r--docs/autobroadcast.md100
1 files changed, 92 insertions, 8 deletions
diff --git a/docs/autobroadcast.md b/docs/autobroadcast.md
index 5fd949a..7a4c0e6 100644
--- a/docs/autobroadcast.md
+++ b/docs/autobroadcast.md
@@ -1,8 +1,92 @@
-[Database Structure](Database-Structure) > [Auth-Database](Auth-Database) > [autobroadcast](autobroadcast)
-
-Column | Type | Description
---- | --- | ---
-Realmid | int(11) |
-Id | tinyint(3) unsigned |
-Weight | tinyint(3) unsigned |
-Text | longtext |
+# autobroadcast
+
+`Back-to:Auth`
+
+**The \`autobroadcast\` table**
+
+This table contains the autobroadcast entries for your realms. Values like it's activity, position and Timer (\*.On, \*.Center, \*.Timer) are defined within the [worldserver.conf](worldserver.conf). They are chosen randomly, based on their weight.
+
+**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><a href="#autobroadcast-realmid">realmid</a></td>
+<td>int(11)</td>
+<td>signed</td>
+<td>PRI</td>
+<td>NO</td>
+<td>-1</td>
+<td> </td>
+<td> </td>
+</tr>
+<tr class="odd">
+<td><p><a href="#autobroadcast-id">id</a></p></td>
+<td><p>tinyint(3)</p></td>
+<td><p>unsigned</p></td>
+<td><p>PRI</p></td>
+<td><p>NO</p></td>
+<td><p> </p></td>
+<td><p>auto_increment</p></td>
+<td><p> </p></td>
+</tr>
+<tr class="even">
+<td><a href="#autobroadcast-weight">weight</a></td>
+<td>tinyint(3)</td>
+<td>unsigned</td>
+<td> </td>
+<td>YES</td>
+<td>1</td>
+<td> </td>
+<td> </td>
+</tr>
+<tr class="odd">
+<td><p><a href="#autobroadcast-text">text</a></p></td>
+<td><p>longtext</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+<td><p>NO</p></td>
+<td><p>NULL</p></td>
+<td><p> </p></td>
+<td><p> </p></td>
+</tr>
+</tbody>
+</table>
+
+**Description of the fields**
+
+### realmid
+
+The [\`realmlist\`.\`id\`](realmlist). Defines which realm this entry belongs to. Use **-1** for all realms to load this entry.
+
+### id
+
+Unique identifier key per realm. Entries with same id will override each other without warnings - this can be used to replace -1 realmid entry on a specific realm.
+
+### weight
+
+A non-negative integer. Entries with higher weight have more chance to get picked.
+
+### text
+
+The text to broadcast. Color and item/spell/quest link formating codes can be used.