Fix CAI_ScriptedSequence crash

gamedata/srccoop.games.txt

@@ -882,6 +882,13 @@
 					}
 				}
 			}
+			"CAI_ScriptedSequence::StartScript"
+			{
+				"signature"	"CAI_ScriptedSequence::StartScript"
+				"callconv"	"thiscall"
+				"return"	"void"
+				"this"		"entity"
+			}
 		}
 	}
 
@@ -1070,6 +1077,11 @@
 				"windows"	"\x55\x8B\xEC\x83\xEC\x18\x56\xE8\x2A\x2A\x2A\x2A\x8B\xF0\x85\xF6\x75"
 				"linux"		"@_ZL24UTIL_FindClientInPVSGutsP7edict_tPhj.constprop.66"
 			}
+			"CAI_ScriptedSequence::StartScript"	// void CAI_ScriptedSequence::StartScript()
+			{
+				"windows"	"\x55\x8B\xEC\x83\xEC\x10\x53\x8B\xD9\x8B\x8B\x9C\x03\x00\x00"
+				"linux"		"@_ZN20CAI_ScriptedSequence11StartScriptEv"
+			}
 		}
 
 		//  ____  __  __  _____    __  __ ______ __  __ _____     _______ _____ _    _ ______  _____ 

scripting/include/srccoop.inc

@@ -84,6 +84,7 @@
 	#define ENTPATCH_LOGIC_AUTOSAVE_SURVIVAL_RESPAWN
 	#define ENTPATCH_GAME_END
 	#define ENTPATCH_NPC_DIALOGUE
+	#define ENTPATCH_SCRIPTED_SEQUENCE
 	#define ENTPATCH_REMOVE_BONE_FOLLOWERS
 	#define ENTPATCH_WEAPON_MODELS
 	#define ENTPATCH_PLAYER_ALLY

scripting/include/srccoop/classdef.inc

@@ -1336,6 +1336,27 @@ methodmap CSceneEntity < CPointEntity
 	}
 }
 
+methodmap CAI_ScriptedSequence < CBaseEntity
+{
+	public CAI_ScriptedSequence(const int iEntIndex = -1)
+	{
+		return view_as<CAI_ScriptedSequence>(CBaseEntity(iEntIndex));
+	}
+	public static CAI_ScriptedSequence Create()
+	{
+		return CAI_ScriptedSequence(CreateEntityByName("scripted_sequence"));
+	}
+
+	public CBaseEntity GetTargetEnt()
+	{
+		return CBaseEntity(GetEntPropEnt(this.entindex, Prop_Data, "m_hTargetEnt"));
+	}
+	public void SetTargetEnt(CBaseEntity pTarget)
+	{
+		SetEntPropEnt(this.entindex, Prop_Data, "m_hTargetEnt", pTarget.entindex);
+	}
+}
+
 methodmap CSoundEnt < CPointEntity
 {
 	public CSoundEnt(const int iEntIndex = -1)
@@ -2060,6 +2081,14 @@ methodmap CAI_BaseNPC < CBaseCombatCharacter
 	{
 		SetEntProp(this.GetEntIndex(), Prop_Data, "m_bPlayerAvoidState", bPlayerAvoidState);
 	}
+	public CAI_ScriptedSequence GetCine()
+	{
+		return CAI_ScriptedSequence(GetEntPropEnt(this.entindex, Prop_Data, "m_hCine"));
+	}
+	public void SetCine(CAI_ScriptedSequence pCine)
+	{
+		SetEntPropEnt(this.entindex, Prop_Data, "m_hCine", pCine.entindex);
+	}
 }
 
 methodmap CProtoSniper < CAI_BaseNPC

scripting/include/srccoop/entitypatch.inc

@@ -1575,3 +1575,23 @@ public MRESReturn Hook_UTIL_FindClientInPVSGuts(DHookReturn hReturn, DHookParam
 	return MRES_Supercede;
 	*/
 }
+
+//------------------------------------------------------
+// CAI_ScriptedSequence::StartScript
+// Attempts to fix null reference on m_hTargetEnt inside CAI_ScriptedSequence::ScriptThink
+// by preventing CAI_ScriptedSequence::StartScript from nullifying its own target entity.
+//------------------------------------------------------
+public MRESReturn Hook_ScriptedSequenceStartScript(int _this)
+{
+	CAI_ScriptedSequence pThis = CAI_ScriptedSequence(_this);
+	CBaseEntity pTarget = pThis.GetTargetEnt();
+	if (pTarget != NULL_CBASEENTITY && pTarget.IsClassNPC())
+	{
+		CAI_BaseNPC pTargetNpc = view_as<CAI_BaseNPC>(pTarget);
+		if (pThis == pTargetNpc.GetCine())
+		{
+			pTargetNpc.SetCine(NULL_CBASEENTITY);
+		}
+	}
+	return MRES_Ignored;
+}

scripting/include/srccoop/globals.inc

@@ -156,6 +156,10 @@ DynamicDetour hkDissolve;
 DynamicDetour hkUtilFindClientInPVSGuts;
 #endif
 
+#if defined ENTPATCH_SCRIPTED_SEQUENCE
+DynamicDetour hkScriptedSequenceStartScript;
+#endif
+
 #if defined GAMEPATCH_PREDICTED_EFFECTS
 DynamicDetour hkIgnorePredictionCull;
 DynamicHook hkDispatchEffect;

scripting/srccoop.sp

@@ -177,6 +177,10 @@ void LoadGameData()
 	LoadDHookDetour(pGameConfig, hkUtilFindClientInPVSGuts, "UTIL_FindClientInPVSGuts", Hook_UTIL_FindClientInPVSGuts);
 	#endif
 
+	#if defined ENTPATCH_SCRIPTED_SEQUENCE
+	LoadDHookDetour(pGameConfig, hkScriptedSequenceStartScript, "CAI_ScriptedSequence::StartScript", Hook_ScriptedSequenceStartScript);
+	#endif
+
 	#if defined GAMEPATCH_PREDICTED_EFFECTS
 	LoadDHookDetour(pGameConfig, hkIgnorePredictionCull, "CRecipientFilter::IgnorePredictionCull", Hook_IgnorePredictionCull);
 	LoadDHookVirtual(pGameConfig, hkDispatchEffect, "CTempEntsSystem::DispatchEffect");