Merge branch 'development' into code-cleanup

Author: Causeless

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+<details><summary><b>Added</b></summary>
+
+- New `MovableObject` INI and Lua property `PostEffectEnabled` (R/W), which determines whether or not the screen effect of an MO is enabled. Defaults to `true` for `MOPixels` and `MOSParticles`, `false` for everything else (to avoid backwards compatibility issues).
+
+</details>
+
 <details><summary><b>Changed</b></summary>
 
 - Massacre now displays the remaining kill count to each player's screen instead of just the first one.
@@ -14,6 +20,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Improvements to AI navigation in automovers, so they get stuck less often.
 
+- Screen effects (glows) can now show on *any* `MovableObject` they're attached to; you may need to set `EffectAlwaysShows = 1` to see them on `MOSRotatings`. Try `InheritEffectRotAngle = 1` on one of them!
+
 </details>
 
 <details><summary><b>Fixed</b></summary>

Source/Entities/MOPixel.cpp

@@ -24,6 +24,7 @@ void MOPixel::Clear() {
 	m_MaxLethalRange = 1;
 	m_LethalSharpness = 1;
 	m_Staininess = 0;
+	m_PostEffectEnabled = true; // Default to true for backwards compatibility reasons
 }
 
 int MOPixel::Create() {
@@ -218,10 +219,6 @@ void MOPixel::Update() {
 			}
 		}
 	}
-
-	if (m_pScreenEffect) {
-		SetPostScreenEffectToDraw();
-	}
 }
 
 void MOPixel::Draw(BITMAP* targetBitmap, const Vector& targetPos, DrawMode mode, bool onlyPhysical) const {
@@ -248,11 +245,3 @@ void MOPixel::Draw(BITMAP* targetBitmap, const Vector& targetPos, DrawMode mode,
 
 	g_SceneMan.RegisterDrawing(targetBitmap, m_MOID, pixelPos, 1.0F);
 }
-
-void MOPixel::SetPostScreenEffectToDraw() const {
-	if (m_AgeTimer.GetElapsedSimTimeMS() >= m_EffectStartTime && (m_EffectStopTime == 0 || !m_AgeTimer.IsPastSimMS(m_EffectStopTime))) {
-		if (m_EffectAlwaysShows || !g_SceneMan.ObscuredPoint(m_Pos.GetFloorIntX(), m_Pos.GetFloorIntY())) {
-			g_PostProcessMan.RegisterPostEffect(m_Pos, m_pScreenEffect, m_ScreenEffectHash, LERP(m_EffectStartTime, m_EffectStopTime, m_EffectStartStrength, m_EffectStopStrength, m_AgeTimer.GetElapsedSimTimeMS()), m_EffectRotAngle);
-		}
-	}
-}

Source/Entities/MOPixel.h

@@ -176,9 +176,6 @@ namespace RTE {
 		float m_Staininess; //!< How likely a pixel is to stain a surface when it collides with it. Defaults to 0 (never stain).
 
 	private:
-		/// Sets the screen effect to draw at the final post-processing stage.
-		void SetPostScreenEffectToDraw() const;
-
 		/// Clears all the member variables of this MOPixel, effectively resetting the members of this abstraction level only.
 		void Clear();
 	};

Source/Entities/MOSParticle.cpp

@@ -20,6 +20,7 @@ MOSParticle::~MOSParticle() {
 void MOSParticle::Clear() {
 	m_Atom = nullptr;
 	m_SpriteAnimMode = OVERLIFETIME;
+	m_PostEffectEnabled = true; // Default to true for backwards compatibility reasons
 }
 
 int MOSParticle::Create() {
@@ -147,10 +148,6 @@ void MOSParticle::Travel() {
 
 void MOSParticle::Update() {
 	MOSprite::Update();
-
-	if (m_pScreenEffect) {
-		SetPostScreenEffectToDraw();
-	}
 }
 
 void MOSParticle::Draw(BITMAP* targetBitmap, const Vector& targetPos, DrawMode mode, bool onlyPhysical) const {
@@ -220,11 +217,3 @@ void MOSParticle::Draw(BITMAP* targetBitmap, const Vector& targetPos, DrawMode m
 		g_SceneMan.RegisterDrawing(targetBitmap, m_MOID, spriteX, spriteY, spriteX + m_aSprite[m_Frame]->w, spriteY + m_aSprite[m_Frame]->h);
 	}
 }
-
-void MOSParticle::SetPostScreenEffectToDraw() const {
-	if (m_AgeTimer.GetElapsedSimTimeMS() >= m_EffectStartTime && (m_EffectStopTime == 0 || !m_AgeTimer.IsPastSimMS(m_EffectStopTime))) {
-		if (m_EffectAlwaysShows || !g_SceneMan.ObscuredPoint(m_Pos.GetFloorIntX(), m_Pos.GetFloorIntY())) {
-			g_PostProcessMan.RegisterPostEffect(m_Pos, m_pScreenEffect, m_ScreenEffectHash, LERP(m_EffectStartTime, m_EffectStopTime, m_EffectStartStrength, m_EffectStopStrength, m_AgeTimer.GetElapsedSimTimeMS()), m_EffectRotAngle);
-		}
-	}
-}

Source/Entities/MOSParticle.h

@@ -115,9 +115,6 @@ namespace RTE {
 		float m_TimeRest; //!< Accumulated time in seconds that did not cause a frame change.
 
 	private:
-		/// Sets the screen effect to draw at the final post-processing stage.
-		void SetPostScreenEffectToDraw() const;
-
 		/// Clears all the member variables of this MOSParticle, effectively resetting the members of this abstraction level only.
 		void Clear();
 

Source/Entities/MovableObject.cpp

@@ -12,6 +12,7 @@
 #include "PieMenu.h"
 #include "Serializable.h"
 #include "System.h"
+#include "PostProcessMan.h"
 
 #include "Base64/base64.h"
 #include "tracy/Tracy.hpp"
@@ -97,6 +98,7 @@ void MovableObject::Clear() {
 	m_EffectStartStrength = 128;
 	m_EffectStopStrength = 128;
 	m_EffectAlwaysShows = false;
+	m_PostEffectEnabled = false;
 
 	m_UniqueID = 0;
 
@@ -220,6 +222,7 @@ int MovableObject::Create(const MovableObject& reference) {
 	m_MissionCritical = reference.m_MissionCritical;
 	m_CanBeSquished = reference.m_CanBeSquished;
 	m_HUDVisible = reference.m_HUDVisible;
+	m_PostEffectEnabled = reference.m_PostEffectEnabled;
 
 	m_ForceIntoMasterLuaState = reference.m_ForceIntoMasterLuaState;
 	for (auto& [scriptPath, scriptEnabled]: reference.m_AllLoadedScripts) {
@@ -341,6 +344,7 @@ int MovableObject::ReadProperty(const std::string_view& propName, Reader& reader
 		m_pScreenEffect = m_ScreenEffectFile.GetAsBitmap();
 		m_ScreenEffectHash = m_ScreenEffectFile.GetHash();
 	});
+	MatchProperty("PostEffectEnabled", { reader >> m_PostEffectEnabled; });
 	MatchProperty("EffectStartTime", { reader >> m_EffectStartTime; });
 	MatchProperty("EffectRotAngle", { reader >> m_EffectRotAngle; });
 	MatchProperty("InheritEffectRotAngle", { reader >> m_InheritEffectRotAngle; });
@@ -446,6 +450,8 @@ int MovableObject::Save(Writer& writer) const {
 	}
 	writer.NewProperty("ScreenEffect");
 	writer << m_ScreenEffectFile;
+	writer.NewProperty("PostEffectEnabled");
+	writer << m_PostEffectEnabled;
 	writer.NewProperty("EffectStartTime");
 	writer << m_EffectStartTime;
 	writer.NewProperty("EffectStopTime");
@@ -883,6 +889,10 @@ void MovableObject::Update() {
 	if (m_RandomizeEffectRotAngleEveryFrame) {
 		m_EffectRotAngle = c_PI * 2.0F * RandomNormalNum();
 	}
+
+	if (m_pScreenEffect && m_PostEffectEnabled) {
+		SetPostScreenEffectToDraw();
+	}
 }
 
 void MovableObject::Draw(BITMAP* targetBitmap, const Vector& targetPos, DrawMode mode, bool onlyPhysical) const {
@@ -1111,3 +1121,11 @@ bool MovableObject::DrawToTerrain(SLTerrain* terrain) {
 	}
 	return true;
 }
+
+void MovableObject::SetPostScreenEffectToDraw() const {
+	if (m_AgeTimer.GetElapsedSimTimeMS() >= m_EffectStartTime && (m_EffectStopTime == 0 || !m_AgeTimer.IsPastSimMS(m_EffectStopTime))) {
+		if (m_EffectAlwaysShows || !g_SceneMan.ObscuredPoint(m_Pos.GetFloorIntX(), m_Pos.GetFloorIntY())) {
+			g_PostProcessMan.RegisterPostEffect(m_Pos, m_pScreenEffect, m_ScreenEffectHash, LERP(m_EffectStartTime, m_EffectStopTime, m_EffectStartStrength, m_EffectStopStrength, m_AgeTimer.GetElapsedSimTimeMS()), m_EffectRotAngle);
+		}
+	}
+}

Source/Entities/MovableObject.h

@@ -397,6 +397,14 @@ namespace RTE {
 		/// @return The stopping strength of the effect, 0-255.
 		int GetEffectStopStrength() const { return m_EffectStopStrength; }
 
+		/// Gets whether or not this MovableObject's effect is drawn every frame.
+		/// @return Boolean indicating whether or not the effect is drawn.
+		bool GetPostEffectEnabled() const { return m_PostEffectEnabled; }
+
+		/// Sets whether or not to draw this MovableObject's effect every frame.
+		/// @param Boolean indicating whether or not to draw the effect.
+		void SetPostEffectEnabled(bool newValue) { m_PostEffectEnabled = newValue; }
+
 		/// Sets the current angular velocity of this MovableObject. Positive is
 		/// a counter clockwise rotation.
 		/// @param newRotVel The new angular velocity in radians per second.
@@ -1221,6 +1229,8 @@ namespace RTE {
 		bool m_RandomizeEffectRotAngle;
 		// Whether effects rot angle should be randomized every frame
 		bool m_RandomizeEffectRotAngleEveryFrame;
+		// Whether or not to draw the effect every frame; used for flashes
+		bool m_PostEffectEnabled;
 
 		// This object's unique persistent ID
 		long m_UniqueID;
@@ -1271,6 +1281,9 @@ namespace RTE {
 		// Disallow the use of some implicit methods.
 		MovableObject(const MovableObject& reference) = delete;
 		MovableObject& operator=(const MovableObject& ref) = delete;
+
+		/// Sets the screen effect to draw at the final post-processing stage.
+		void SetPostScreenEffectToDraw() const;
 	};
 
 } // namespace RTE

Source/Lua/LuaBindingsEntities.cpp

@@ -921,6 +921,7 @@ LuaBindingRegisterFunctionDefinitionForType(EntityLuaBindings, MovableObject) {
 	    .property("ApplyWoundDamageOnCollision", &MovableObject::GetApplyWoundDamageOnCollision, &MovableObject::SetApplyWoundDamageOnCollision)
 	    .property("ApplyWoundBurstDamageOnCollision", &MovableObject::GetApplyWoundBurstDamageOnCollision, &MovableObject::SetApplyWoundBurstDamageOnCollision)
 	    .property("SimUpdatesBetweenScriptedUpdates", &MovableObject::GetSimUpdatesBetweenScriptedUpdates, &MovableObject::SetSimUpdatesBetweenScriptedUpdates)
+	    .property("PostEffectEnabled", &MovableObject::GetPostEffectEnabled, &MovableObject::SetPostEffectEnabled)
 
 	    .def("GetParent", (MOSRotating * (MovableObject::*)()) & MovableObject::GetParent)
 	    .def("GetParent", (const MOSRotating* (MovableObject::*)() const) & MovableObject::GetParent)