zughy-friends-minetest/collectible-skins-cd2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOCS: add Storage section

Browse Source
This commit is contained in:
marco_a 2024-07-29 00:42:05 +02:00
parent ce87385fd0
commit de9c01db4f
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
DOCS.md
View File

@ -4,6 +4,7 @@
* [1 Skins](#1-skins)
* [1.1 Collections](#11-collections)
* [1.2 UI](#12-ui)
* [1.3 Storage](#13-storage)
* [2 API](#2-api)
* [2.1 Skins handlers](#21-skins-handlers)
* [2.2 Utils](#22-utils)
@ -46,6 +47,9 @@ Collectible Skins comes with a built-in UI, but it also allows modders to implem
What it does is to display all the skins sharing the same model the player has, ignoring empty collections.
## 1.3 Storage
Collectible Skins uses the mod storage to store all the skins unlocked by a certain player, and a string metadata (`collectible_skins:skin`) to store the technical name of the skin currently equipped.
## 2 API
### 2.1 Skins handlers
* `collectible_skins.unlock_skin(p_name, skin_name)`: unlocks skin `skin_name` for `p_name`