summaryrefslogtreecommitdiff
path: root/docs/channels.md
blob: ea23c67dae565876787699e25f710ea2cd76e77c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# channels

[<-Back-to:Characters](database-characters.md)

# Table: 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(10)      | unsigned   | PRI | NO   |         |       |         |
| [announce][3]   | tinyint(3)   | unsigned   |     | NO   | 1       |       |         |
| [ownership][4]  | tinyint(3)   | unsigned   |     | NO   | 1       |       |         |
| [password][5]   | varchar(32)  | signed     |     | YES  | NULL    |       |         |
| [bannedList][6] | text         | signed     |     | YES  |         |       |         |
| [lastUsed][7]   | int(10)      | unsigned   |     | NO   |         |       |         |

[1]: #name
[2]: #team
[3]: #announce
[4]: #ownership
[5]: #password
[6]: #bannedlist
[7]: #lastused

## 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**)

| Faction  | Value |
|----------|-------|
| 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 (NOT IMPLEMENTED FOR NOW)

**Channel banlist**
List of banned player names, separated by spaces

### lastUsed

Used for automated cleaning of unused channels from database. Time is in unixtime.