sakura57 / so4

Spaced Out 4, an open-source 2D space shooter game
GNU General Public License v2.0
1 stars 0 forks source link

Write Lua documentation #2

Open sakura57 opened 4 years ago

sakura57 commented 4 years ago

The Lua engine makes a vast array of functions available for use, but the only way to learn about them and what they do is to read the code files they're defined in (LuaCallbacks.cxx).

Each function, its purpose and usage should be properly documented. Documentation should also ideally cover "best practices" and the typical layout of mission and system scripts.