summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKitzunu <24550914+Kitzunu@users.noreply.github.com>2022-04-19 23:43:29 +0200
committerGitHub <noreply@github.com>2022-04-19 23:43:29 +0200
commita81add609f7b59e98a3f0f7e5f633397c737589c (patch)
tree9244dcc4f528d1e5832767618232762e9a3ba438 /docs
parentfbfdaaa7f1be8b4d8570a2b303ccd1800ecb9023 (diff)
downloadwiki-a81add609f7b59e98a3f0f7e5f633397c737589c.tar.gz
wiki-a81add609f7b59e98a3f0f7e5f633397c737589c.tar.bz2
wiki-a81add609f7b59e98a3f0f7e5f633397c737589c.zip
feat: server mail (#703)
Diffstat (limited to 'docs')
-rw-r--r--docs/mail_server_character.md27
-rw-r--r--docs/mail_server_template.md90
2 files changed, 117 insertions, 0 deletions
diff --git a/docs/mail_server_character.md b/docs/mail_server_character.md
new file mode 100644
index 0000000..eb23311
--- /dev/null
+++ b/docs/mail_server_character.md
@@ -0,0 +1,27 @@
+# mail_server_character
+
+[<-Back-to:Character](database-character.md)
+
+**The \`mail_server_character\` table**
+
+This table keeps entries of which player has recieved a server mail. This prevents the same mail to be sent twice to the same player.
+
+**Structure**
+
+| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
+| ----------- | ---- | ---------- | --- | ---- | ------- | ----- | ------- |
+| [guid][1] | INT | UNSIGNED | PRI | NO | | | |
+| [mailId][2] | INT | UNSIGNED | PRI | NO | | | |
+
+[1]: #guid
+[2]: #mailId
+
+## Description of the fields
+
+### guid
+
+[characters.guid](characters#guid).
+
+### mailId
+
+[mail_server_template.id](mail_server_template#guid).
diff --git a/docs/mail_server_template.md b/docs/mail_server_template.md
new file mode 100644
index 0000000..76114ff
--- /dev/null
+++ b/docs/mail_server_template.md
@@ -0,0 +1,90 @@
+# mail_server_template
+
+[<-Back-to:Character](database-character.md)
+
+**The \`mail_server_template\` table**
+
+This table contains information for server mail to be sent to players that meet the requirement. Mails are sent OnLogin.
+
+**Structure**
+
+| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
+| ---------------- | ------- | ---------- | --- | ---- | ------- | -------------- | ------- |
+| [id][1] | INT | UNSIGNED | PRI | NO | | AUTO_INCREMENT | |
+| [reqLevel][2] | TINYINT | UNSIGNED | | NO | 0 | | |
+| [reqPlayTime][3] | INT | UNSIGNED | | NO | 0 | | |
+| [moneyA][4] | INT | UNSIGNED | | NO | 0 | | |
+| [moneyH][5] | INT | UNSIGNED | | NO | 0 | | |
+| [itemA][6] | INT | UNSIGNED | | NO | 0 | | |
+| [itemCountA][7] | INT | UNSIGNED | | NO | 0 | | |
+| [itemH][8] | INT | UNSIGNED | | NO | 0 | | |
+| [itemCountH][9] | INT | UNSIGNED | | NO | 0 | | |
+| [subject][10] | TEXT | | | NO | | | |
+| [body][11] | TEXT | | | NO | | | |
+| [active][12] | TINYINT | UNSIGNED | | NO | 1 | | |
+
+[1]: #id
+[2]: #reqlevel
+[3]: #reqplaytime
+[4]: #moneya
+[5]: #moneyh
+[6]: #itema
+[7]: #itemcounta
+[8]: #itemh
+[9]: #itemcounth
+[10]: #subject
+[11]: #body
+[12]: #active
+
+## Description of the fields
+
+### id
+
+Unique ID.
+
+### reqLevel
+
+Players required level to be able to recieve the mail.
+
+### reqPlayTime
+
+Players required play time in milliseconds to recieve the mail.
+
+### moneyA
+
+Money in copper that is sent to Alliance player.
+
+### moneyH
+
+Money in copper that is sent to Horde player.
+
+### itemA
+
+[item_template.entry](item_template#entry) that is sent to Alliance player.
+
+### itemCountA
+
+How many of the specified [itemA](#itema) is sent.
+
+### itemH
+
+[item_template.entry](item_template#entry).
+
+### itemCountH
+
+How many of the specified [itemH](#itemh) is sent that is sent to Horde player.
+
+### subject
+
+The title/subject of the mail.
+
+### body
+
+The body of the mail.
+
+### active
+
+boolean
+
+- 1 = Mail is active and will be sent to the players if they meet the requirement.
+- 0 = Disabled.