Documentation in README

master
A. Demant 2019-02-12 14:17:07 +01:00
parent 2766ceea6c
commit 4920c82368
1 changed files with 3 additions and 0 deletions

View File

@ -38,6 +38,9 @@ Usage (roughly), for Details see api.lua:
- xpfw.register_attribute(name,data) to register new attribute <name>
- xpfw.player_get_attribute(player,name) Get stored value of attribute <name> for ObjectRef player
- xpfw.player_set_attribute(player,name, value) Set attribute <name> for ObjectRef player to <value>
- xpfw.player_ping_attribute(player,name) "Ping" attribute: Get max value which is defined for attribute and add to attribute. For an attribute, which is defined as moving average attribute this pinging increase the value. High frequency of pinging lead to faster increase, e.g. by pinging a digging attribute you get kind of digging speed, which can be used for an exhaustion mechanism.
- xpfw.player_add/sub_attribute(player,name,diff) Adds or substract <diff> to attribute <name> of for ObjectRef player
Authors of source code
----------------------