diff options
Diffstat (limited to 'docs/channels.md')
| -rw-r--r-- | docs/channels.md | 164 |
1 files changed, 153 insertions, 11 deletions
diff --git a/docs/channels.md b/docs/channels.md index 4bbb919..bc003e2 100644 --- a/docs/channels.md +++ b/docs/channels.md @@ -1,11 +1,153 @@ -[Database Structure](Database-Structure) > [Character-Database](Character-Database) > [channels](channels) - -Column | Type | Description ---- | --- | --- -ChannelId | int(10) unsigned | -Name | varchar(128) | -Team | int(10) unsigned | -Announce | tinyint(3) unsigned | -Ownership | tinyint(3) unsigned | -Password | varchar(32) | -LastUsed | int(10) unsigned | +# channels + +`Back-to:Characters` + +# Table: channels + +Information and settings for ingame, player-based chat channels (not affecting the default system channels) + +## 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="#channels-m_name">name</a></p></td> +<td><p>varchar(128)</p></td> +<td><p>signed</p></td> +<td><p>PRI</p></td> +<td><p>NO</p></td> +<td><p> </p></td> +<td><p> </p></td> +<td><p> </p></td> +</tr> +<tr class="odd"> +<td><p><a href="#channels-m_team">team</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> </p></td> +<td><p> </p></td> +<td><p> </p></td> +</tr> +<tr class="even"> +<td><p><a href="#channels-m_announce">announce</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>1</p></td> +<td><p> </p></td> +<td><p> </p></td> +</tr> +<tr class="odd"> +<td><p><a href="#channels-m_ownership">ownership</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>1</p></td> +<td><p> </p></td> +<td><p> </p></td> +</tr> +<tr class="even"> +<td><p><a href="#channels-m_password">password</a></p></td> +<td><p>varchar(32)</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> +<tr class="odd"> +<td><p><a href="#channels-BannedList">bannedList</a></p></td> +<td><p>text</p></td> +<td><p>signed</p></td> +<td><p> </p></td> +<td><p>YES</p></td> +<td><p> </p></td> +<td><p> </p></td> +<td><p> </p></td> +</tr> +<tr class="even"> +<td><p><a href="#channels-last_used">lastUsed</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> </p></td> +<td><p> </p></td> +<td><p> </p></td> +</tr> +</tbody> +</table> + +## Description of the fields + +### name + +**Channel name** + +Name of the channel + +### team + +**<team id> Allow access to channel from specified player faction ID** + +For multirace channels, two (or more) separate entries must exist with the EXACT same settings for all fields apart from this (it needs a different <team id>) + +Horde -> 67 + +Alliance -> 469 + +### announce + +**Channel announce (0/1)** + +0 = Channel join/part actions will not be sent + +1 = Channel join/part actions will be sent + +### ownership + +**Channel ownership (0/1)** + +0 = No one will ever be an owner. + +1 = Ownership is the first person in the channel. + +### password + +**Channel password** + +Empty, or a standard string-based password (no spaces allowed) + +### bannedList + +**Channel banlist** +List of banned player names, separated by spaces + +### lastUsed + +Used for automated cleaning of unused channels from database. Time is in unixtime. |
