awards/readme.md

42 lines
866 B
Markdown
Raw Normal View History

2013-02-22 18:53:42 +01:00
Awards
------
by Andrew "Rubenwardy" Ward, CC-BY-SA.
This mod adds achievements to Minetest.
Code Reference
--------------
The API
=======
* awards.register_achievement(name,data_table)
* name
* desciption
* sound [optional]
* image [optional]
* func [optional] - see below
2013-02-22 21:43:40 +01:00
* awards.give_achievement(name,award)
* -- gives an award to a player
2013-02-22 20:19:37 +01:00
* awards.register_onDig(func)
2013-02-22 21:43:40 +01:00
* -- return award name or null
* -- there will be built in versions of this function
* awards.register_onPlace(func)
* -- return award name or null
2013-02-22 20:19:37 +01:00
* -- there will be built in versions of this function
2013-02-22 18:53:42 +01:00
Player Data
===========
A list of data referenced/hashed by the player's name.
* name [string]
* getNodeCount('node_name') [function]
2013-02-22 21:43:40 +01:00
* count [table] - dig counter
* modname [table]
* itemname [int]
* place [table] - place counter
2013-02-22 18:53:42 +01:00
* modname [table]
2013-02-22 21:43:40 +01:00
* itemname [int]