mirror of
https://gitlab.com/rubenwardy/awards.git
synced 2024-12-28 19:50:37 +01:00
Fix incorrect description
documentation
This commit is contained in:
parent
417ac0fe46
commit
570fd3a206
22
README.md
22
README.md
@ -7,25 +7,6 @@ With thanks to Wuzzy, kaeza, and MrIbby.
|
|||||||
|
|
||||||
Majority of awards are back ported from Calinou's old fork in Carbone, under same license.
|
Majority of awards are back ported from Calinou's old fork in Carbone, under same license.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
@ -189,7 +170,7 @@ end
|
|||||||
|
|
||||||
* awards.register_award(name, def), the def table has the following fields:
|
* awards.register_award(name, def), the def table has the following fields:
|
||||||
* `title` - title of the award (defaults to name)
|
* `title` - title of the award (defaults to name)
|
||||||
* `description` - the title of the award. Required.
|
* `description` - longer description of the award, displayed in Awards tab
|
||||||
* `difficulty` - see [Award Difficulty](#award-difficulty).
|
* `difficulty` - see [Award Difficulty](#award-difficulty).
|
||||||
* `requires` - list of awards that need to be unlocked before this one
|
* `requires` - list of awards that need to be unlocked before this one
|
||||||
is visible.
|
is visible.
|
||||||
@ -201,7 +182,6 @@ end
|
|||||||
* `background` - the background image, use default otherwise.
|
* `background` - the background image, use default otherwise.
|
||||||
* `trigger` - trigger definition, see [Builtin Trigger Types](#builtin-trigger-types).
|
* `trigger` - trigger definition, see [Builtin Trigger Types](#builtin-trigger-types).
|
||||||
* `on_unlock(name, def)` - callback on unlock.
|
* `on_unlock(name, def)` - callback on unlock.
|
||||||
|
|
||||||
* awards.register_trigger(name, def), the def table has the following fields:
|
* awards.register_trigger(name, def), the def table has the following fields:
|
||||||
* `type` - see [Trigger Types](#trigger-types).
|
* `type` - see [Trigger Types](#trigger-types).
|
||||||
* `progress` - used to format progress, defaults to "%1/%2".
|
* `progress` - used to format progress, defaults to "%1/%2".
|
||||||
|
Loading…
Reference in New Issue
Block a user