Add {Set,Get}FeatureRulesParam(s)

Fix #5059

doc/changelog.txt

@@ -12,6 +12,7 @@ Sim:
  - COB: deprecate unit/team/allyteam/global vars. Use lua functions instead.
 
 Lua:
+ - Add {Set,Get}FeatureRulesParam(s)
  - Add new Spring.ClearUnitGoal(unitID) callout.
  - add GamePaused and GameProgress callins to base gadget-handler
  - extend builtin uniform binding for custom Lua materials

rts/Lua/LuaSyncedCtrl.cpp

@@ -155,9 +155,10 @@ bool LuaSyncedCtrl::PushEntries(lua_State* L)
 	REGISTER_LUA_CFUNC(SetTeamShareLevel);
 	REGISTER_LUA_CFUNC(ShareTeamResource);
 
-	REGISTER_LUA_CFUNC(SetUnitRulesParam);
-	REGISTER_LUA_CFUNC(SetTeamRulesParam);
 	REGISTER_LUA_CFUNC(SetGameRulesParam);
+	REGISTER_LUA_CFUNC(SetTeamRulesParam);
+	REGISTER_LUA_CFUNC(SetUnitRulesParam);
+	REGISTER_LUA_CFUNC(SetFeatureRulesParam);
 
 	REGISTER_LUA_CFUNC(CreateUnit);
 	REGISTER_LUA_CFUNC(DestroyUnit);
@@ -1055,9 +1056,9 @@ int LuaSyncedCtrl::SetGameRulesParam(lua_State* L)
 int LuaSyncedCtrl::SetTeamRulesParam(lua_State* L)
 {
 	CTeam* team = ParseTeam(L, __FUNCTION__, 1);
-	if (team == NULL) {
+	if (team == nullptr)
 		return 0;
-	}
+
 	SetRulesParam(L, __FUNCTION__, 1, team->modParams, team->modParamsMap);
 	return 0;
 }
@@ -1066,14 +1067,23 @@ int LuaSyncedCtrl::SetTeamRulesParam(lua_State* L)
 int LuaSyncedCtrl::SetUnitRulesParam(lua_State* L)
 {
 	CUnit* unit = ParseUnit(L, __FUNCTION__, 1);
-	if (unit == NULL) {
+	if (unit == nullptr)
 		return 0;
-	}
+
 	SetRulesParam(L, __FUNCTION__, 1, unit->modParams, unit->modParamsMap);
 	return 0;
 }
 
 
+int LuaSyncedCtrl::SetFeatureRulesParam(lua_State* L)
+{
+	CFeature* feature = ParseFeature(L, __FUNCTION__, 1);
+	if (feature == nullptr)
+		return 0;
+
+	SetRulesParam(L, __FUNCTION__, 1, feature->modParams, feature->modParamsMap);
+	return 0;
+}
 
 /******************************************************************************/
 /******************************************************************************/

rts/Lua/LuaSyncedCtrl.h

@@ -38,9 +38,10 @@ class LuaSyncedCtrl
 		static int CallCOBScript(lua_State* L);
 		static int GetCOBScriptID(lua_State* L);
 
-		static int SetUnitRulesParam(lua_State* L);
-		static int SetTeamRulesParam(lua_State* L);
 		static int SetGameRulesParam(lua_State* L);
+		static int SetTeamRulesParam(lua_State* L);
+		static int SetUnitRulesParam(lua_State* L);
+		static int SetFeatureRulesParam(lua_State* L);
 
 		static int GiveOrderToUnit(lua_State* L);
 		static int GiveOrderToUnitMap(lua_State* L);

rts/Lua/LuaSyncedRead.cpp

@@ -285,6 +285,9 @@ bool LuaSyncedRead::PushEntries(lua_State* L)
 	REGISTER_LUA_CFUNC(GetFeaturePieceCollisionVolumeData);
 	REGISTER_LUA_CFUNC(GetFeatureSeparation);
 
+	REGISTER_LUA_CFUNC(GetFeatureRulesParam);
+	REGISTER_LUA_CFUNC(GetFeatureRulesParams);
+
 	REGISTER_LUA_CFUNC(GetProjectilePosition);
 	REGISTER_LUA_CFUNC(GetProjectileDirection);
 	REGISTER_LUA_CFUNC(GetProjectileVelocity);
@@ -4619,7 +4622,7 @@ int LuaSyncedRead::GetFeatureCollisionVolumeData(lua_State* L)
 {
 	CFeature* feature = ParseFeature(L, __FUNCTION__, 1);
 
-	if (feature == NULL)
+	if (feature == nullptr)
 		return 0;
 
 	return (PushCollisionVolumeData(L, &feature->collisionVolume));
@@ -4631,6 +4634,63 @@ int LuaSyncedRead::GetFeaturePieceCollisionVolumeData(lua_State* L)
 }
 
 
+int LuaSyncedRead::GetFeatureRulesParams(lua_State* L)
+{
+	CFeature* feature = ParseFeature(L, __FUNCTION__, 1);
+
+	if (feature == nullptr)
+		return 0;
+
+	int losMask = LuaRulesParams::RULESPARAMLOS_PUBLIC_MASK;
+
+	if (IsAlliedAllyTeam(L, feature->allyteam) || game->IsGameOver()) {
+		losMask |= LuaRulesParams::RULESPARAMLOS_PRIVATE_MASK;
+	}
+	else if (teamHandler->AlliedTeams(feature->team, CLuaHandle::GetHandleReadTeam(L)) || ((CLuaHandle::GetHandleReadAllyTeam(L) < 0) && CLuaHandle::GetHandleFullRead(L))) {
+		losMask |= LuaRulesParams::RULESPARAMLOS_ALLIED_MASK;
+	}
+	else if (CLuaHandle::GetHandleReadAllyTeam(L) < 0) {
+		//! NoAccessTeam
+	}
+	else if (IsFeatureVisible(L, feature)) {
+		losMask |= LuaRulesParams::RULESPARAMLOS_INLOS_MASK;
+	}
+
+	const LuaRulesParams::Params&  params    = feature->modParams;
+	const LuaRulesParams::HashMap& paramsMap = feature->modParamsMap;
+
+	return PushRulesParams(L, __FUNCTION__, params, paramsMap, losMask);
+}
+
+
+int LuaSyncedRead::GetFeatureRulesParam(lua_State* L)
+{
+	CFeature* feature = ParseFeature(L, __FUNCTION__, 1);
+
+	if (feature == nullptr)
+		return 0;
+
+	int losMask = LuaRulesParams::RULESPARAMLOS_PUBLIC_MASK;
+
+	if (IsAlliedAllyTeam(L, feature->allyteam) || game->IsGameOver()) {
+		losMask |= LuaRulesParams::RULESPARAMLOS_PRIVATE_MASK;
+	}
+	else if (teamHandler->AlliedTeams(feature->team, CLuaHandle::GetHandleReadTeam(L)) || ((CLuaHandle::GetHandleReadAllyTeam(L) < 0) && CLuaHandle::GetHandleFullRead(L))) {
+		losMask |= LuaRulesParams::RULESPARAMLOS_ALLIED_MASK;
+	}
+	else if (CLuaHandle::GetHandleReadAllyTeam(L) < 0) {
+		//! NoAccessTeam
+	}
+	else if (IsFeatureVisible(L, feature)) {
+		losMask |= LuaRulesParams::RULESPARAMLOS_INLOS_MASK;
+	}
+
+	const LuaRulesParams::Params&  params    = feature->modParams;
+	const LuaRulesParams::HashMap& paramsMap = feature->modParamsMap;
+
+	return GetRulesParam(L, __FUNCTION__, 2, params, paramsMap, losMask);
+}
+
 /******************************************************************************/
 /******************************************************************************/
 

rts/Lua/LuaSyncedRead.h

@@ -192,6 +192,9 @@ class LuaSyncedRead {
 		static int GetFeatureCollisionVolumeData(lua_State* L);
 		static int GetFeaturePieceCollisionVolumeData(lua_State* L);
 
+		static int GetFeatureRulesParam(lua_State* L);
+		static int GetFeatureRulesParams(lua_State* L);
+
 		static int GetProjectilePosition(lua_State* L);
 		static int GetProjectileDirection(lua_State* L);
 		static int GetProjectileVelocity(lua_State* L);

rts/Sim/Objects/SolidObject.h

@@ -4,6 +4,7 @@
 #define SOLID_OBJECT_H
 
 #include "WorldObject.h"
+#include "Lua/LuaRulesParams.h"
 #include "Rendering/Models/3DModel.h"
 #include "Sim/Misc/CollisionVolume.h"
 #include "System/bitops.h"
@@ -343,6 +344,17 @@ class CSolidObject: public CWorldObject {
 	bool yardOpen;
 	short int buildFacing;                      ///< Orientation of footprint, 4 different states
 
+	/**
+	 * @brief mod controlled parameters
+	 * This is a set of parameters that is initialized
+	 * in CreateUnitRulesParams() and may change during the game.
+	 * Each parameter is uniquely identified only by its id
+	 * (which is the index in the vector).
+	 * Parameters may or may not have a name.
+	 */
+	LuaRulesParams::Params  modParams;
+	LuaRulesParams::HashMap modParamsMap; ///< name map for mod parameters
+
 public:
 	static const float DEFAULT_MASS;
 	static const float MINIMUM_MASS;

rts/Sim/Units/Unit.h

@@ -6,7 +6,6 @@
 #include <vector>
 #include <string>
 
-#include "Lua/LuaRulesParams.h"
 #include "Sim/Objects/SolidObject.h"
 #include "Sim/Misc/Resource.h"
 #include "Sim/Weapons/WeaponTarget.h"
@@ -313,17 +312,6 @@ class CUnit : public CSolidObject
 
 	int featureDefID; // FeatureDef id of the wreck we spawn on death
 
-	/**
-	 * @brief mod controlled parameters
-	 * This is a set of parameters that is initialized
-	 * in CreateUnitRulesParams() and may change during the game.
-	 * Each parameter is uniquely identified only by its id
-	 * (which is the index in the vector).
-	 * Parameters may or may not have a name.
-	 */
-	LuaRulesParams::Params  modParams;
-	LuaRulesParams::HashMap modParamsMap; ///< name map for mod parameters
-
 	/// indicate the relative power of the unit, used for experience calulations etc
 	float power;