Merge pull request #38 from jonathan-robertson/dev

Fix Null Reference Exception

Author: jonathan-robertson

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.2] - 2023-03-05
+
+- add conf check when applying warp effects buff
+- fix error log interpolation
+- fix error on warp from portable to locked secured
+- improve debug logging around travel prevention
+- remove unnecessary particle rotation reference
+
 ## [1.1.1] - 2023-02-24
 
 - disable block decoration val; caused warp issues

Config/buffs.xml

@@ -88,7 +88,7 @@
                 <triggered_effect trigger="onSelfBuffStart" action="PlaySound" sound="solarpanel_on" play_in_head="false" />
                 <triggered_effect trigger="onSelfBuffStack" action="PlaySound" sound="solarpanel_on" play_in_head="false" />
 
-                <triggered_effect local_rotation="90,0,0" trigger="onSelfBuffStart" action="AttachParticleEffectToEntity" particle="RadiatedParticlesOnMesh" parent_transform="LOD0" shape_mesh="true" />
+                <triggered_effect trigger="onSelfBuffStart" action="AttachParticleEffectToEntity" particle="RadiatedParticlesOnMesh" shape_mesh="true" />
                 <triggered_effect trigger="onSelfDied" action="RemoveParticleEffectFromEntity" particle="RadiatedParticlesOnMesh" />
                 <triggered_effect trigger="onSelfBuffFinish" action="RemoveParticleEffectFromEntity" particle="RadiatedParticlesOnMesh" />
                 <triggered_effect trigger="onSelfBuffRemove" action="RemoveParticleEffectFromEntity" particle="RadiatedParticlesOnMesh" />

ModInfo.xml

@@ -3,7 +3,7 @@
         <Name value="Quantum Elevators" />
         <Description value="Add infinite distance, vertical-warp elevator panels." />
         <Author value="Jonathan Robertson (Kanaverum)" />
-        <Version value="1.1.1" />
+        <Version value="1.1.2" />
         <Website value="https://github.com/jonathan-robertson/quantum-elevators" />
     </ModInfo>
 </xml>

QuantumElevators.dll

@@ -12,6 +12,7 @@
     - [Secure Quantum Elevator panels](#secure-quantum-elevator-panels)
   - [Compatibility](#compatibility)
   - [Admin Commands](#admin-commands)
+  - [Acknowledgements](#acknowledgements)
 
 ## Summary
 
@@ -71,3 +72,13 @@ primary | alternate | params | description
 quantumelevators | qe | N/A | enable/disable debug logging for this mod (disabled by default)
 
 *Note that leaving debug mode on can have a negative impact on performance. It is therefore recommended to only turn it on while troubleshooting and then disable it afterwards.*
+
+## Acknowledgements
+
+Several people in the community have offered feedback, identified bugs, and have worked to provide me with debug logs to help move this project forward. Quantum Elevators is a cool idea and has been a lot of fun to work on, but would not be what it is today without the added effort from these incredible admins, modders, and players. *(Discord Usernames)*
+
+- `Shavick#8511` performed early testing and identified various issues that arose when client and server were both running the mod.
+- `Grandpa Minion#2643` and the NAPVP Community who helped with hardcore testing and several bug reports.
+- `Blight#7410` of Pimp my House, Tea Lounge, Juggernaut, and Ragnarok submitted bug reports that helped identify and resolve a critical bug.
+- `O C#2804` reviewed and offered suggestions and advice that led to the resolution of a critical bug.
+- `vivo#0815` identified how to recreate a bug that occurred only on initial launch of a new map.

README.md

@@ -72,7 +72,11 @@ internal static void Warp(Direction direction, EntityPlayer player, Vector3i sou
                 else if (TryGetClientInfo(player.entityId, out var clientInfo))
                 {
                     _log.Debug($"planning to teleport {player} to {player.position} soon");
-                    _ = player.Buffs.AddBuff(BuffTriggerJumpName); // for visuals & sound-effects
+                    var buffStatus = player.Buffs.AddBuff(BuffTriggerJumpName); // for visuals & sound-effects
+                    if (buffStatus != EntityBuffs.BuffStatus.Added)
+                    {
+                        _log.Warn($"Failed to apply buff {BuffTriggerJumpName} to player {player} due to buffStatus response of {buffStatus}");
+                    }
                     if (crowdWasAtPanel)
                     {
                         _ = ThreadManager.StartCoroutine(WarpRemotePlayerLater(clientInfo, player, destinationCenter));
@@ -240,36 +244,43 @@ private static bool CanAccess(PlatformUserIdentifierAbs internalId, TileEntitySi
         {
             if (CanAccess(internalId, target, out var targetHasPassword))
             {
+                _log.Debug($"CAN ACCESS because: player {internalId} already has permission to the target panel.");
                 return true;
-            } // targetBlockPos is locked and entityPlayer doesn't have access
-            if (!targetHasPassword
-                || source == null
-                || !source.IsLocked()
-                || !source.HasPassword())
+            } // so target is locked and entityPlayer isn't already registered as an authorized user
+            if (!targetHasPassword)
             {
-                _log.Debug($"CANNOT ACCESS because: !targetHasPassword ({!targetHasPassword}) || source == null({source == null}) || !source.IsLocked()({!source.IsLocked()}) || !source.HasPassword()({!source.HasPassword()})");
+                _log.Debug("CANNOT ACCESS because: target does not have a password.");
                 return false;
-            } // source and targetBlockPos have passwords, source is locked
-            if (source.GetOwner().Equals(target.GetOwner())
-                && source.GetPassword().Equals(target.GetPassword()))
+            } // so target does have a password set
+            if (source == null)
             {
-                _log.Debug($"CAN ACCESS because: source.GetOwner() == targetBlockPos.GetOwner()({source.GetOwner() == target.GetOwner()}) && source.GetPassword() == targetBlockPos.GetPassword()({source.GetPassword() == target.GetPassword()})");
-                target.GetUsers().Add(internalId); // dynamically register this user to targetBlockPos!
-                target.SetModified();
-                return true;
-            } // source/targetBlockPos owners or passwords don't match=
-            _log.Debug($@"CANNOT ACCESS because: source.GetOwner() != targetBlockPos.GetOwner() || source.GetPassword() != targetBlockPos.GetPassword()
-source.owner:
-    CombinedString:{source.GetOwner().CombinedString}
-    PlatformIdentifierString:{source.GetOwner().PlatformIdentifierString}
-    ReadablePlatformUserIdentifier:{source.GetOwner().ReadablePlatformUserIdentifier}
-targetBlockPos.owner:
-    CombinedString:{target.GetOwner().CombinedString}
-    PlatformIdentifierString:{target.GetOwner().PlatformIdentifierString}
-    ReadablePlatformUserIdentifier:{target.GetOwner().ReadablePlatformUserIdentifier}
-source.pass:{source.GetPassword()}
-targetBlockPos.pass:{target.GetPassword()}");
-            return false;
+                _log.Debug("CANNOT ACCESS because: source is a portable panel, which we cannot apply a password from.");
+                return false;
+            } // so source is not a portable panel and might have a password for us to apply to target
+            if (!source.IsLocked())
+            {
+                _log.Debug("CANNOT ACCESS because: source is not locked, so we know it does NOT have a password we could try applying to target.");
+                return false;
+            } // so source is locked
+            if (!source.HasPassword())
+            {
+                _log.Debug("CANNOT ACCESS because: source is locked but has no password, so we have no password to try applying to target.");
+                return false;
+            } // so source and target each have passwords and we might be able to apply the password from source to target
+            if (!source.GetOwner().Equals(target.GetOwner()))
+            {
+                _log.Debug("CANNOT ACCESS because: source owner does not match target owner, so a password cannot be applied to target even if it matches.");
+                return false;
+            } // so source and target have the same owners...
+            if (!source.GetPassword().Equals(target.GetPassword()))
+            {
+                _log.Debug("CANNOT ACCESS because: source and target do not share the same password.");
+                return false;
+            } // so source and target share the same password...
+            _log.Debug("CAN ACCESS because: source panel shares owner and password with target panel.");
+            target.GetUsers().Add(internalId); // dynamically register this user to targetBlockPos
+            target.SetModified();
+            return true;
         }
 
         /// <summary>

src/CoreLogic.cs

@@ -62,7 +62,7 @@ public static void Postfix(EntityAlive __instance, Vector3i ___blockPosStandingO
             }
             catch (Exception e)
             {
-                _log.Error("EntityAlive_updateCurrentBlockPosAndValue_Patches Postfix failed: handle block pos change for {__instance}.", e);
+                _log.Error($"EntityAlive_updateCurrentBlockPosAndValue_Patches Postfix failed: handle block pos change for {__instance}.", e);
             }
         }