awards/readme.md

56 lines
1.3 KiB
Markdown
Raw Normal View History

2013-02-22 18:53:42 +01:00
Awards
------
2014-09-26 21:35:19 +02:00
by Andrew "Rubenwardy" Ward, GPL 3.0 or later.
2013-02-22 18:53:42 +01:00
This mod adds achievements to Minetest.
Majority of awards are back ported from Calinou's
old fork in Carbone, under same license.
2013-02-22 18:53:42 +01:00
Code Reference
--------------
The API
=======
* awards.register_achievement(name,data_table)
* name
* desciption
* sound [optional]
* image [optional]
2013-02-23 13:02:02 +01:00
* trigger [optional] [table]
2014-05-02 21:09:54 +02:00
* type - "dig", "place", "death", "chat" or "join"
2013-02-23 13:02:02 +01:00
* (for dig/place type) node - the nodes name
2013-02-23 16:13:21 +01:00
* (for all types) target - how many to dig / place
2014-05-02 21:09:54 +02:00
* secret [optional] - if true, then player needs to unlock to find out what it is.
2013-02-22 21:43:40 +01:00
* awards.give_achievement(name,award)
* -- gives an award to a player
2013-02-23 13:02:02 +01:00
* awards.register_onDig(func(player,data))
2013-02-22 21:43:40 +01:00
* -- return award name or null
2013-02-23 13:02:02 +01:00
* awards.register_onPlace(func(player,data))
2013-02-22 21:43:40 +01:00
* -- return award name or null
2013-02-23 16:13:21 +01:00
* awards.register_onDeath(func(player,data))
* -- return award name or null
2014-05-02 21:09:54 +02:00
* awards.register_onChat(func(player,data))
* -- return award name or null
* awards.register_onJoin(func(player,data))
* -- return award name or null
2013-02-22 18:53:42 +01:00
Player Data
===========
A list of data referenced/hashed by the player's name.
2013-02-23 13:02:02 +01:00
* player name
* name [string]
* count [table] - dig counter
* modname [table]
* itemname [int]
* place [table] - place counter
* modname [table]
2014-05-02 21:09:54 +02:00
* itemname [int]
* deaths
* chats
* joins