Merge pull request #2 from bell07/pr_private_skins

Rework private skins handling

1 files changed, 14 insertions, 6 deletions

diff --git a/API.md b/API.md
index 0e6b293..193f824 100644
--- a/API.md
+++ b/API.md
@@ -16,12 +16,14 @@ skins.update_player_skin(player)
 ```
 
 ## skins.get_skinlist(assignment, select_unassigned)
-Get a list of skin objects matching to the assignment.
+Obsolete - use get_skinlist_for_player() or get_skinlist_with_meta() instead
 
-Supported assignments:
-  - "player:"..playername - Skins directly assigned to a player
+## skins.get_skinlist_for_player(playername)
+Get all allowed skins for player. All public and all player's private skins. If playername not given only public skins returned
 
-select_unassigned - Select all skins without assignment too (usually the "character_*" skins)
+## skins.get_skinlist_with_meta(key, value)
+Get all skins with metadata key is set to value. Example:
+skins.get_skinlist_with_meta("playername", playername) - Get all private skins (w.o. public) for playername
 
 
 ## skins.new(key, object)
@@ -68,11 +70,17 @@ 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  - is "player:playername" in case the skin is assigned to be privat for a player
+  - 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
+
+## skin:is_applicable_for_player(playername)
+Returns whether this skin is applicable for player "playername" or not, like private skins