Added emitter property ThrottleFactor

Author: fourZK

CHANGELOG.md

@@ -260,7 +260,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `Attachable` Lua (R) property `JointPos`, which gets the position of the object's joint in scene coordinates.
 
-- New `AHuman` Lua (R) Property `IsClimbing`, which indicates whether the actor is currently climbing using either of the arms.
+- New `AHuman` Lua (R) property `IsClimbing`, which indicates whether the actor is currently climbing using either of the arms.
 
 - New `AHuman` Lua functions `UnequipFGArm()` and `UnequipArms()` which unequip the currently held item(s) and put them into the actor's inventory.
 
@@ -273,6 +273,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `PrimitiveMan` Lua functions `DrawIconPrimitive(player, pos, entity)` and `DrawIconPrimitive(pos, entity)` which can be used to draw the GUI representation of the passed in entity.
 
+- New `AEmitter` and `PEmitter` Lua (R) property `ThrottleFactor`, which gets the throttle strength as a multiplier value that factors in either the positive or negative throttle multiplier according to throttle.
+
 </details>
 
 <details><summary><b>Changed</b></summary>

Entities/AEmitter.cpp

@@ -345,13 +345,7 @@ float AEmitter::EstimateImpulse(bool burst)
     }
 
 	// Scale the emission rate up or down according to the appropriate throttle multiplier.
-	float throttleFactor = 1.0F;
-	float absThrottle = std::abs(m_Throttle);
-	if (m_Throttle < 0) {
-		throttleFactor = throttleFactor * (1 - absThrottle) + (m_NegativeThrottleMultiplier * absThrottle);
-	} else if (m_Throttle > 0) {
-		throttleFactor = throttleFactor * (1 - absThrottle) + (m_PositiveThrottleMultiplier * absThrottle);
-	}
+	float throttleFactor = GetThrottleFactor();
     // Apply the throttle factor to the emission rate per update
 	if (burst) { return m_AvgBurstImpulse * throttleFactor; }
 
@@ -433,14 +427,7 @@ void AEmitter::Update()
 // TODO: Potentially get this once outside instead, like in attach/detach")
         MovableObject *pRootParent = GetRootParent();
 
-		// Scale the emission rate up or down according to the appropriate throttle multiplier.
-		float throttleFactor = 1.0F;
-		float absThrottle = std::abs(m_Throttle);
-		if (m_Throttle < 0) {
-			throttleFactor = throttleFactor * (1 - absThrottle) + (m_NegativeThrottleMultiplier * absThrottle);
-		} else if (m_Throttle > 0) {
-			throttleFactor = throttleFactor * (1 - absThrottle) + (m_PositiveThrottleMultiplier * absThrottle);
-		}
+		float throttleFactor = GetThrottleFactor();
 		m_FlashScale = throttleFactor;
         // Check burst triggering against whether the spacing is fulfilled
         if (m_BurstTriggered && (m_BurstSpacing <= 0 || m_BurstTimer.IsPastSimMS(m_BurstSpacing)))

Entities/AEmitter.h

@@ -260,6 +260,12 @@ ClassInfoGetters;
 
     float GetThrottle() const { return m_Throttle; }
 
+	/// <summary>
+	/// Gets the adjusted throttle multiplier that is factored into the emission rate of this AEmitter.
+	/// </summary>
+	/// <returns>The throttle strength as a multiplier.</returns>
+	float GetThrottleFactor() const { return 1.0F - std::abs(m_Throttle) + (m_Throttle < 0 ? m_NegativeThrottleMultiplier : m_PositiveThrottleMultiplier) * std::abs(m_Throttle); }
+
 	/// <summary>
 	/// Gets the negative throttle multiplier of this AEmitter.
 	/// </summary>

Entities/PEmitter.cpp

@@ -340,13 +340,7 @@ namespace RTE {
 		}
 
 		// Scale the emission rate up or down according to the appropriate throttle multiplier.
-		float throttleFactor = 1.0F;
-		float absThrottle = std::abs(m_Throttle);
-		if (m_Throttle < 0) {
-			throttleFactor = throttleFactor * (1 - absThrottle) + (m_NegativeThrottleMultiplier * absThrottle);
-		} else if (m_Throttle > 0) {
-			throttleFactor = throttleFactor * (1 - absThrottle) + (m_PositiveThrottleMultiplier * absThrottle);
-		}
+		float throttleFactor = GetThrottleFactor();
 		// Apply the throttle factor to the emission rate per update
 		if (burst)
 			return m_AvgBurstImpulse * throttleFactor;
@@ -399,13 +393,7 @@ namespace RTE {
 			MovableObject *pRootParent = GetRootParent();
 
 			// Scale the emission rate up or down according to the appropriate throttle multiplier.
-			float throttleFactor = 1.0F;
-			float absThrottle = std::abs(m_Throttle);
-			if (m_Throttle < 0) {
-				throttleFactor = throttleFactor * (1 - absThrottle) + (m_NegativeThrottleMultiplier * absThrottle);
-			} else if (m_Throttle > 0) {
-				throttleFactor = throttleFactor * (1 - absThrottle) + (m_PositiveThrottleMultiplier * absThrottle);
-			}
+			float throttleFactor = GetThrottleFactor();
 			m_FlashScale = throttleFactor;
 			// Check burst triggering against whether the spacing is fulfilled
 			if (m_BurstTriggered && (m_BurstSpacing <= 0 || m_BurstTimer.IsPastSimMS(m_BurstSpacing)))

Entities/PEmitter.h

@@ -272,6 +272,14 @@ class PEmitter : public MOSParticle {
 	//                  0 means normal, -1.0 means least emission rate.
 
 	float GetThrottle() const { return m_Throttle; }
+
+
+	/// <summary>
+	/// Gets the adjusted throttle multiplier that is factored into the emission rate of this PEmitter.
+	/// </summary>
+	/// <returns>The throttle strength as a multiplier.</returns>
+	float GetThrottleFactor() const { return 1.0F - std::abs(m_Throttle) + (m_Throttle < 0 ? m_NegativeThrottleMultiplier : m_PositiveThrottleMultiplier) * std::abs(m_Throttle); }
+
 	/*
 	//////////////////////////////////////////////////////////////////////////////////////////
 	// Method:          SetEmitRate

Lua/LuaBindingsEntities.cpp

@@ -371,6 +371,7 @@ namespace RTE {
 		.property("EmitAngle", &AEmitter::GetEmitAngle, &AEmitter::SetEmitAngle)
 		.property("GetThrottle", &AEmitter::GetThrottle, &AEmitter::SetThrottle)
 		.property("Throttle", &AEmitter::GetThrottle, &AEmitter::SetThrottle)
+		.property("ThrottleFactor", &AEmitter::GetThrottleFactor)
 		.property("NegativeThrottleMultiplier", &AEmitter::GetNegativeThrottleMultiplier, &AEmitter::SetNegativeThrottleMultiplier)
 		.property("PositiveThrottleMultiplier", &AEmitter::GetPositiveThrottleMultiplier, &AEmitter::SetPositiveThrottleMultiplier)
 		.property("BurstSpacing", &AEmitter::GetBurstSpacing, &AEmitter::SetBurstSpacing)
@@ -984,6 +985,7 @@ namespace RTE {
 		.property("EmitAngle", &PEmitter::GetEmitAngle, &PEmitter::SetEmitAngle)
 		.property("GetThrottle", &PEmitter::GetThrottle, &PEmitter::SetThrottle)
 		.property("Throttle", &PEmitter::GetThrottle, &PEmitter::SetThrottle)
+		.property("ThrottleFactor", &PEmitter::GetThrottleFactor)
 		.property("BurstSpacing", &PEmitter::GetBurstSpacing, &PEmitter::SetBurstSpacing)
 		.property("EmitCountLimit", &PEmitter::GetEmitCountLimit, &PEmitter::SetEmitCountLimit)
 		.property("FlashScale", &PEmitter::GetFlashScale, &PEmitter::SetFlashScale)