Merge branch 'development' into tracy-fixes

Author: HeliumAnt

.gitignore

@@ -8,13 +8,16 @@
 *.APS
 *.user
 
+/.idea
+
 compile_commands.json
 /.ccls-cache
 
 /build*
 
 /enc_temp_folder
 
+/.idea
 /_Bin
 /NATPunchServer/Server/NATCompleteServer/Debug
 /NATPunchServer/Server/NATCompleteServer/Release

Activities/GAScripted.cpp

@@ -138,8 +138,8 @@ int GAScripted::ReadProperty(const std::string_view &propName, Reader &reader) {
 //                  later recreation with Create(Reader &reader);
 
 int GAScripted::Save(Writer &writer) const {
-    // Call the script OnSave() function, if it exists
-    g_LuaMan.GetMasterScriptState().RunScriptString("if " + m_LuaClassName + " and " + m_LuaClassName + ".OnSave then " + m_LuaClassName + ":OnSave(); end");
+    // Hmm. We should probably be calling this prior to the writer Save, instead of const-casting.
+    const_cast<GAScripted*>(this)->RunLuaFunction("OnSave");
 
     GameActivity::Save(writer);
 
@@ -184,63 +184,50 @@ void GAScripted::Destroy(bool notInherited) {
 //                  spawned will use the new scripts.
 
 int GAScripted::ReloadScripts() {
-    int error = 0;
+    if (m_ScriptPath.empty()) {
+        return 0;
+    }
 
-    // Read in the Lua script function definitions for this preset
-    if (!m_ScriptPath.empty()) {
-        // Get the required Area:s from the new script
-        CollectRequiredAreas();
-
-        // If it hasn't been yet, run the file that specifies the Lua functions for this' operating logic (including the scene test function)
-        if (!g_LuaMan.GetMasterScriptState().GlobalIsDefined(m_LuaClassName)) {
-            // Temporarily store this Activity so the Lua state can access it
-            g_LuaMan.GetMasterScriptState().SetTempEntity(this);
-            // Define the var that will hold the script file definitions
-            if ((error = g_LuaMan.GetMasterScriptState().RunScriptString(m_LuaClassName + " = ToGameActivity(LuaMan.TempEntity);")) < 0) {
-                return error;
-            }
-        }
+    int error = 0;
+    CollectRequiredAreas();
 
-        // Load and run the file, defining all the scripted functions of this Activity
-        if ((error = g_LuaMan.GetMasterScriptState().RunScriptFile(m_ScriptPath)) < 0) {
+    // If it hasn't been yet, run the file that specifies the Lua functions for this' operating logic (including the scene test function)
+    if (!g_LuaMan.GetMasterScriptState().GlobalIsDefined(m_LuaClassName)) {
+        // Temporarily store this Activity so the Lua state can access it
+        g_LuaMan.GetMasterScriptState().SetTempEntity(this);
+        
+        // Define the var that will hold the script file definitions
+        if ((error = g_LuaMan.GetMasterScriptState().RunScriptString(m_LuaClassName + " = ToGameActivity(LuaMan.TempEntity);")) < 0) {
             return error;
         }
     }
 
-    return error;
+    std::string luaClearSupportedFunctionsString;
+    for (const std::string& functionName : GetSupportedScriptFunctionNames()) {
+        luaClearSupportedFunctionsString += m_LuaClassName + "." + functionName + " = nil; ";
+    }
+
+    if ((error = g_LuaMan.GetMasterScriptState().RunScriptString(luaClearSupportedFunctionsString)) < 0) {
+        return error;
+    }
+
+    std::unordered_map<std::string, LuabindObjectWrapper*> scriptFileFunctions;
+    if ((error = g_LuaMan.GetMasterScriptState().RunScriptFileAndRetrieveFunctions(m_ScriptPath, m_LuaClassName, GetSupportedScriptFunctionNames(), scriptFileFunctions)) < 0) {
+        return error;
+    }
+
+    m_ScriptFunctions.clear();
+    for (const auto& [functionName, functionObject] : scriptFileFunctions) {
+        m_ScriptFunctions[functionName] = std::unique_ptr<LuabindObjectWrapper>(functionObject);
+    }
+
+    return 0;
 }
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 bool GAScripted::HasSaveFunction() const {
-	//TODO this method is complicated and manually parsing lua like this sucks. It should be replaceable with a simple check if the function exists in Lua, but it wasn't working when I tried so I just copied this from SceneIsCompatible.
-	std::ifstream scriptInputFileStream(m_ScriptPath);
-	if (scriptInputFileStream.good()) {
-		std::string::size_type commentPos;
-		bool inBlockComment = false;
-		while (!scriptInputFileStream.eof()) {
-			char rawLine[512];
-			scriptInputFileStream.getline(rawLine, 512);
-			std::string currentLine(rawLine);
-
-			if (!inBlockComment) {
-				commentPos = currentLine.find("--[[", 0);
-				inBlockComment = commentPos != std::string::npos;
-			}
-			if (inBlockComment) {
-				commentPos = currentLine.find("]]", commentPos == std::string::npos ? 0 : commentPos);
-				inBlockComment = commentPos != std::string::npos;
-			}
-			if (!inBlockComment) {
-				commentPos = currentLine.find("--", 0);
-				std::string::size_type foundTextPos = currentLine.find("OnSave");
-				if (foundTextPos != std::string::npos && foundTextPos < commentPos) {
-					return true;
-				}
-			}
-		}
-	}
-	return false;
+    return m_ScriptFunctions.find("OnSave") != m_ScriptFunctions.end();
 }
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -329,12 +316,12 @@ int GAScripted::Start() {
     }
 
     // Run the file that specifies the Lua functions for this' operating logic
-    if ((error = g_LuaMan.GetMasterScriptState().RunScriptFile(m_ScriptPath)) < 0) {
+    if ((error = ReloadScripts()) < 0) {
         return error;
     }
 
-    // Call the defined function, but only after first checking if it exists
-    if ((error = g_LuaMan.GetMasterScriptState().RunScriptString("if " + m_LuaClassName + ".StartActivity then " + m_LuaClassName + ":StartActivity( " + (initialActivityState == ActivityState::NotStarted ? "true" : "false") + "); end")) < 0) {
+    // Call the create function
+    if ((error = RunLuaFunction("StartActivity", {}, { initialActivityState == ActivityState::NotStarted ? "true" : "false" }, {})) < 0) {
         return error;
     }
 
@@ -377,8 +364,7 @@ int GAScripted::Start() {
 void GAScripted::SetPaused(bool pause) {
     GameActivity::SetPaused(pause);
 
-    // Call the defined function, but only after first checking if it exists
-    g_LuaMan.GetMasterScriptState().RunScriptString("if " + m_LuaClassName + ".PauseActivity then " + m_LuaClassName + ":PauseActivity(" + (pause ? "true" : "false") + "); end");
+    RunLuaFunction("PauseActivity", {}, { pause ? "true" : "false" }, {});
 
 	// Pause all global scripts
 	for (std::vector<GlobalScript *>::iterator sItr = m_GlobalScriptsList.begin(); sItr < m_GlobalScriptsList.end(); ++sItr) {
@@ -397,9 +383,7 @@ void GAScripted::SetPaused(bool pause) {
 void GAScripted::End() {
     GameActivity::End();
 
-    // Call the defined function, but only after first checking if it exists
-    g_LuaMan.GetMasterScriptState().RunScriptString("if " + m_LuaClassName + ".EndActivity then " + m_LuaClassName + ":EndActivity(); end");
-
+    RunLuaFunction("EndActivity");
 
 	// End all global scripts
 	for (std::vector<GlobalScript *>::iterator sItr = m_GlobalScriptsList.begin(); sItr < m_GlobalScriptsList.end(); ++sItr) {
@@ -456,8 +440,7 @@ void GAScripted::Update() {
     if (m_ActivityState != ActivityState::Over) {
 		AddPieSlicesToActiveActorPieMenus();
 
-        // Call the defined function, but only after first checking if it exists
-        g_LuaMan.GetMasterScriptState().RunScriptString("if " + m_LuaClassName + ".UpdateActivity then " + m_LuaClassName + ":UpdateActivity(); end");
+        RunLuaFunction("UpdateActivity");
 
         UpdateGlobalScripts(false);
     }
@@ -499,6 +482,16 @@ void GAScripted::Draw(BITMAP *pTargetBitmap, const Vector &targetPos) {
     GameActivity::Draw(pTargetBitmap, targetPos);
 }
 
+int GAScripted::RunLuaFunction(const std::string& functionName, const std::vector<const Entity*>& functionEntityArguments, const std::vector<std::string_view>& functionLiteralArguments, const std::vector<LuabindObjectWrapper*>& functionObjectArguments) {
+    // Call the defined function, but only after first checking if it exists
+    auto funcItr = m_ScriptFunctions.find(functionName);
+    if (funcItr == m_ScriptFunctions.end()) {
+        return 0;
+    }
+
+    return g_LuaMan.GetMasterScriptState().RunScriptFunctionObject(funcItr->second.get(), "_G", m_LuaClassName, functionEntityArguments, functionLiteralArguments, functionObjectArguments);
+}
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Virtual method:  CollectRequiredAreas

Activities/GAScripted.h

@@ -18,6 +18,8 @@
 #include "GlobalScript.h"
 #include "Box.h"
 
+#include "LuabindObjectWrapper.h"
+
 namespace RTE
 {
 
@@ -41,6 +43,7 @@ class GAScripted : public GameActivity {
 
 public:
 
+ScriptFunctionNames("StartActivity", "UpdateActivity", "PauseActivity", "EndActivity", "OnSave", "CraftEnteredOrbit", "OnMessage", "OnGlobalMessage");
 
 // Concrete allocation and cloning definitions
 EntityAllocation(GAScripted);
@@ -242,6 +245,7 @@ ClassInfoGetters;
 
 	void Draw(BITMAP *pTargetBitmap, const Vector& targetPos = Vector()) override;
 
+	int RunLuaFunction(const std::string& functionName, const std::vector<const Entity*>& functionEntityArguments = std::vector<const Entity*>(), const std::vector<std::string_view>& functionLiteralArguments = std::vector<std::string_view>(), const std::vector<LuabindObjectWrapper*>& functionObjectArguments = std::vector<LuabindObjectWrapper*>());
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Protected member variable and method declarations
@@ -283,6 +287,8 @@ ClassInfoGetters;
     // The list of global scripts allowed to run during this activity
     std::vector<GlobalScript *> m_GlobalScriptsList;
 
+	std::unordered_map<std::string, std::unique_ptr<LuabindObjectWrapper>> m_ScriptFunctions; //!< A map of LuabindObjectWrappers that hold Lua functions. Used to maintain script execution order and avoid extraneous Lua calls.
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Private member variable and method declarations

Activities/GameActivity.cpp

@@ -87,7 +87,7 @@ void GameActivity::Clear()
 
 	m_StartingGold = 0;
 	m_FogOfWarEnabled = false;
-	m_RequireClearPathToOrbit = true;
+	m_RequireClearPathToOrbit = false;
 
 	m_DefaultFogOfWar = -1;
 	m_DefaultRequireClearPathToOrbit = -1;
@@ -1795,7 +1795,7 @@ void GameActivity::Update()
 				float lzOffsetY = 0;
 				// Holding up or down will allow the player to make multiple orders without exiting the delivery phase. TODO: this should probably have a cooldown?
 				if (!m_PlayerController[player].IsState(MOVE_UP) && !m_PlayerController[player].IsState(MOVE_DOWN)) {
-					m_LandingZone[player].m_Y = g_SceneMan.FindAltitude(m_LandingZone[player], g_SceneMan.GetSceneHeight(), 10);
+					m_LandingZone[player].m_Y = g_SceneMan.FindAltitude(m_LandingZone[player], g_SceneMan.GetSceneHeight(), 10, true);
 					if (!g_MovableMan.GetNextTeamActor(team)) {
 						m_ObservationTarget[player] = m_LandingZone[player];
 						m_ViewState[player] = ViewState::Observe;
@@ -1815,7 +1815,7 @@ void GameActivity::Update()
                         lzOffsetY *= -1.0f;
                     }
 
-					m_LandingZone[player].m_Y = g_SceneMan.FindAltitude(m_LandingZone[player], g_SceneMan.GetSceneHeight(), 10) + lzOffsetY;
+					m_LandingZone[player].m_Y = g_SceneMan.FindAltitude(m_LandingZone[player], g_SceneMan.GetSceneHeight(), 10, true) + lzOffsetY;
 
 					if (m_pBuyGUI[player]->GetTotalOrderCost() > GetTeamFunds(team)) {
 						g_GUISound.UserErrorSound()->Play(player);
@@ -1847,7 +1847,7 @@ void GameActivity::Update()
                 viewOffset *= -1;
             }
 
-            m_LandingZone[player].m_Y = prevHeight + ((g_SceneMan.FindAltitude(m_LandingZone[player], g_SceneMan.GetSceneHeight(), 10) - prevHeight) * 0.2);
+            m_LandingZone[player].m_Y = prevHeight + ((g_SceneMan.FindAltitude(m_LandingZone[player], g_SceneMan.GetSceneHeight(), 10) - prevHeight, true) * 0.2);
 
             // Set the view to a little above the LZ position
             Vector viewTarget(m_LandingZone[player].m_X, m_LandingZone[player].m_Y - viewOffset);
@@ -2135,7 +2135,7 @@ void GameActivity::Update()
             // Make view follow the terrain
             float prevHeight = m_ObservationTarget[Players::PlayerFour].m_Y;
             m_ObservationTarget[Players::PlayerFour].m_Y = 0;
-            m_ObservationTarget[Players::PlayerFour].m_Y = prevHeight + ((g_SceneMan.FindAltitude(m_ObservationTarget[Players::PlayerFour], g_SceneMan.GetSceneHeight(), 20) - prevHeight) * 0.02);
+            m_ObservationTarget[Players::PlayerFour].m_Y = prevHeight + ((g_SceneMan.FindAltitude(m_ObservationTarget[Players::PlayerFour], g_SceneMan.GetSceneHeight(), 20, true) - prevHeight) * 0.02);
         }
 
         // Set the view to the observation position

CHANGELOG.md

@@ -14,6 +14,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `Settings.ini` property `EnableMultithreadedLua`, which can be used to enable multithreaded Lua scripts and AI, for any lua script with the `--[[MULTITHREAD]]--` tag. Defaults to true.  
 
+- New generic Lua messaging system, to allow scripts on objects to communicate with other objects or scripts.
+	Scripts on `MovableObject` now have new callback functions `OnMessage(self, message, context)` and `OnGlobalMessage(self, message, context)`.  
+	Script on `Activity` also have similar functions: `ActivityName:OnMessage(message, context)` and `ActivityName:OnGlobalMessage(message, context)`.  
+	The `OnMessage` callback will be triggered whenever the `SendMessage(message, context)` is called on an object, i.e `Object:SendMessage("Hello World")`.  
+	This `context` argument can be anything, like a table, string or number. It will be nil if left out of the SendMessage function call.
+	The `OnGlobalMessage` callback works the exact same way, however global messages are sent to every object within the game, instead of a specific object.  
+	To send a global message, use `MovableMan:SendGlobalMessage(message, context)`.  
+
 - New Lua event function `SyncedUpdate()`, which will be called in a thread-safe synchronized manner and allows multithreaded scripts to modify game state in a safe and consistent way.  
 
 - Multithreaded asynchronous pathfinding, which dramatically improves performance on large maps and improves AI responsiveness.
@@ -38,10 +46,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `AEJetpack` type, which replaces the old technique of `ACrab`/`AHuman` using an `AEmitter` as a jetpack. This type inherits from `AEmitter`.  
 	New INI and Lua (R/W) property `JetpackType`, which can be either `AEJetpack.Standard` or `AEJetpack.JumpPack`. Standard acts the same as the typical jetpack, whereas JumpPacks can only be activated when fully recharged, and fires all of it's fuel in one burst. Defaults to Standard.  
+	New INI and Lua (R/W) property `MinimumFuelRatio`, which defines the ratio of current fuel to max fuel that has to be met to fire the jetpack. Defaults to 0 for Standard and 0.25 for JumpPacks.  
 	New INI and Lua (R/W) property `CanAdjustAngleWhileFiring`, which defines whether the jet angle can change while the jetpack is active. Defaults to true.  
 	New INI and Lua (R/W) property `AdjustsThrottleForWeight`, which defines whether the jetpack will adjust it's throttle (between `NegativeThrottleMultiplier` and `PositiveThrottleMultiplier`) to account for any extra inventory mass. Increased throttle will decrease jet time accordingly. Defaults to true.  
 
-
 - New `HeldDevice` Lua (R) function `IsBeingHeld`, which returns whether or not the `HeldDevice` is currently being held.  
 
 - New `HeldDevice` INI and Lua (R/W) property `GetsHitByMOsWhenHeld`, which defines whether this `HeldDevice` can be hit by MOs while equipped and held by an actor. Defaults to true.  
@@ -70,6 +78,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `SLTerrain` INI property `OrbitDirection`, which defines which direction is considered to be orbit, for the sake of brain-path-to-orbit, dropship spawn/return location, etc. Can be any of `Up`, `Down`, `Left` or `Right`. Defaults to `Up`.
 
+- New FMOD and SoundContainer features:
+	The game is now divided into SFX, UI, and Music busses which all route into the Master bus.
+	The SFX bus has compression added for a better listening experience, and a safety volume limiter has been added to the Master bus.
+	Aside from volume being attenuated, sounds will now also be lowpass filtered as distance increases.
+	New `SoundContainer` INI and Lua (R/W) property `BusRouting`, which denotes which bus the SoundContainer routes to. Available busses: `SFX, UI, Music`. Defaults to `SFX`.
+	`Enum` binding for `SoundContainer.BusRouting`: `SFX = 0, UI = 1, MUSIC = 2`.
+	New `SoundContainer` INI and Lua (R/W) property `PanningStrengthMultiplier`, which will multiply the strength of 3D panning. This can be used to achieve for example a psuedo-Immobile effect where attenuation effects are still applied but the sound does not move from the center. Recommended to keep between 0.0 and 1.0.
+
 </details>
 
 <details><summary><b>Changed</b></summary>

Entities/ACDropShip.cpp

@@ -209,9 +209,9 @@ float ACDropShip::GetAltitude(int max, int accuracy)
     g_SceneMan.WrapPosition(rPos);
 
     // Check center too
-    float cAlt = g_SceneMan.FindAltitude(m_Pos, max, accuracy);
-    float rAlt = g_SceneMan.FindAltitude(rPos, max, accuracy);
-    float lAlt = g_SceneMan.FindAltitude(lPos, max, accuracy);
+    float cAlt = g_SceneMan.FindAltitude(m_Pos, max, accuracy, true);
+    float rAlt = g_SceneMan.FindAltitude(rPos, max, accuracy, true);
+    float lAlt = g_SceneMan.FindAltitude(lPos, max, accuracy, true);
 
     // Return the lowest of the three
     return MIN(cAlt, MIN(rAlt, lAlt));

Entities/ACRocket.cpp

@@ -268,7 +268,7 @@ float ACRocket::GetAltitude(int max, int accuracy)
     else
         pos = m_Pos;
 
-    return g_SceneMan.FindAltitude(pos, max, accuracy);
+    return g_SceneMan.FindAltitude(pos, max, accuracy, true);
 }
 
 //////////////////////////////////////////////////////////////////////////////////////////

Entities/ACraft.cpp

@@ -550,6 +550,17 @@ bool ACraft::HandlePieCommand(PieSlice::SliceType pieSliceIndex) {
         } else if (pieSliceIndex == PieSlice::SliceType::Stay) {
             m_AIMode = AIMODE_STAY;
             m_DeliveryState = FALL;
+        } else if (pieSliceIndex == PieSlice::SliceType::Sentry) {
+            m_AIMode = AIMODE_SENTRY;
+            m_DeliveryState = FALL;
+        } else if (pieSliceIndex == PieSlice::SliceType::Return) {
+            m_AIMode = AIMODE_RETURN;
+            m_DeliveryState = LAUNCH;
+        } else if (pieSliceIndex == PieSlice::SliceType::GoTo) {
+            m_AIMode = AIMODE_GOTO;
+            m_DeliveryState = FALL;
+            ClearAIWaypoints();
+            m_UpdateMovePath = true;
         } else if (pieSliceIndex == PieSlice::SliceType::Scuttle) {
             m_AIMode = AIMODE_SCUTTLE;
         } else {