summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorAlexander Weber <web.alexander@web.de>2018-01-07 20:30:27 +0100
committerAlexander Weber <web.alexander@web.de>2018-01-07 20:30:27 +0100
commit6a09746b903d63302d9dd339877bf450adb3a52c (patch)
tree62aefa088bc11b5b75968e3c8134edcd1a6ea940 /API.md
parent429874698ea5176e15a3b5703ac734b5b123d842 (diff)
Support for in_inventory_list attribute to hide usable skins in inventory
API-documentation update
Diffstat (limited to 'API.md')
-rw-r--r--API.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/API.md b/API.md
index f94213b..193f824 100644
--- a/API.md
+++ b/API.md
@@ -70,12 +70,14 @@ Add a meta information to the skin object
Note: the information is not stored, therefore should be filled each time during skins registration
## skin:get_meta(key)
-The next metadata keys are usually filled
+The next metadata keys are filled or/and used interally in skinsdb framework
- name - A name for the skin
- author - The skin author
- license - THe skin texture license
- assignment - (obsolete) is "player:playername" in case the skin is assigned to be privat for a player
- playername - Player assignment for private skin. Set false for skins not usable by all players (like NPC-Skins), true or nothing for all player skins
+ - in_inventory_list - If set to false the skin is not visible in inventory skins selection but can be still applied to the player
+ - _sort_id - Thi skins lists are sorted by this field for output (internal key)
## skin:get_meta_string(key)
Same as get_meta() but does return "" instead of nil if the meta key does not exists