# HG changeset patch # User Wuzzy # Date 1531846631 -3600 # Node ID 4984ebed953575bf9537dd05d14b7488dde063ab # Parent 5ae6c7595054719b5ccc117b7aacd2220e582df4 LuaLibraryAchievements: formatting diff -r 5ae6c7595054 -r 4984ebed9535 LuaLibraryAchievements.wiki --- a/LuaLibraryAchievements.wiki Tue Jul 17 18:56:10 2018 +0200 +++ b/LuaLibraryAchievements.wiki Tue Jul 17 17:57:11 2018 +0100 @@ -1,7 +1,7 @@ #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. +*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. @@ -14,8 +14,10 @@ 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. +Parameters: + + * `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”.