summaryrefslogtreecommitdiff
path: root/docs/guild_rank.md
blob: 5b01c8768a101ab85d03b6cf433be2385f99eab4 (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
# guild\_rank

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

**The \`guild\_rank\` table**

This table holds the information on all of the ranks available in a guild along with their names and what rights a person with that rank has.

**Structure**

| Field                | Type        | Attributes | Key | Null | Default | Extra | Comment |
| -------------------- | ----------- | ---------- | --- | ---- | ------- | ----- | ------- |
| [guildid][1]         | INT         | UNSIGNED   | PRI | NO   | 0       |       |         |
| [rid][2]             | TINYINT     | UNSIGNED   | PRI | NO   |         |       |         |
| [rname][3]           | VARCHAR(20) | SIGNED     |     | NO   | "       |       |         |
| [rights][4]          | MEDIUMINT   | UNSIGNED   |     | NO   | 0       |       |         |
| [BankMoneyPerDay][5] | INT         | UNSIGNED   |     | NO   | 0       |       |         |

[1]: #guildid
[2]: #rid
[3]: #rname
[4]: #rights
[5]: #bankmoneyperday

**Description of the fields**

### guildid

The guild ID that the rank is part of. See [guild.guildid](guild#guildid).

### rid

The particular rank ID. This number must be unique to each rank in a guild.

### rname

The name of the rank that is displayed in-game.

### rights

The rights a player with this rank has in the guild. The calculation of multiple rights is a bit different in this case as the rights do not all have 2^n values. To combine ranks, you must do the OR operation (\|) on the two flags.

| Flag    | Name                        | Comments                                                                  |
| ------- | --------------------------- | ------------------------------------------------------------------------- |
| 64      | GR_RIGHT_EMPTY              | Having just this flag by itself is equivalent to having no rights at all. |
| 65      | GR_RIGHT_GCHATLISTEN        | Player can read messages in the guild general chat channel.               |
| 66      | GR_RIGHT_GCHATSPEAK         | Player can type messages in the guild general chat channel.               |
| 68      | GR_RIGHT_OFFCHATLISTEN      | Player can read messages in the guild officers channel.                   |
| 72      | GR_RIGHT_OFFCHATSPEAK       | Player can type messages in the guild officers channel.                   |
| 80      | GR_RIGHT_INVITE             | Can invite other players to guild.                                        |
| 96      | GR_RIGHT_REMOVE             | Can kick other players out of guild.                                      |
| 192     | GR_RIGHT_PROMOTE            | Can promote other players.                                                |
| 320     | GR_RIGHT_DEMOTE             | Can demote other players.                                                 |
| 4160    | GR_RIGHT_SETMOTD            | Can change the guild message of the day.                                  |
| 8256    | GR_RIGHT_EPNOTE             | Can edit other players' personal notes.                                   |
| 16448   | GR_RIGHT_VIEWOFFNOTE        | Can view the officer notes of other players.                              |
| 32832   | GR_RIGHT_EOFFNOTE           | Can edit officer notes of other players.                                  |
| 65600   | GR_RIGHT_MODIFY_GUILD_INFO  | Can edit guild info.                                                      |
| 131072  | GR_RIGHT_WITHDRAW_GOLD_LOCK | Can remove money withdraw capacity.                                       |
| 262144  | GR_RIGHT_WITHDRAW_REPAIR    | Can withdraw for repair.                                                  |
| 524288  | GR_RIGHT_WITHDRAW_GOLD      | Can withdraw gold.                                                        |
| 1048576 | GR_RIGHT_CREATE_GUILD_EVENT | Can create a guild event.                                                 |
| 1962495 | GR_RIGHT_ALL                | Has all of the rights.                                                    |

### BankMoneyPerDay

The total money per day, in copper, that a person with this rank can take out. Use the maximum value of an UNSIGNED INT (4294967295) to specify unlimited amount.