Skip to content

Commit

Permalink
LuaConstEngine.cpp: Update Lua docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rhys-vdw committed Nov 18, 2024
1 parent fede071 commit 4493fb9
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions rts/Lua/LuaConstEngine.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,22 @@
* @see rts/Lua/LuaConstEngine.cpp
******************************************************************************/

/*** Engine specific information
/***
* @class FeatureSupport
* @field hasExitOnlyYardmaps boolean
* @field rmlUiApiVersion integer
*/

/***
* Engine specific information.
*
* @table Engine
* @param version string Returns the same as `spring *sync-version`, e.g. "92"
* @param versionFull string
* @param versionPatchSet string
* @param buildFlags string (unsynced only) Gets additional engine buildflags, e.g. "OMP" or "MT-Sim DEBUG"
* @param FeatureSupport string table containing various engine features as keys; use for cross-version compat
* @param wordSize number indicates the build type and is either 32 or 64 (or 0 in synced code)
* @field version string Returns the same as `spring *sync-version`, e.g. "92"
* @field versionFull string
* @field versionPatchSet string
* @field buildFlags string (unsynced only) Gets additional engine buildflags, e.g. "OMP" or "MT-Sim DEBUG"
* @field FeatureSupport FeatureSupport table containing various engine features as keys; use for cross-version compat
* @field wordSize number indicates the build type and is either 32 or 64 (or 0 in synced code)
*/

bool LuaConstEngine::PushEntries(lua_State* L)
Expand Down

0 comments on commit 4493fb9

Please sign in to comment.