Esposed ReloadTimer, and made ReloadProgress (and the Timer Real/SimTimeLimitProgress properties) writable

Author: Causeless

CHANGELOG.md

@@ -138,6 +138,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New option to mute audio when the game window loses focus.
 
+- `ReloadTimer` on `HDFirearm` is now exposed to Lua.
+
+- `ReloadProgress` on `HDFirearm` is now a writable property in Lua, and not only readable.
+
+- `RealTimeLimitProgress` and `SimTimeLimitProgress` on `Timer` are now both writable properties in Lua, and not only readable.
+
 </details>
 
 <details><summary><b>Changed</b></summary>

Source/Entities/Actor.cpp

@@ -1387,8 +1387,8 @@ void Actor::DrawHUD(BITMAP* pTargetBitmap, const Vector& targetPos, int whichScr
 	}
 
 	// Draw the alarm exclamation mark if we are alarmed!
-	if (m_AlarmTimer.SimTimeLimitProgress() < 0.25) {
-		draw_sprite(pTargetBitmap, m_apAlarmExclamation[m_AgeTimer.AlternateSim(100)], cpuPos.m_X - 3, EaseOut(drawPos.m_Y + m_HUDStack - 10, drawPos.m_Y + m_HUDStack - 25, m_AlarmTimer.SimTimeLimitProgress() / 0.25f));
+	if (m_AlarmTimer.GetSimTimeLimitProgress() < 0.25) {
+		draw_sprite(pTargetBitmap, m_apAlarmExclamation[m_AgeTimer.AlternateSim(100)], cpuPos.m_X - 3, EaseOut(drawPos.m_Y + m_HUDStack - 10, drawPos.m_Y + m_HUDStack - 25, m_AlarmTimer.GetSimTimeLimitProgress() / 0.25f));
 	}
 
 	if (pSmallFont && pSymbolFont) {

Source/Entities/HDFirearm.h

@@ -365,25 +365,29 @@ namespace RTE {
 
 		/// Gets this HDFirearm's reload progress as a scalar from 0 to 1.
 		/// @return The reload progress as a scalar from 0 to 1.
-		float GetReloadProgress() const { return IsReloading() && m_BaseReloadTime > 0 ? static_cast<float>(m_ReloadTmr.SimTimeLimitProgress()) : 1.0F; }
+		float GetReloadProgress() const { return IsReloading() && m_BaseReloadTime > 0 ? static_cast<float>(m_ReloadTmr.GetSimTimeLimitProgress()) : 1.0F; }
+
+		/// Sets this HDFirearm's reload progress as a scalar from 0 to 1.
+		/// @param progress The reload progress as a scalar from 0 to 1.
+		void SetReloadProgress(float progress) { m_ReloadTmr.SetSimTimeLimitProgress(progress); }
+
+		/// Gets this HDFirearm's underlying reload timer.
+		/// @return This firearm's reload timer.
+		Timer& GetReloadTimer() { return m_ReloadTmr; }
 
 		/// Does the calculations necessary to detect whether this HDFirearm is at rest or not. IsAtRest() retrieves the answer.
 		void RestDetection() override;
 
-		/// Activates one of this HDFirearm's features. Analogous to 'pulling
-		/// the trigger'.
+		/// Activates one of this HDFirearm's features. Analogous to 'pulling the trigger'.
 		void Activate() override;
 
-		/// Deactivates one of this HDFirearm's features. Analogous to 'releasing
-		/// the trigger'.
+		/// Deactivates one of this HDFirearm's features. Analogous to 'releasing the trigger'.
 		void Deactivate() override;
 
-		/// Aborts playing of active sound no matter what. Used to silence spinning
-		/// weapons when weapons swapped
+		/// Aborts playing of active sound no matter what. Used to silence spinning weapons when weapons swapped
 		void StopActivationSound();
 
-		/// Throws out the currently used Magazine, if any, and puts in a new one
-		/// after the reload delay is up.
+		/// Throws out the currently used Magazine, if any, and puts in a new one after the reload delay is up.
 		void Reload() override;
 
 		/// Tells whether the device is curtrently being reloaded.
@@ -398,11 +402,12 @@ namespace RTE {
 		/// @return Whetehr in need of reloading (ie not full).
 		bool NeedsReloading() const override;
 
-		/// Tells whether the device is curtrently full and reloading won't have
-		/// any effect.
-		/// @return Whetehr magazine is full or not.
+		/// Tells whether the device is currently full and reloading won't have any effect.
+		/// @return Whether magazine is full or not.
 		bool IsFull() const override;
 
+		/// Tells whether the device is currently empty and attempting to fire won't have any effect.
+		/// @return Whether magazine is empty or not.
 		bool IsEmpty() const override;
 
 		/// Tells whether the device is fully automatic or not.
@@ -427,8 +432,7 @@ namespace RTE {
 		/// Updates this MovableObject. Supposed to be done every frame.
 		void Update() override;
 
-		/// Draws this HDFirearm's current graphical representation to a
-		/// BITMAP of choice.
+		/// Draws this HDFirearm's current graphical representation to a BITMAP of choice.
 		/// @param pTargetBitmap A pointer to a BITMAP to draw on.
 		/// @param targetPos The absolute position of the target bitmap's upper left corner in the Scene. (default: Vector())
 		/// @param mode In which mode to draw in. See the DrawMode enumeration for the modes. (default: g_DrawColor)
@@ -439,8 +443,7 @@ namespace RTE {
 		/// Draws an aiming aid in front of this HeldDevice.
 		/// @param pTargetBitmap A pointer to a BITMAP to draw on.
 		/// @param targetPos The absolute position of the target bitmap's upper left corner in the Scene. (default: Vector())
-		/// @param whichScreen Which player's screen this is being drawn to. May affect what HUD elements (default: 0)
-		/// get drawn etc.
+		/// @param whichScreen Which player's screen this is being drawn to. May affect what HUD elements get drawn etc. (default: 0)
 		void DrawHUD(BITMAP* pTargetBitmap, const Vector& targetPos = Vector(), int whichScreen = 0, bool playerControlled = false) override;
 
 		/// Estimates what material strength one round in the magazine can destroy.
@@ -475,7 +478,6 @@ namespace RTE {
 		/// @param newValue Manual animation flag value.
 		void SetAnimatedManually(bool newValue) { m_IsAnimatedManually = newValue; }
 
-		/// Protected member variable and method declarations
 	protected:
 		/// Sets this Attachable's parent MOSRotating, and also sets its Team based on its parent and, if the Attachable is set to collide, adds/removes Atoms to its new/old parent.
 		/// Additionally, sets this HDFirearm as not firing or reloading, and resets its reload timer.

Source/GUI/GUILabel.cpp

@@ -174,8 +174,8 @@ void GUILabel::Draw(GUIBitmap* Bitmap, bool overwiteFontColorAndKerning) {
 						m_OverflowScrollState = OverflowScrollState::WaitAtEnd;
 						break;
 					}
-					xPos -= modifyXPos ? static_cast<int>(static_cast<double>(textFullWidth - m_Width) * m_OverflowScrollTimer.RealTimeLimitProgress()) : 0;
-					yPos -= modifyYPos ? static_cast<int>(static_cast<double>(textFullHeight - m_Height) * m_OverflowScrollTimer.RealTimeLimitProgress()) : 0;
+					xPos -= modifyXPos ? static_cast<int>(static_cast<double>(textFullWidth - m_Width) * m_OverflowScrollTimer.GetRealTimeLimitProgress()) : 0;
+					yPos -= modifyYPos ? static_cast<int>(static_cast<double>(textFullHeight - m_Height) * m_OverflowScrollTimer.GetRealTimeLimitProgress()) : 0;
 					break;
 				case OverflowScrollState::WaitAtEnd:
 					if (m_OverflowScrollTimer.GetRealTimeLimitMS() == -1) {

Source/Lua/LuaBindingsEntities.cpp

@@ -654,7 +654,8 @@ LuaBindingRegisterFunctionDefinitionForType(EntityLuaBindings, HDFirearm) {
 	    .property("DeactivationDelay", &HDFirearm::GetDeactivationDelay, &HDFirearm::SetDeactivationDelay)
 	    .property("BaseReloadTime", &HDFirearm::GetBaseReloadTime, &HDFirearm::SetBaseReloadTime)
 	    .property("ReloadTime", &HDFirearm::GetReloadTime)
-	    .property("ReloadProgress", &HDFirearm::GetReloadProgress)
+	    .property("ReloadTimer", &HDFirearm::GetReloadTimer)
+	    .property("ReloadProgress", &HDFirearm::GetReloadProgress, &HDFirearm::SetReloadProgress)
 	    .property("ShakeRange", &HDFirearm::GetShakeRange, &HDFirearm::SetShakeRange)
 	    .property("SharpShakeRange", &HDFirearm::GetSharpShakeRange, &HDFirearm::SetSharpShakeRange)
 	    .property("NoSupportFactor", &HDFirearm::GetNoSupportFactor, &HDFirearm::SetNoSupportFactor)

Source/Lua/LuaBindingsSystem.cpp

@@ -146,8 +146,8 @@ LuaBindingRegisterFunctionDefinitionForType(SystemLuaBindings, Timer) {
 	    .property("StartSimTimeMS", &Timer::GetStartSimTimeMS, &Timer::SetStartSimTimeMS)
 	    .property("ElapsedSimTimeS", &Timer::GetElapsedSimTimeS, &Timer::SetElapsedSimTimeS)
 	    .property("ElapsedSimTimeMS", &Timer::GetElapsedSimTimeMS, &Timer::SetElapsedSimTimeMS)
-	    .property("RealTimeLimitProgress", &Timer::RealTimeLimitProgress)
-	    .property("SimTimeLimitProgress", &Timer::SimTimeLimitProgress)
+	    .property("RealTimeLimitProgress", &Timer::GetRealTimeLimitProgress, &Timer::SetRealTimeLimitProgress)
+	    .property("SimTimeLimitProgress", &Timer::GetSimTimeLimitProgress, &Timer::SetSimTimeLimitProgress)
 
 	    .def("Reset", &Timer::Reset)
 	    .def("SetRealTimeLimitMS", &Timer::SetRealTimeLimitMS)

Source/Menus/InventoryMenuGUI.cpp

@@ -469,7 +469,7 @@ void InventoryMenuGUI::UpdateCarouselMode() {
 void InventoryMenuGUI::UpdateCarouselItemBoxSizesAndPositions() {
 	float halfMassFontHeight = static_cast<float>(m_SmallFont->GetFontHeight() / 2);
 	int carouselIndex = 0;
-	float carouselAnimationProgress = static_cast<float>(m_CarouselAnimationTimer.RealTimeLimitProgress());
+	float carouselAnimationProgress = static_cast<float>(m_CarouselAnimationTimer.GetRealTimeLimitProgress());
 	float directionalAnimationProgress = carouselAnimationProgress * static_cast<float>(m_CarouselAnimationDirection);
 	float currentBoxHorizontalOffset = (directionalAnimationProgress <= 0 ? directionalAnimationProgress : -(1.0F - directionalAnimationProgress)) * m_CarouselExitingItemBox->FullSize.GetX();
 
@@ -1316,7 +1316,7 @@ void InventoryMenuGUI::DrawCarouselMode(BITMAP* targetBitmap, const Vector& draw
 	clear_to_color(m_CarouselBitmap.get(), g_MaskColor);
 	clear_to_color(m_CarouselBGBitmap.get(), g_MaskColor);
 	AllegroBitmap carouselAllegroBitmap(m_CarouselBitmap.get());
-	float enableDisableProgress = static_cast<float>(m_EnableDisableAnimationTimer.RealTimeLimitProgress());
+	float enableDisableProgress = static_cast<float>(m_EnableDisableAnimationTimer.GetRealTimeLimitProgress());
 
 	for (const std::unique_ptr<CarouselItemBox>& carouselItemBox: m_CarouselItemBoxes) {
 		if ((carouselItemBox->Item && carouselItemBox->Item->GetUniqueID() != 0) || (carouselItemBox->IsForEquippedItems && !m_InventoryActorEquippedItems.empty())) {
@@ -1428,7 +1428,7 @@ void InventoryMenuGUI::DrawFullMode(BITMAP* targetBitmap, const Vector& drawPos)
 	m_GUITopLevelBox->SetPositionAbs(drawPos.GetFloorIntX(), drawPos.GetFloorIntY());
 
 	if (IsEnablingOrDisabling()) {
-		float enableDisableProgress = static_cast<float>(m_EnableDisableAnimationTimer.RealTimeLimitProgress());
+		float enableDisableProgress = static_cast<float>(m_EnableDisableAnimationTimer.GetRealTimeLimitProgress());
 		if (m_EnabledState == EnabledState::Disabling) {
 			enableDisableProgress = 1.0F - enableDisableProgress;
 		}

Source/Menus/MetagameGUI.cpp

@@ -5535,7 +5535,7 @@ void MetagameGUI::UpdatePlayerBars() {
 			if (!m_apFundsChangeTimer[metaPlayer].IsPastRealTimeLimit()) {
 				// Animate downward if value is negative, upward if positive
 				int animDir = m_apFundsChangeLabel[metaPlayer]->GetText()[2] == '-' ? 1 : -1;
-				int heightChange = EaseOut(0, 25, m_apFundsChangeTimer[metaPlayer].RealTimeLimitProgress());
+				int heightChange = EaseOut(0, 25, m_apFundsChangeTimer[metaPlayer].GetRealTimeLimitProgress());
 				// Use the height of the label to keep track of the animation progress over several frames
 				m_apFundsChangeLabel[metaPlayer]->SetPositionAbs(m_apFundsChangeLabel[metaPlayer]->GetXPos(), m_apFundsChangeLabel[metaPlayer]->GetYPos() + animDir * (heightChange - m_apFundsChangeLabel[metaPlayer]->GetHeight() + 16));
 				m_apFundsChangeLabel[metaPlayer]->Resize(m_apFundsChangeLabel[metaPlayer]->GetWidth(), 16 + heightChange);
@@ -5551,7 +5551,7 @@ void MetagameGUI::UpdatePlayerBars() {
 			if (!m_apBrainsChangeTimer[metaPlayer].IsPastRealTimeLimit()) {
 				// Animate downward if value is negative, upward if positive
 				int animDir = m_apBrainChangeLabel[metaPlayer]->GetText()[1] == '-' ? 1 : -1;
-				int heightChange = EaseOut(0, 25, m_apBrainsChangeTimer[metaPlayer].RealTimeLimitProgress());
+				int heightChange = EaseOut(0, 25, m_apBrainsChangeTimer[metaPlayer].GetRealTimeLimitProgress());
 				// Use the height of the label to keep track of the animation progress over several frames
 				m_apBrainChangeLabel[metaPlayer]->SetPositionAbs(m_apBrainChangeLabel[metaPlayer]->GetXPos(), m_apBrainChangeLabel[metaPlayer]->GetYPos() + animDir * (heightChange - m_apBrainChangeLabel[metaPlayer]->GetHeight() + 16));
 				m_apBrainChangeLabel[metaPlayer]->Resize(m_apBrainChangeLabel[metaPlayer]->GetWidth(), 16 + heightChange);

Source/System/Timer.h

@@ -137,7 +137,12 @@ namespace RTE {
 		/// Returns how much progress has been made toward the set time limit previously set by SetRealTimeLimitMS.
 		/// 0 means no progress, 1.0 means the timer has reached, or is beyond the limit.
 		/// @return A normalized scalar between 0.0 - 1.0 showing the progress toward the limit.
-		double RealTimeLimitProgress() const { return (m_RealTimeLimit == 0) ? 1.0 : (std::min(1.0, GetElapsedRealTimeMS() / (m_RealTimeLimit / m_TicksPerMS))); }
+		double GetRealTimeLimitProgress() const { return (m_RealTimeLimit == 0) ? 1.0 : (std::min(1.0, GetElapsedRealTimeMS() / (m_RealTimeLimit / m_TicksPerMS))); }
+
+		/// Sets how much progress has been made toward the set time limit previously set by SetRealTimeLimitMS.
+		/// 0 means no progress, 1.0 means the timer is at the limit, greater is beyond the limit.
+		/// @param progress A normalized scalar between 0.0 - 1.0 of the progress toward the limit.
+		void SetRealTimeLimitProgress(double progress) { m_StartRealTime = g_TimerMan.GetSimTickCount() - static_cast<long long>(round(m_RealTimeLimit * progress)); }
 
 		/// Returns true or false, depending on whether the elapsed time falls in one of two repeating intervals which divide it.
 		/// This is useful for blink animations etc.
@@ -226,7 +231,12 @@ namespace RTE {
 		/// Returns how much progress has been made toward the set time limit previously set by SetSimTimeLimitMS.
 		/// 0 means no progress, 1.0 means the timer has reached, or is beyond the limit.
 		/// @return A normalized scalar between 0.0 - 1.0 showing the progress toward the limit.
-		double SimTimeLimitProgress() const { return (m_SimTimeLimit == 0) ? 1.0 : (std::min(1.0, GetElapsedSimTimeMS() / (m_SimTimeLimit / m_TicksPerMS))); }
+		double GetSimTimeLimitProgress() const { return (m_SimTimeLimit == 0) ? 1.0 : (std::min(1.0, GetElapsedSimTimeMS() / (m_SimTimeLimit / m_TicksPerMS))); }
+
+		/// Sets how much progress has been made toward the set time limit previously set by SetSimTimeLimitMS.
+		/// 0 means no progress, 1.0 means the timer is at the limit, greater is beyond the limit.
+		/// @param progress A normalized scalar between 0.0 - 1.0 of the progress toward the limit.
+		void SetSimTimeLimitProgress(double progress) { m_StartSimTime = g_TimerMan.GetSimTickCount() - static_cast <long long>(round(m_SimTimeLimit * progress)); }
 
 		/// Returns true or false, depending on whether the elapsed time falls in one of two repeating intervals which divide it.
 		/// This is useful for blink animations etc.