OgelGames / fakelib

Minetest fake userdata library
MIT License
4 stars 0 forks source link

Documentation does not cover all of mod functonality #2

Open Eternal-Study opened 1 week ago

Eternal-Study commented 1 week ago

While the API covers functions to check values and to create fake players, inventories, etc... there are many more functions that remain to be documented. For example, the Dynamic Get/Set functions in player.lua are completely undocumented.

One of the strengths of this mod and a great selling point for adaptation is the fact that it comes with these functions, which fake player code in other mods often lack. Documenting them will help advertise this strength, and help ensure they are used by mod authors.

Also, an example for setting metadata would be beneficial for coders new to Minetest / Lua.

OgelGames commented 1 week ago

Those functions are not documented because they are designed to exactly replicate the real player functions, which are all documented in the engine documentation: https://github.com/minetest/minetest/blob/master/doc/lua_api.md#objectref