diff options
Diffstat (limited to 'docs/channels.md')
| -rw-r--r-- | docs/channels.md | 65 |
1 files changed, 31 insertions, 34 deletions
diff --git a/docs/channels.md b/docs/channels.md index 4722dc5..19d9b00 100644 --- a/docs/channels.md +++ b/docs/channels.md @@ -2,43 +2,45 @@ [<-Back-to:Characters](database-characters.md) -# Table: channels +**The \`channels\` table** -Information and settings for ingame, player-based chat channels (not affecting the default system channels) +Information and settings for ingame, player-based chat channels (not affecting the default system channels). ## Structure -| Field | Type | Attributes | Key | Null | Default | Extra | Comment | -|-----------------|--------------|------------|-----|------|---------|-------|---------| -| [name][1] | VARCHAR(128) | SIGNED | PRI | NO | | | | -| [team][2] | INT | UNSIGNED | PRI | NO | | | | -| [announce][3] | TINYINT | UNSIGNED | | NO | 1 | | | -| [ownership][4] | TINYINT | UNSIGNED | | NO | 1 | | | -| [password][5] | VARCHAR(32) | SIGNED | | YES | NULL | | | -| [bannedList][6] | text | SIGNED | | YES | | | | -| [lastUsed][7] | INT | UNSIGNED | | NO | | | | - -[1]: #name -[2]: #team -[3]: #announce -[4]: #ownership -[5]: #password -[6]: #bannedlist +| Field | Type | Attributes | Key | Null | Default | Extra | Comment | +| --------------- | ------------ | ---------- | --- | ---- | ------- | -------------- | ------- | +| [channelId][1] | INT | SIGNED | PRI | NO | | AUTO_INCREMENT | | +| [name][2] | VARCHAR(128) | SIGNED | | NO | | | | +| [team][3] | INT | UNSIGNED | | NO | | | | +| [announce][4] | TINYINT | UNSIGNED | | NO | 1 | | | +| [ownership][5] | TINYINT | UNSIGNED | | NO | 1 | | | +| [password][6] | VARCHAR(32) | SIGNED | | YES | | | | +| [lastUsed][7] | INT | UNSIGNED | | NO | | | | + +[1]: #channelid +[2]: #name +[3]: #team +[4]: #announce +[5]: #ownership +[6]: #password [7]: #lastused -## Description of the fields +**Description of the fields** -### name +### channelId + +The id of channel. -**Channel name** +### name -Name of the channel +Name of the channel. ### team -**team id** Allow access to channel from specified player faction 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**) +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`). | Faction | Value | |----------|-------| @@ -47,29 +49,24 @@ For multirace channels, two (or more) separate entries must exist with the EXACT ### announce -**Channel announce (0/1)** +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)** +Channel ownership. - 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 (NOT IMPLEMENTED FOR NOW) +Channel password. -**Channel banlist** -List of banned player names, separated by spaces +Empty, or a standard string-based password (no spaces allowed). ### lastUsed -Used for automated cleaning of unused channels from database. Time is in unixtime. +Used for automated cleaning of unused channels from database. Time is in unixtime.
\ No newline at end of file |