1
0
mirror of https://github.com/sys4-fr/server-nalc.git synced 2024-11-08 19:40:21 +01:00
server-nalc/mods/player_notes/API.txt

23 lines
743 B
Plaintext
Raw Normal View History

2014-10-28 18:01:32 +01:00
Minetest player_notes mod - API
===============================
player_notes.add_note(name, target, note)
Adds a note to a player
Returns nil on success, otherwise error string
^ name -> player or object which added the note
^ target -> to which player the note should get added
^ note -> the note text to add to <name>
player_notes.rm_note(target, key)
Removes a note from a player
Returns nil on success, otherwise error string
^ target -> from which player the note should get removed
^ key -> key of the note to remove from <name>
player_notes.save_data()
Saves changed data (use this after add_note or rm_note)
Returns nothing
player_notes.player[]
player_notes.player["dummy"] = { key1 = note1, key2 = note2, ... }