From ae7580b6bed3e18d2bc82698c028ad9765b7a722 Mon Sep 17 00:00:00 2001 From: "Clarence \"Sparr\" Risher" Date: Tue, 1 Sep 2026 15:09:23 -0400 Subject: [PATCH] docs: annotate spSetSunLighting (#3307) --- rts/Lua/LuaUnsyncedCtrl.cpp | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/rts/Lua/LuaUnsyncedCtrl.cpp b/rts/Lua/LuaUnsyncedCtrl.cpp index e323e8fa75..d8a8c64fc8 100644 --- a/rts/Lua/LuaUnsyncedCtrl.cpp +++ b/rts/Lua/LuaUnsyncedCtrl.cpp @@ -4206,6 +4206,25 @@ int LuaUnsyncedCtrl::SetSunDirection(lua_State* L) return 0; } +/*** + * @class SunLightingParams + * + * The parameter table for sun lighting + * @see Spring.SetSunLighting + * + * @field specularExponent number? + * @field groundShadowDensity number? + * @field modelShadowDensity number? + * @field groundAmbientColor rgba? + * @field groundDiffuseColor rgba? + * @field groundSpecularColor rgba? + * @field unitAmbientColor rgba? + * @field modelAmbientColor rgba? + * @field unitDiffuseColor rgba? + * @field modelDiffuseColor rgba? + * @field unitSpecularColor rgba? + * @field modelSpecularColor rgba? + */ /*** * Modify sun lighting parameters. @@ -4215,7 +4234,7 @@ int LuaUnsyncedCtrl::SetSunDirection(lua_State* L) * ``` * * @function Spring.SetSunLighting - * @param params { groundAmbientColor: rgb, groundDiffuseColor: rgb } + * @param params SunLightingParams */ int LuaUnsyncedCtrl::SetSunLighting(lua_State* L) {