[Feature] Add Rule to Disable Group EXP Modifier. (#2741)

# Notes
- Adds `Character:EnableGroupEXPModifier`, defaults to `true`.
- Adds `Character:GroupMemberEXPModifier`, defaults to `0.2`.
- Adds `Character:FullGroupEXPModifier`, defaults to `2.16`.
- Allows operators to enable or disable the group experience modifier based on number of members.
- Allows operators to change the modifier per member in the group between `2` and `5`.
- Allows operators to change the full group experience modifier.

common/ruletypes.h

@@ -197,6 +197,9 @@ RULE_BOOL(Character, PetZoneWithOwner, true, "Should Pets Zone with Owner")
 RULE_BOOL(Character, FullManaOnDeath, true, "On death set mana to full")
 RULE_BOOL(Character, FullEndurOnDeath, true, "On death set endurance to full")
 RULE_INT(Character, ExperiencePercentCapPerKill, -1, "Caps the percentage of experience that can be gained per kill. -1 disables the cap; 0 blocks all (non-aa) xp.")
+RULE_BOOL(Character, EnableGroupEXPModifier, true, "Enable or disable the group experience modifier based on number of players in group, default is true")
+RULE_REAL(Character, GroupMemberEXPModifier, 0.2, "Sets the group experience modifier per members between 2 and 5, default is 0.2")
+RULE_REAL(Character, FullGroupEXPModifier, 2.16, "Sets the group experience modifier for a full group, default is 2.16")
 RULE_CATEGORY_END()
 
 RULE_CATEGORY(Mercs)

zone/exp.cpp

@@ -31,6 +31,7 @@
 #include "quest_parser_collection.h"
 #include "lua_parser.h"
 #include "string_ids.h"
+#include "../common/data_verification.h"
 
 #ifdef BOTS
 #include "bot.h"
@@ -1070,103 +1071,102 @@ void Client::AddLevelBasedExp(uint8 exp_percentage, uint8 max_level, bool ignore
 }
 
 void Group::SplitExp(uint64 exp, Mob* other) {
-	if( other->CastToNPC()->MerchantType != 0 ) // Ensure NPC isn't a merchant
+	if (other->CastToNPC()->MerchantType != 0) {
 		return;
+	}
 
-	if(other->GetOwner() && other->GetOwner()->IsClient()) // Ensure owner isn't pc
+	if (other->GetOwner() && other->GetOwner()->IsClient()) {
 		return;
+	}
 
-	unsigned int i;
+	auto member_count = GroupCount();
-	uint64 groupexp = exp;
+	if (!member_count) {
-	uint8 membercount = 0;
+		return;
-	uint8 maxlevel = 1;
+	}
 
-	for (i = 0; i < MAX_GROUP_MEMBERS; i++) {
+	auto group_experience = exp;
-		if (members[i] != nullptr) {
+	auto highest_level    = GetHighestLevel();
-			if(members[i]->GetLevel() > maxlevel)
-				maxlevel = members[i]->GetLevel();
 
-			membercount++;
+	auto group_modifier = 1.0f;
+	if (RuleB(Character, EnableGroupEXPModifier)) {
+		if (EQ::ValueWithin(member_count, 2, 5)) {
+			group_modifier = 1 + RuleR(Character, GroupMemberEXPModifier) * (member_count - 1); // 2 = 1.2x, 3 = 1.4x, 4 = 1.6x, 5 = 1.8x
+		} else if (member_count == 6) {
+			group_modifier = RuleR(Character, FullGroupEXPModifier);
 		}
 	}
 
-	float groupmod;
+	if (EQ::ValueWithin(member_count, 2, 6)) {
-	if (membercount > 1 && membercount < 6)
+		group_experience += static_cast<uint64>(
-		groupmod = 1 + .2*(membercount - 1); //2members=1.2exp, 3=1.4, 4=1.6, 5=1.8
+			static_cast<float>(exp) *
-	else if (membercount == 6)
+			group_modifier *
-		groupmod = 2.16;
+			RuleR(Character, GroupExpMultiplier)
-	else
+		);
-		groupmod = 1.0;
+	}
-	if(membercount > 1 &&  membercount <= 6)
-		groupexp += (uint64)((float)exp * groupmod * (RuleR(Character, GroupExpMultiplier)));
 
-	int conlevel = Mob::GetLevelCon(maxlevel, other->GetLevel());
+	auto consider_level = Mob::GetLevelCon(highest_level, other->GetLevel());
-	if(conlevel == CON_GRAY)
+	if (consider_level == CON_GRAY) {
-		return;	//no exp for greenies...
-
-	if (membercount == 0)
 		return;
+	}
 
-	for (i = 0; i < MAX_GROUP_MEMBERS; i++) {
+	for (const auto& m : members) {
-		if (members[i] != nullptr && members[i]->IsClient()) // If Group Member is Client
+		if (m && m->IsClient()) {
-		{
+			uint32 diff     = m->GetLevel() - highest_level;
-			Client *cmember = members[i]->CastToClient();
+			uint32 max_diff = -(m->GetLevel() * 15 / 10 - m->GetLevel());
-			// add exp + exp cap
+
-			int16 diff = cmember->GetLevel() - maxlevel;
+			if (max_diff > -5) {
-			int16 maxdiff = -(cmember->GetLevel()*15/10 - cmember->GetLevel());
+				max_diff = -5;
-				if(maxdiff > -5)
+			}
-					maxdiff = -5;
+
-			if (diff >= (maxdiff)) { /*Instead of person who killed the mob, the person who has the highest level in the group*/
+			if (diff >= max_diff) {
-				uint64 tmp = (cmember->GetLevel()+3) * (cmember->GetLevel()+3) * 75 * 35 / 10;
+				uint64 tmp  = (m->GetLevel() + 3) * (m->GetLevel() + 3) * 75 * 35 / 10;
-				uint64 tmp2 = groupexp / membercount;
+				uint64 tmp2 = group_experience / member_count;
-				cmember->AddEXP( tmp < tmp2 ? tmp : tmp2, conlevel );
+				m->CastToClient()->AddEXP(tmp < tmp2 ? tmp : tmp2, consider_level);
 			}
 		}
 	}
 }
 
 void Raid::SplitExp(uint64 exp, Mob* other) {
-	if( other->CastToNPC()->MerchantType != 0 ) // Ensure NPC isn't a merchant
+	if (other->CastToNPC()->MerchantType != 0) {
 		return;
-
-	if(other->GetOwner() && other->GetOwner()->IsClient()) // Ensure owner isn't pc
-		return;
-
-	uint64 groupexp = exp;
-	uint8 membercount = 0;
-	uint8 maxlevel = 1;
-
-	for (int i = 0; i < MAX_RAID_MEMBERS; i++) {
-		if (members[i].member != nullptr) {
-			if(members[i].member->GetLevel() > maxlevel)
-				maxlevel = members[i].member->GetLevel();
-
-			membercount++;
-		}
 	}
 
-	groupexp = (uint64)((float)groupexp * (1.0f-(RuleR(Character, RaidExpMultiplier))));
+	if (other->GetOwner() && other->GetOwner()->IsClient()) {
-
-	int conlevel = Mob::GetLevelCon(maxlevel, other->GetLevel());
-	if(conlevel == CON_GRAY)
-		return;	//no exp for greenies...
-
-	if (membercount == 0)
 		return;
+	}
 
-	for (unsigned int x = 0; x < MAX_RAID_MEMBERS; x++) {
+	auto member_count = RaidCount();
-		if (members[x].member != nullptr) // If Group Member is Client
+	if (!member_count) {
-		{
+		return;
-			Client *cmember = members[x].member;
+	}
-			// add exp + exp cap
+
-			int16 diff = cmember->GetLevel() - maxlevel;
+	auto raid_experience = exp;
-			int16 maxdiff = -(cmember->GetLevel()*15/10 - cmember->GetLevel());
+	auto highest_level   = GetHighestLevel();
-			if(maxdiff > -5)
+
-				maxdiff = -5;
+	raid_experience = static_cast<uint64>(
-			if (diff >= (maxdiff)) { /*Instead of person who killed the mob, the person who has the highest level in the group*/
+		static_cast<float>(raid_experience) *
-				uint64 tmp = (cmember->GetLevel()+3) * (cmember->GetLevel()+3) * 75 * 35 / 10;
+		(1.0f - RuleR(Character, RaidExpMultiplier))
-				uint64 tmp2 = (groupexp / membercount) + 1;
+	);
-				cmember->AddEXP( tmp < tmp2 ? tmp : tmp2, conlevel );
+
+	auto consider_level = Mob::GetLevelCon(highest_level, other->GetLevel());
+	if (consider_level == CON_GRAY) {
+		return;
+	}
+
+	for (const auto& m : members) {
+		if (m.member) {
+			uint32 diff     = m.member->GetLevel() - highest_level;
+			uint32 max_diff = -(m.member->GetLevel() * 15 / 10 - m.member->GetLevel());
+
+			if (max_diff > -5) {
+				max_diff = -5;
+			}
+
+			if (diff >= max_diff) {
+				uint64 tmp  = (m.member->GetLevel() + 3) * (m.member->GetLevel() + 3) * 75 * 35 / 10;
+				uint64 tmp2 = (raid_experience / member_count) + 1;
+				m.member->AddEXP(tmp < tmp2 ? tmp : tmp2, consider_level);
 			}
 		}
 	}