Merge branch 'development' into browncoat-mission

Author: Causeless

.github/workflows/nightly.yaml

@@ -127,7 +127,7 @@ jobs:
       - name: Update tag pointing to the previous nightly release
         if: steps.check_nightly.outputs.release_exists
         run: |
-          curl -X PATCH \
+          curl --fail-with-body -X PATCH \
             -H "Authorization: Bearer ${{ secrets.WORKFLOW_TOKEN }}" \
             -H "Accept: application/vnd.github.v3+json" \
             https://api.github.com/repos/${{ github.repository }}/git/refs/tags/${{ env.PREV_TAG }} \

CHANGELOG.md

@@ -8,21 +8,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 <details><summary><b>Added</b></summary>
 
-- New music system, including a dynamic horizontal sequencing system, under the new music manager `MusicMan`.
+- New music system, including a dynamic horizontal sequencing system, under the new music manager `MusicMan`.  
 	`PlayDynamicSong(string songName, string songSectionName, bool playImmediately, bool playTransition, bool smoothFade)` to play a new DynamicSong.
-	`SetNextDynamicSongSection(string songSectionName, bool playImmediately, bool playTransition, bool smoothFade)` to queue a new DynamicSongSection for the currently playing song.
-	`PlayInterruptingMusic(SoundContainer soundContainer)` to start an interrupting piece of music which will pause any playing DynamicSong. Note that pause menu music happily overrides this currently.
-	`EndInterruptingMusic()` to end any playing interrupting music, and resume any paused DynamicSongs.
-	`EndDynamicMusic(bool fadeOut)` to end any currently playing dynamic music, optionally immediately fading it out. If not fading it out, the currently playing piece will play to completion.
+	`SetNextDynamicSongSection(string songSectionName, bool playImmediately, bool playTransition, bool smoothFade)` to queue a new DynamicSongSection for the currently playing song.  
+	`PlayInterruptingMusic(SoundContainer soundContainer)` to start an interrupting piece of music which will pause any playing DynamicSong. Note that pause menu music happily overrides this currently.  
+	`EndInterruptingMusic()` to end any playing interrupting music, and resume any paused DynamicSongs.  
+	`EndDynamicMusic(bool fadeOut)` to end any currently playing dynamic music, optionally immediately fading it out. If not fading it out, the currently playing piece will play to completion.  
 	`ResetMusicState()` to immediately end all music and return the MusicMan to a blank state.
 
-- New entities `DynamicSongSection` and `DynamicSong` which are used for organizing music to play using the new system.
-	`DynamicSongSection` is made up of TransitionSoundContainers, SoundContainers, a string SectionType, and either randomnorepeat or shuffle SoundContainerSelectionCycleMode.
+- New entities `DynamicSongSection` and `DynamicSong` which are used for organizing music to play using the new system.  
+	`DynamicSongSection` is made up of TransitionSoundContainers, SoundContainers, a string SectionType, and either randomnorepeat or shuffle SoundContainerSelectionCycleMode.  
 	`DynamicSong` is a simple container of DynamicSongSections. It can have one DefaultSongSection and as many added sections as needed.
 
-- New `SoundContainer` features.
-		Lua property `Paused` (R/W) to pause or unpause all sounds of a SoundContainer. Newly played sounds will not begin playback until unpaused.
-		Lua function `GetAudibleVolume` to get the real audible volume of a SoundContainer's sounds as a float from 0 to 1. This accounts for literally everything, including game volume.
+- New `SoundContainer` features.  
+	Lua property `Paused` (R/W) to pause or unpause all sounds of a SoundContainer. Newly played sounds will not begin playback until unpaused.  
+	Lua function `GetAudibleVolume` to get the real audible volume of a SoundContainer's sounds as a float from 0 to 1. This accounts for literally everything, including game volume.
+
+- Allow lua scripts to use LuaJIT's BitOp module (see https://bitop.luajit.org/api.html)
 
 </details>
 
@@ -33,18 +35,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - All music-related functionality from AudioMan has been removed due to the addition of the MusicMan. Generic DynamicSongs have been put in to use instead.
 	Mod activities that used to queue up all the vanilla music should now instead call, for example, `MusicMan:PlayDynamicSong("Generic Battle Music")`
 
-- Increased fog of war resolution in all vanilla activities, and conquest, from 20x20 to 4x4.
-	The Ronin Scrambler, the basic scanner, and `SceneMan:CastUnseenRay` have been changed to accomodate fog of war resolutions as fine as 1x1 and as course as 20x20.
+- Increased fog-of-war resolution in all vanilla activities, and conquest, from 20x20 to 4x4.
+	The Ronin Scrambler, the basic scanner, and `SceneMan:CastUnseenRay` have been changed to accomodate fog-of-war resolutions as fine as 1x1 and as course as 20x20.
+	The fog-of-war revealing code is now multithreaded to increase performance.
 
 - All vanilla scenario activities have had their settings polished, respecting settings which make sense and disabling settings which don't.
 	You can now have fog of war in the test scene, and can no longer require path to orbit in Zero-G Diggers-Only One Man Army.
 
 - The Signal Hunt activity no longer has a preview image, as it was not formatted correctly and spoiled the interior structure of the cave.
 
+- `MovableObject`'s `UniqueID` and `Age` fields are now persisted through game save/load.
+
 </details>
 
 <details><summary><b>Fixed</b></summary>
 
+- Fixed a crash on launch that could occur depending on what Microsoft Visual C++ Redistributable the user has installed.
+
 - Fixed an issue where palette index 255 was incorrectly showing as black.
 
 - Fixed instances of `CameraMan:GetScrollTarget()` and `CameraMan:SetScrollTarget()` supplying a player index instead of a screen index. This could prevent the functions from working properly, or at all, when playing as a player other than 1, potentially screwing up camera effects.

Source/Entities/DynamicSong.cpp

@@ -128,77 +128,79 @@ SoundContainer& DynamicSongSection::SelectTransitionSoundContainer() {
 	if (m_TransitionSoundContainers.empty()) {
 		return SelectSoundContainer();
 	}
-	if (m_TransitionSoundContainers.size() == 1) {
-		return m_TransitionSoundContainers[0];
-	}
 
-	if (m_TransitionShuffleUnplayedIndices.empty()) {
-		for (unsigned int i = 0; i < m_TransitionSoundContainers.size(); i++) {
-			if (i != m_LastTransitionSoundContainerIndex) {
-				m_TransitionShuffleUnplayedIndices.push_back(i);
-			}
-		}
-	}
-
-	switch (m_SoundContainerSelectionCycleMode) {
-		case RANDOMNOREPEAT: {
-			std::vector<unsigned int> validIndices;
+	// Shuffle between our options if we have multiple
+	if (m_TransitionSoundContainers.size() > 1) {
+		if (m_TransitionShuffleUnplayedIndices.empty()) {
 			for (unsigned int i = 0; i < m_TransitionSoundContainers.size(); i++) {
 				if (i != m_LastTransitionSoundContainerIndex) {
-					validIndices.push_back(i);
+					m_TransitionShuffleUnplayedIndices.push_back(i);
 				}
 			}
-
-			unsigned int randomIndex = validIndices[RandomNum(0, static_cast<int>(validIndices.size()) - 1)];
-			m_LastTransitionSoundContainerIndex = randomIndex;
-			return m_TransitionSoundContainers[randomIndex];
-		}
-		case SHUFFLE: {
-			unsigned int randomSelection = RandomNum(0, static_cast<int>(m_TransitionShuffleUnplayedIndices.size() - 1));
-			unsigned int selectedIndex = m_TransitionShuffleUnplayedIndices[randomSelection];
-			m_TransitionShuffleUnplayedIndices.erase(m_TransitionShuffleUnplayedIndices.begin() + randomSelection);
-			m_LastTransitionSoundContainerIndex = selectedIndex;
-			return m_TransitionSoundContainers[selectedIndex];
 		}
-	}
-}
-
-SoundContainer& DynamicSongSection::SelectSoundContainer() {
-	RTEAssert(!m_SoundContainers.empty(), "Tried to get a SoundContainer from a DynamicSongSection with none to choose from!");
 
-	if (m_SoundContainers.size() == 1) {
-		return m_SoundContainers[0];
-	}
+		switch (m_SoundContainerSelectionCycleMode) {
+			case RANDOMNOREPEAT: {
+				std::vector<unsigned int> validIndices;
+				for (unsigned int i = 0; i < m_TransitionSoundContainers.size(); i++) {
+					if (i != m_LastTransitionSoundContainerIndex) {
+						validIndices.push_back(i);
+					}
+				}
 
-	if (m_ShuffleUnplayedIndices.empty()) {
-		for (unsigned int i = 0; i < m_SoundContainers.size(); i++) {
-			if (i != m_LastSoundContainerIndex) {
-				m_ShuffleUnplayedIndices.push_back(i);
+				unsigned int randomIndex = validIndices[RandomNum(0, static_cast<int>(validIndices.size()) - 1)];
+				m_LastTransitionSoundContainerIndex = randomIndex;
+				return m_TransitionSoundContainers[randomIndex];
+			}
+			case SHUFFLE: {
+				unsigned int randomSelection = RandomNum(0, static_cast<int>(m_TransitionShuffleUnplayedIndices.size() - 1));
+				unsigned int selectedIndex = m_TransitionShuffleUnplayedIndices[randomSelection];
+				m_TransitionShuffleUnplayedIndices.erase(m_TransitionShuffleUnplayedIndices.begin() + randomSelection);
+				m_LastTransitionSoundContainerIndex = selectedIndex;
+				return m_TransitionSoundContainers[selectedIndex];
 			}
 		}
 	}
 
-	switch (m_SoundContainerSelectionCycleMode) {
-		case RANDOMNOREPEAT: {
-			std::vector<unsigned int> validIndices;
+	return m_TransitionSoundContainers[0];
+}
+
+SoundContainer& DynamicSongSection::SelectSoundContainer() {
+	// Shuffle between our options if we have multiple
+	if (m_SoundContainers.size() != 1) {
+		if (m_ShuffleUnplayedIndices.empty()) {
 			for (unsigned int i = 0; i < m_SoundContainers.size(); i++) {
 				if (i != m_LastSoundContainerIndex) {
-					validIndices.push_back(i);
+					m_ShuffleUnplayedIndices.push_back(i);
 				}
 			}
-
-			unsigned int randomIndex = validIndices[RandomNum(0, static_cast<int>(validIndices.size()) - 1)];
-			m_LastSoundContainerIndex = randomIndex;
-			return m_SoundContainers[randomIndex];
 		}
-		case SHUFFLE: {
-			unsigned int randomSelection = RandomNum(0, static_cast<int>(m_ShuffleUnplayedIndices.size() - 1));
-			unsigned int selectedIndex = m_ShuffleUnplayedIndices[randomSelection];
-			m_ShuffleUnplayedIndices.erase(m_ShuffleUnplayedIndices.begin() + randomSelection);
-			m_LastSoundContainerIndex = selectedIndex;
-			return m_SoundContainers[selectedIndex];
+
+		switch (m_SoundContainerSelectionCycleMode) {
+			case RANDOMNOREPEAT: {
+				std::vector<unsigned int> validIndices;
+				for (unsigned int i = 0; i < m_SoundContainers.size(); i++) {
+					if (i != m_LastSoundContainerIndex) {
+						validIndices.push_back(i);
+					}
+				}
+
+				unsigned int randomIndex = validIndices[RandomNum(0, static_cast<int>(validIndices.size()) - 1)];
+				m_LastSoundContainerIndex = randomIndex;
+				return m_SoundContainers[randomIndex];
+			}
+			case SHUFFLE: {
+				unsigned int randomSelection = RandomNum(0, static_cast<int>(m_ShuffleUnplayedIndices.size() - 1));
+				unsigned int selectedIndex = m_ShuffleUnplayedIndices[randomSelection];
+				m_ShuffleUnplayedIndices.erase(m_ShuffleUnplayedIndices.begin() + randomSelection);
+				m_LastSoundContainerIndex = selectedIndex;
+				return m_SoundContainers[selectedIndex];
+			}
 		}
 	}
+
+	RTEAssert(!m_SoundContainers.empty(), "Tried to get a SoundContainer from a DynamicSongSection with none to choose from!");
+	return m_SoundContainers[0];
 }
 
 DynamicSong::DynamicSong() {

Source/Entities/MovableObject.cpp

@@ -23,7 +23,6 @@ using namespace RTE;
 
 AbstractClassInfo(MovableObject, SceneObject);
 
-std::atomic<long> MovableObject::m_UniqueIDCounter = 1;
 std::string MovableObject::ms_EmptyString = "";
 
 MovableObject::MovableObject() {
@@ -138,17 +137,21 @@ LuaStateWrapper& MovableObject::GetAndLockStateForScript(const std::string& scri
 }
 
 int MovableObject::Create() {
-	if (SceneObject::Create() < 0)
+	if (SceneObject::Create() < 0) {
 		return -1;
+	}
 
-	m_AgeTimer.Reset();
 	m_RestTimer.Reset();
 
 	// If the stop time hasn't been assigned, just make the same as the life time.
-	if (m_EffectStopTime <= 0)
+	if (m_EffectStopTime <= 0) {
 		m_EffectStopTime = m_Lifetime;
+	}
 
-	m_UniqueID = MovableObject::GetNextUniqueID();
+	if (m_UniqueID == 0) {
+		m_UniqueID = g_MovableMan.GetNextUniqueID();
+		m_AgeTimer.Reset();
+	}
 
 	m_MOIDHit = g_NoMOID;
 	m_TerrainMatHit = g_MaterialAir;
@@ -177,7 +180,7 @@ int MovableObject::Create(const float mass,
 	m_HitsMOs = hitMOs;
 	m_GetsHitByMOs = getHitByMOs;
 
-	m_UniqueID = MovableObject::GetNextUniqueID();
+	m_UniqueID = g_MovableMan.GetNextUniqueID();
 
 	m_MOIDHit = g_NoMOID;
 	m_TerrainMatHit = g_MaterialAir;
@@ -203,9 +206,6 @@ int MovableObject::Create(const MovableObject& reference) {
 	m_RestThreshold = reference.m_RestThreshold;
 	//    m_Force = reference.m_Force;
 	//    m_ImpulseForce = reference.m_ImpulseForce;
-	// Should reset age instead??
-	//    m_AgeTimer = reference.m_AgeTimer;
-	m_AgeTimer.Reset();
 	m_RestTimer.Reset();
 	m_Lifetime = reference.m_Lifetime;
 	m_Sharpness = reference.m_Sharpness;
@@ -266,7 +266,17 @@ int MovableObject::Create(const MovableObject& reference) {
 	m_NumberValueMap = reference.m_NumberValueMap;
 	m_ObjectValueMap = reference.m_ObjectValueMap;
 
-	m_UniqueID = MovableObject::GetNextUniqueID();
+	// If we have a -1 unique ID, then we're currently performing a game save or load
+	// In this case, we actually want to persist our existing IDs
+	if (g_MovableMan.ShouldPersistUniqueIDs()) {
+		m_UniqueID = reference.m_UniqueID;
+		m_AgeTimer = reference.m_AgeTimer;
+	} else {
+		// Otherwise we're copying from a preset normally and ought to create a new object
+		m_UniqueID = g_MovableMan.GetNextUniqueID();
+		m_AgeTimer.Reset();
+	}
+
 	g_MovableMan.RegisterObject(this);
 
 	return 0;
@@ -374,6 +384,11 @@ int MovableObject::ReadProperty(const std::string_view& propName, Reader& reader
 	MatchProperty("SimUpdatesBetweenScriptedUpdates", { reader >> m_SimUpdatesBetweenScriptedUpdates; });
 	MatchProperty("AddCustomValue", { ReadCustomValueProperty(reader); });
 	MatchProperty("ForceIntoMasterLuaState", { reader >> m_ForceIntoMasterLuaState; });
+	MatchProperty("SpecialBehaviour_SetUniqueID", {
+		long oldID = m_UniqueID;
+		reader >> m_UniqueID;
+		g_MovableMan.ReregisterObjectIfApplicable(this, oldID);
+	});
 
 	EndPropertyList;
 }

Source/Entities/MovableObject.h

@@ -979,10 +979,6 @@ namespace RTE {
 		/// @param newRestThreshold New rest threshold value
 		void SetRestThreshold(int newRestThreshold) { m_RestThreshold = newRestThreshold; }
 
-		/// Returns the next unique id for MO's and increments unique ID counter
-		/// @return Returns the next unique id.
-		static long GetNextUniqueID() { return ++m_UniqueIDCounter; }
-
 		/// Returns this MO's unique persistent ID
 		/// @return Returns this MO's unique persistent ID
 		long GetUniqueID() const { return m_UniqueID; }
@@ -1139,8 +1135,7 @@ namespace RTE {
 		/// @param A MovableObject object which is passed in by reference.
 		// Member variables
 		static Entity::ClassInfo m_sClass;
-		// Global counter with unique ID's
-		static std::atomic<long> m_UniqueIDCounter;
+
 		// The type of MO this is, either Actor, Item, or Particle
 		int m_MOType;
 		float m_Mass; // In metric kilograms (kg).

Source/Entities/Scene.cpp

@@ -1172,6 +1172,7 @@ void Scene::SaveSceneObject(Writer& writer, const SceneObject* sceneObjectToSave
 		writer.NewPropertyWithValue("LifeTime", movableObjectToSave->GetLifetime());
 		writer.NewPropertyWithValue("Age", movableObjectToSave->GetAge());
 		writer.NewPropertyWithValue("PinStrength", movableObjectToSave->GetPinStrength());
+		writer.NewPropertyWithValue("SpecialBehaviour_SetUniqueID", movableObjectToSave->GetUniqueID());
 	}
 
 	if (const MOSprite* moSpriteToSave = dynamic_cast<const MOSprite*>(sceneObjectToSave)) {

Source/GUI/GUIReader.cpp

@@ -359,6 +359,12 @@ GUIReader& GUIReader::operator>>(unsigned long& var) {
 	return *this;
 }
 
+GUIReader& GUIReader::operator>>(long long& var) {
+	DiscardEmptySpace();
+	*m_Stream >> var;
+	return *this;
+}
+
 // Yeah, this is dumb - read as double and cast.
 // This is because, for whatever fucking reason, iostream can save out floats at a precision that it's then unable to read...
 GUIReader& GUIReader::operator>>(float& var) {

Source/GUI/GUIReader.h

@@ -92,6 +92,7 @@ namespace RTE {
 		GUIReader& operator>>(unsigned int& var);
 		GUIReader& operator>>(long& var);
 		GUIReader& operator>>(unsigned long& var);
+		GUIReader& operator>>(long long& var);
 		GUIReader& operator>>(float& var);
 		GUIReader& operator>>(double& var);
 		GUIReader& operator>>(std::string& var);

Source/Main.cpp

@@ -245,6 +245,7 @@ void PollSDLEvents() {
 void RunMenuLoop() {
 	g_UInputMan.DisableKeys(false);
 	g_UInputMan.TrapMousePos(false);
+	g_TimerMan.PauseSim(true);
 
 	while (!System::IsSetToQuit()) {
 		g_WindowMan.ClearRenderer();