LuaLibraryAchievements.lua
changeset 1485 5ae6c7595054
parent 1484 278848d942ba
child 1486 4984ebed9535
--- a/LuaLibraryAchievements.lua	Tue Jul 17 18:54:54 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,21 +0,0 @@
-#summary Lua library documentation of Achievements; contains assorted helper functions
-#labels !LuaLibrary
-= Lua library: `Achievements` =
-WARNING: The achievements system is still very bare bones. It might be subject to major changes in future. This library should only be used internally by Hedgewars at this point.
-
-This is simple library for awarding an achievement to the player, to be used in missions. They are not meant for multiplayer.
-
-An achievement in Hedgewars is a simple award given for doing something awesome or difficult in a mission, or winning a mission in a great way.
-Achievements are a hidden feature in Hedgewars so far and far from complete.
-One example achievement is “Lively Lifeguard” in the mission “That Sinking Feeling” for rescuing all hogs.
-
-== `awardAchievement(name, statText, capgrp)` ==
-Awards an achievement with name `name` to player.
-
-Currently, this only displays a caption and adds a mention in the stat screen.
-
-* `name`: Name of achievement.
-* `statText`: Optional. If set as string, this text will be shown in the stats screen. If `nil`, a default text is used.
-* `capgrp`: Optional. Caption group of `AddCaption` to be used. Default is `capgrpMessage2`. If `false`, no caption is shown.
-
-For consistent style, treat the name like a title is written in the English language. Good: “Naughty Ninja”. Bad: “naughty ninja”.