Mirrorlandia_minetest/datastorage
1
0
Fork 0
mirror of https://github.com/minetest-technic/datastorage.git synced 2024-12-20 16:55:40 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md to new API

Browse Source
This commit is contained in:
ShadowNinja 2014-07-06 18:48:12 -04:00
parent 9b3e1254c9
commit c5954e4f07
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -4,17 +4,19 @@ datastorage
Helper mod to manage players data.
All the mods can acces a single file (container) and easily have the data saved/loaded for them.
Usage
-----
Use:
local data = datastorage.get(id, ...)
local container = datastorage.get_container (mod_name, player)
returns the table for given mod and a player.
If container wasnt used before it will be created, otherwise it will contain all previously stored data.
The table can store any data.
Returns a reference to a data container. The id is normally a player name.
Following arguments are keys to recurse into, normally only one, a string
describing the type of data, is used. If the container doesn't exist it will
be created, otherwise it will contain all previously stored data. The table
can store any data. Player's containers will be saved to disk when the player
leaves, and all references to the player's data should be dropped. All of the
containers will be saved on server shutdown. To forcibly save a container's
data use:
Player's containers will be saved to disk on player leave.
All the containers will be saved on server shutdown.
To force save all player's data, use:
datastorage.save_container (player)
datastorage.save(id)