Create api.md

master
zmv7 2022-08-23 22:32:06 +05:00 committed by GitHub
parent dfc7fd0781
commit ea071aa346
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions

5
api.md Normal file
View File

@ -0,0 +1,5 @@
# ranks API
Currently this mod provides 3 global functions:
* `ranks.get_rank(name)` - returns two variables(strings): rank, color
* `ranks.set_rank(name, rank, color)` - used to set rank for specified player
* `ranks.del_rank(name)` - used to remove rank of specified player