diff options
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 79 |
1 files changed, 69 insertions, 10 deletions
@@ -23,27 +23,86 @@ old fork in Carbone, under same license. * (for all types) target - how many to dig / place * See Triggers * secret [optional] - if true, then player needs to unlock to find out what it is. + * on_unlock [optional] - func(name, def) + * name is player name + * return true to cancel register_on_unlock callbacks and HUD * awards.register_trigger(name, func(awardname, def)) * Note: awards.on[name] is automatically created for triggers -* awards.give_achievement(name,award) - * -- gives an award to a player +* awards.register_on_unlock(func(name, def)) + * name is the player name + * def is the award def. + * return true to cancel HUD +* awards.give_achievement(name, award) + * gives an award to a player + * name is the player name # Included in the Mod +The API, above, allows you to register awards +and triggers (things that look for events and unlock awards, they need +to be registered in order to get details from award_def.trigger). + +However, all awards and triggers are separate from the API. +They can be found in init.lua and triggers.lua + ## Triggers +Callbacks (register a function to be run) + +### dig + + trigger = { + type = "dig", + node = "default:dirt", + target = 50 + } + +### place + + trigger = { + type = "place", + node = "default:dirt", + target = 50 + } + +### death + + trigger = { + type = "death", + target = 5 + } + +### chat + + trigger = { + type = "chat", + target = 100 + } + +### join + + trigger = { + type = "join", + target = 100 + } + +## Callbacks relating to triggers + * awards.register_on_dig(func(player, data)) - * -- return award name or null + * data is player data (see below) + * return award name or null * awards.register_on_place(func(player, data)) - * -- return award name or null + * data is player data (see below) + * return award name or null * awards.register_on_death(func(player, data)) - * -- return award name or null + * data is player data (see below) + * return award name or null * awards.register_on_chat(func(player, data)) - * -- return award name or null -* awards.register_on_join(func(player, data)) - * -- return award name or null -* awards.register_onCraft(func(player,data)) - * -- return award name or null + * data is player data (see below) + * return award name or null +* awards.register_on_join(func(player, data) + * data is player data (see below) + * return award name or null # Player Data |