Merge pull request #561 from cortex-command-community/pathfinding-nav-optimizations

Game System Optimizations

Author: Causeless

Activities/GAScripted.cpp

@@ -76,7 +76,9 @@ int GAScripted::Create() {
     // Scan the script file for any mentions/uses of Areas.
     CollectRequiredAreas();
 
+
     // If the GAScripted has a OnSave() function, we assume it can be saved by default
+    ReloadScripts();
     m_AllowsUserSaving = HasSaveFunction();
 
     return 0;
@@ -195,24 +197,15 @@ int GAScripted::ReloadScripts() {
     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;
         }
     }
 
-    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) {
+    if ((error = g_LuaMan.GetMasterScriptState().RunScriptFileAndRetrieveFunctions(m_ScriptPath, m_LuaClassName, GetSupportedScriptFunctionNames(), scriptFileFunctions, true)) < 0) {
         return error;
     }
 
@@ -310,8 +303,11 @@ int GAScripted::Start() {
         return error;
     }
 
-    // Create the Lua variable which will hold the class representation that we'll add some definitions to
-    if ((error = g_LuaMan.GetMasterScriptState().RunScriptString(m_LuaClassName + " = ToGameActivity(ActivityMan:GetActivity());")) < 0) {
+    // 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;
     }
 
@@ -563,12 +559,12 @@ void GAScripted::AddPieSlicesToActiveActorPieMenus() {
 			PieMenu *controlledActorPieMenu = m_ControlledActor[player]->GetPieMenu();
 			if (controlledActorPieMenu && m_ControlledActor[player]->GetController()->IsState(PIE_MENU_ACTIVE) && controlledActorPieMenu->IsEnabling()) {
 				for (const std::unique_ptr<PieSlice> &pieSlice : m_PieSlicesToAdd) {
-					controlledActorPieMenu->AddPieSliceIfPresetNameIsUnique(dynamic_cast<PieSlice *>(pieSlice->Clone()), this, true);
+					controlledActorPieMenu->AddPieSliceIfPresetNameIsUnique(pieSlice.get(), this, true);
 				}
 				for (const GlobalScript *globalScript : m_GlobalScriptsList) {
 					if (globalScript->IsActive()) {
 						for (const std::unique_ptr<PieSlice> &pieSlice : globalScript->GetPieSlicesToAdd()) {
-							controlledActorPieMenu->AddPieSliceIfPresetNameIsUnique(dynamic_cast<PieSlice *>(pieSlice->Clone()), globalScript, true);
+							controlledActorPieMenu->AddPieSliceIfPresetNameIsUnique(pieSlice.get(), globalScript, true);
 						}
 					}
 				}

Activities/GameActivity.cpp

@@ -1347,7 +1347,7 @@ void GameActivity::Update()
         // Assure that Controlled Actor is a safe pointer
 
         // Only allow this if player's brain is intact
-        if (g_MovableMan.IsActor(m_Brain[player]))
+        if (m_Brain[player] && !m_Brain[player]->IsDead() )
         {
             // Note that we have now had a brain
             m_HadBrain[player] = true;

CHANGELOG.md

@@ -22,6 +22,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	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 `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 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.
@@ -44,13 +50,23 @@ 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 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.  
+
+- Tracy profiler integration.  
+	You can now attach Tracy to builds of the game and see profiling information about various zones and how long they take.  
+	This can also be used to profile specific lua scripts, with the following functions:  
+	`tracy.ZoneBegin()`, `tracy.ZoneEnd()` to profile a block of code.  
+	`tracy.ZoneBeginN(text)` to begin a custom named zone, and `tracy.ZoneName(text)` to dynamically set the current zone name on a per-call basis.  
+	`tracy.Message(text)` to send a tracy message.  
+	Lua scripts without any tracy documentation are still profiled by tracy, however only at a granularity of how long the entire script takes to execute.  
 
-- New `HeldDevice` Lua (R) function `IsBeingHeld`, which returns whether or not the `HeldDevice` is currently being held.  
+- New `HeldDevice` Lua 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.  
 
@@ -78,13 +94,9 @@ 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.
+- New `Actor` Lua function `RemoveInventoryItemAtIndex`, with removes the `MovableObject` inventory item at a given index and returns.
+
+- New `Scene` Lua functions `AddNavigatableArea(areaName)` and `ClearNavigatableAreas()`. This can be used to restrict pathfinding to only search a set of areas that have been added to the scene before via `Scene:SetArea(area)`.
 
 </details>
 
@@ -101,6 +113,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
   Mods published for any development builds must match that development version exactly.
 
+- Pressing F2 to reload scripts now also reloads the scripts for all MOs currently in the scene.
+
+- Various optimizations to improve Lua performance.
+
 - Lua `Scene.ScenePath` property has been changed to a function `Scene:GetScenePath()`. This was done for thread-safety with multithreading, but can be used in the same way.
 
 - `CameraMan::SetScrollTarget()` function has had the `targetWrapped` parameter removed, as it's not necessary. The camera will always focus taking the shortest path regardless now. The new full function signature is `CameraMan::SetScrollTarget(target, speed, screenId)`, where speed defaults to 0.1 and screenId defaults to 0.

Entities/Activity.cpp

@@ -64,6 +64,8 @@ void Activity::Clear() {
 			m_TeamFunds[team] = 2000;
 			m_FundsChanged[team] = false;
 		}
+
+		m_SavedValues.Reset();
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Entities/Actor.cpp

@@ -125,7 +125,7 @@ void Actor::Clear() {
     m_MoveVector.Reset();
     m_MovePath.clear();
     m_UpdateMovePath = true;
-    m_MoveProximityLimit = 75.0F;
+    m_MoveProximityLimit = 20.0F;
     m_AIBaseDigStrength = c_PathFindingDefaultDigStrength;
     m_BaseMass = std::numeric_limits<float>::infinity();
 
@@ -811,7 +811,7 @@ void Actor::RemoveInventoryItem(const std::string &moduleName, const std::string
 
 MovableObject * Actor::RemoveInventoryItemAtIndex(int inventoryIndex) {
     if (inventoryIndex >= 0 && inventoryIndex < m_Inventory.size()) {
-        MovableObject *itemAtIndex = m_Inventory.at(inventoryIndex);
+        MovableObject *itemAtIndex = m_Inventory[inventoryIndex];
         m_Inventory.erase(m_Inventory.begin() + inventoryIndex);
         return itemAtIndex;
     }

Entities/Actor.h

@@ -1368,6 +1368,18 @@ ClassInfoGetters;
 	/// <param name="newRecoverDelay">The recovery delay, in MS.</param>
 	void SetStableRecoverDelay(int newRecoverDelay) { m_StableRecoverDelay = newRecoverDelay; }
 
+    /// <summary>
+    /// Gets the distance in which the Actor will have considered itself to have reached it's waypoint.
+    /// </summary>
+    /// <returns>The move proximity limit.</returns>
+    float GetMoveProximityLimit() const { return m_MoveProximityLimit; }
+
+    /// <summary>
+    /// Sets the distance in which the Actor will have considered itself to have reached it's waypoint.
+    /// </summary>
+    /// <param name="newProximityLimit">The move proximity limit.</param>
+    void SetMoveProximityLimit(float newProximityLimit) { m_MoveProximityLimit = newProximityLimit; }
+
 	/// <summary>
 	/// Gets whether or not this Actor has the organic flag set and should be considered as organic.
 	/// </summary>

Entities/MOSRotating.cpp

@@ -1881,13 +1881,20 @@ void MOSRotating::Draw(BITMAP *pTargetBitmap, const Vector &targetPos, DrawMode
         }
     }
 
+#ifdef DRAW_MOID_LAYER
+    bool needsWrap = true;
+#else
+    bool needsWrap = mode != g_DrawMOID;
+#endif
+
+
     // Take care of wrapping situations
     Vector aDrawPos[4];
     int passes = 1;
 
     aDrawPos[0] = spritePos;
 
-    if (g_SceneMan.SceneWrapsX()) {
+    if (needsWrap && g_SceneMan.SceneWrapsX()) {
         // See if need to double draw this across the scene seam if we're being drawn onto a scenewide bitmap
         if (targetPos.IsZero() && m_WrapDoubleDraw) {
             if (spritePos.m_X < m_SpriteDiameter) {
@@ -1915,16 +1922,24 @@ void MOSRotating::Draw(BITMAP *pTargetBitmap, const Vector &targetPos, DrawMode
     }
 
     if (m_HFlipped && pFlipBitmap) {
-        // Don't size the intermediate bitmaps to the m_Scale, because the scaling happens after they are done
-        clear_to_color(pFlipBitmap, keyColor);
+#ifdef DRAW_MOID_LAYER
+        bool drawIntermediate = true;
+#else
+        bool drawIntermediate = mode != g_DrawMOID;
+#endif
 
-        // Draw either the source color bitmap or the intermediate material bitmap onto the intermediate flipping bitmap
-		if (mode == g_DrawColor || mode == g_DrawTrans) {
-			draw_sprite_h_flip(pFlipBitmap, m_aSprite[m_Frame], 0, 0);
-		} else {
-			// If using the temp bitmap (which is always larger than the sprite) make sure the flipped image ends up in the upper right corner as if it was just as small as the sprite bitmap
-            draw_sprite_h_flip(pFlipBitmap, pTempBitmap, -(pTempBitmap->w - m_aSprite[m_Frame]->w), 0);
-		}
+        if (drawIntermediate) {
+            // Don't size the intermediate bitmaps to the m_Scale, because the scaling happens after they are done
+            clear_to_color(pFlipBitmap, keyColor);
+
+            // Draw either the source color bitmap or the intermediate material bitmap onto the intermediate flipping bitmap
+		    if (mode == g_DrawColor || mode == g_DrawTrans) {
+			    draw_sprite_h_flip(pFlipBitmap, m_aSprite[m_Frame], 0, 0);
+		    } else {
+			    // If using the temp bitmap (which is always larger than the sprite) make sure the flipped image ends up in the upper right corner as if it was just as small as the sprite bitmap
+                draw_sprite_h_flip(pFlipBitmap, pTempBitmap, -(pTempBitmap->w - m_aSprite[m_Frame]->w), 0);
+		    }
+        }
 
         if (mode == g_DrawTrans) {
             clear_to_color(pTempBitmap, keyColor);
@@ -2051,14 +2066,14 @@ void MOSRotating::CorrectAttachableAndWoundPositionsAndRotations() const {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-void MOSRotating::OnGameSave() {
-	MovableObject::OnGameSave();
+void MOSRotating::OnSave() {
 	for (AEmitter *wound : m_Wounds) {
-		wound->OnGameSave();
+		wound->OnSave();
 	}
 	for (Attachable *attachable : m_Attachables) {
-		attachable->OnGameSave();
+		attachable->OnSave();
 	}
+    MovableObject::OnSave();
 }
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Entities/MOSRotating.h

@@ -832,7 +832,7 @@ ClassInfoGetters;
 	/// <summary>
 	/// Method to be run when the game is saved via ActivityMan::SaveCurrentGame. Not currently used in metagame or editor saving.
 	/// </summary>
-	void OnGameSave() override;
+	void OnSave() override;
 
 
 //////////////////////////////////////////////////////////////////////////////////////////