mirror of
https://github.com/mt-mods/mail.git
synced 2025-03-15 06:01:25 +00:00
Update player entry format in API documentation
This commit is contained in:
parent
48b632fba2
commit
6fef89ec17
1 changed files with 12 additions and 1 deletions
13
api.md
13
api.md
|
@ -1,4 +1,3 @@
|
|||
|
||||
# Mail format
|
||||
The mail format in the api hooks
|
||||
|
||||
|
@ -70,6 +69,7 @@ The recipient handler should return
|
|||
mod-storage entry for a player (indexed by playername and serialized with json):
|
||||
```lua
|
||||
{
|
||||
|
||||
contacts = {
|
||||
{
|
||||
-- name of the player (unique key in the list)
|
||||
|
@ -107,6 +107,12 @@ mod-storage entry for a player (indexed by playername and serialized with json):
|
|||
outbox = {
|
||||
-- same format as "inbox"
|
||||
},
|
||||
drafts = {
|
||||
-- same format as "inbox"
|
||||
},
|
||||
trash = {
|
||||
-- same format as "inbox"
|
||||
},
|
||||
lists = {
|
||||
{
|
||||
-- name of the maillist (unique key in the list)
|
||||
|
@ -116,5 +122,10 @@ mod-storage entry for a player (indexed by playername and serialized with json):
|
|||
-- playername list
|
||||
players = {"playername", "playername2"}
|
||||
}
|
||||
},
|
||||
settings = {
|
||||
setting1 = "value",
|
||||
setting2 = true,
|
||||
setting3 = 123
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Add table
Reference in a new issue