Renamed EffectDrawEveryFrame to PostEffectEnabled, made it INI and Lua readable, changed default to false outside of pixels and particles

Author: comradeshook

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,7 +20,7 @@ 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) now show on *any* `MovableObject` they're attached to; you may need to set `EffectAlwaysShows = 1` to see them. Try `InheritEffectRotAngle = 1` on a `MOSRotating`!
+- 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>
 

Source/Entities/AEmitter.cpp

@@ -339,7 +339,6 @@ void AEmitter::SetFlash(Attachable* newFlash) {
 		m_pFlash->SetInheritsRotAngle(false);
 		m_pFlash->SetDeleteWhenRemovedFromParent(true);
 		m_pFlash->SetCollidesWithTerrainWhileAttached(false);
-		m_pFlash->MovableObject::SetEffectDrawEveryFrame(false);
 	}
 }
 

Source/Entities/HDFirearm.cpp

@@ -407,7 +407,6 @@ void HDFirearm::SetFlash(Attachable* newFlash) {
 		m_pFlash->SetDrawnNormallyByParent(false);
 		m_pFlash->SetDeleteWhenRemovedFromParent(true);
 		m_pFlash->SetCollidesWithTerrainWhileAttached(false);
-		m_pFlash->MovableObject::SetEffectDrawEveryFrame(false);
 	}
 }
 

Source/Entities/MOPixel.cpp

@@ -24,6 +24,7 @@ void MOPixel::Clear() {
 	m_MaxLethalRange = 1;
 	m_LethalSharpness = 1;
 	m_Staininess = 0;
+	m_PostEffectEnabled = true;
 }
 
 int MOPixel::Create() {

Source/Entities/MOSParticle.cpp

@@ -20,6 +20,7 @@ MOSParticle::~MOSParticle() {
 void MOSParticle::Clear() {
 	m_Atom = nullptr;
 	m_SpriteAnimMode = OVERLIFETIME;
+	m_PostEffectEnabled = true;
 }
 
 int MOSParticle::Create() {

Source/Entities/MovableObject.cpp

@@ -97,7 +97,7 @@ void MovableObject::Clear() {
 	m_EffectStartStrength = 128;
 	m_EffectStopStrength = 128;
 	m_EffectAlwaysShows = false;
-	m_EffectDrawEveryFrame = true;
+	m_PostEffectEnabled = false;
 
 	m_UniqueID = 0;
 
@@ -221,6 +221,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) {
@@ -342,6 +343,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; });
@@ -447,6 +449,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");
@@ -895,7 +899,7 @@ void MovableObject::Update() {
 		m_EffectRotAngle = c_PI * 2.0F * RandomNormalNum();
 	}
 
-	if (m_pScreenEffect && m_EffectDrawEveryFrame) {
+	if (m_pScreenEffect && m_PostEffectEnabled) {
 		MovableObject::SetPostScreenEffectToDraw();
 	}
 }

Source/Entities/MovableObject.h

@@ -400,11 +400,11 @@ namespace RTE {
 
 		/// Gets whether or not this MovableObject's effect is drawn every frame.
 		/// @return Boolean indicating whether or not the effect is drawn.
-		bool GetEffectDrawEveryFrame() const { return m_EffectDrawEveryFrame; }
+		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 SetEffectDrawEveryFrame(bool newValue) { m_EffectDrawEveryFrame = newValue; }
+		void SetPostEffectEnabled(bool newValue) { m_PostEffectEnabled = newValue; }
 
 		/// Sets the current angular velocity of this MovableObject. Positive is
 		/// a counter clockwise rotation.
@@ -1240,7 +1240,7 @@ namespace RTE {
 		// 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_EffectDrawEveryFrame;
+		bool m_PostEffectEnabled;
 
 		// This object's unique persistent ID
 		long m_UniqueID;

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)