preload refactoring and bugfixes

CTI/Classes/CTI.uc

@@ -7,11 +7,18 @@ const CfgRemoveItems = class'RemoveItems';
 const CfgAddItems    = class'AddItems';
 const Helper         = class'Helper';
 
+struct S_PreloadContent
+{
+	var class<KFWeaponDefinition> KFWD;
+	var class<KFWeapon>           KFWC;
+	var KFWeapon                  KFW;
+	var KFW_Access                KFWA;
+};
+
 var private config int        Version;
 var private config E_LogLevel LogLevel;
-var private config bool       bPreloadContent;
-var private config bool       bForcePreloadContent;
 var private config bool       UnlockDLC;
+var private config bool       bPreloadContent;
 
 var private KFGameInfo KFGI;
 var private KFGameReplicationInfo KFGRI;
@@ -23,6 +30,8 @@ var private Array<CTI_RepInfo> RepInfos;
 
 var private bool ReadyToSync;
 
+var private Array<S_PreloadContent> PreloadContent;
+
 public simulated function bool SafeDestroy()
 {
 	`Log_Trace(`Location);
@@ -67,7 +76,6 @@ private function PreInit()
 	{
 		LogLevel = LL_Info;
 		bPreloadContent = true;
-		bForcePreloadContent = true;
 		UnlockDLC = false;
 		SaveConfig();
 	}
@@ -187,7 +195,7 @@ private function PostInit()
 	
 	if (bPreloadContent)
 	{
-		Helper.static.PreloadContent(AddItems);
+		Preload(AddItems);
 	}
 	
 	ReadyToSync = true;
@@ -201,6 +209,39 @@ private function PostInit()
 	}
 }
 
+private function Preload(Array<class<KFWeaponDefinition> > Content)
+{
+	local S_PreloadContent SPC;
+	
+	foreach Content(SPC.KFWD)
+	{
+		SPC.KFWC = class<KFWeapon> (DynamicLoadObject(SPC.KFWD.default.WeaponClassPath, class'Class'));
+		if (SPC.KFWC != None)
+		{
+			SPC.KFW = KFGI.Spawn(SPC.KFWC);
+			if (SPC.KFW == None)
+			{
+				`Log_Warn("Spawn failed:" @ SPC.KFWD.default.WeaponClassPath);
+				continue;
+			}
+			
+			SPC.KFWA = new (SPC.KFW) class'KFW_Access';
+			if (SPC.KFWA == None)
+			{
+				`Log_Warn("Spawn failed:" @ SPC.KFWD.default.WeaponClassPath @ "KFW_Access");
+				continue;
+			}
+			
+			PreloadContent.AddItem(SPC);
+		}
+	}
+	
+	foreach PreloadContent(SPC)
+	{
+		SPC.KFWA.KFW_StartLoadWeaponContent();
+	}
+}
+
 public function NotifyLogin(Controller C)
 {
 	`Log_Trace(`Location);
@@ -232,9 +273,7 @@ public function bool CreateRepLink(Controller C)
 		LogLevel,
 		RemoveItems,
 		AddItems,
-		CfgRemoveItems.default.bAll,
+		CfgRemoveItems.default.bAll);
-		bPreloadContent,
-		bForcePreloadContent);
 	
 	RepInfos.AddItem(RepLink);
 	

CTI/Classes/CTI_RepInfo.uc

@@ -10,18 +10,25 @@ var private Array<class<KFWeaponDefinition> > RemoveItems;
 var private Array<class<KFWeaponDefinition> > AddItems;
 var private bool ReplaceMode;
 var private bool PreloadContent;
-var private bool ForcePreloadContent;
 
 var private int  Recieved;
 var private int  SyncSize;
 
+var private KFPlayerController      KFPC;
 var private KFGFxWidget_PartyInGame PartyInGameWidget;
 var private GFxObject               Notification;
 
+var private String NotificationHeaderText;
+var private String NotificationLeftText;
+var private String NotificationRightText;
+var private int    NotificationPercent;
+
+var private int    WaitingGRI;
+
 replication
 {
 	if (bNetInitial && Role == ROLE_Authority)
-		LogLevel, ReplaceMode, PreloadContent, ForcePreloadContent, SyncSize;
+		LogLevel, ReplaceMode, SyncSize;
 }
 
 public simulated function bool SafeDestroy()
@@ -36,42 +43,40 @@ public function PrepareSync(
 	E_LogLevel _LogLevel,
 	Array<class<KFWeaponDefinition> > _RemoveItems,
 	Array<class<KFWeaponDefinition> > _AddItems,
-	bool _ReplaceMode,
+	bool _ReplaceMode)
-	bool _PreloadContent,
-	bool _ForcePreloadContent)
 {
+	`Log_Trace(`Location);
+	
 	CTI                 = _CTI;
 	LogLevel            = _LogLevel;
 	RemoveItems         = _RemoveItems;
 	AddItems            = _AddItems;
 	ReplaceMode         = _ReplaceMode;
-	PreloadContent      = _PreloadContent;
-	ForcePreloadContent = _ForcePreloadContent;
 	SyncSize            = RemoveItems.Length + AddItems.Length;
 }
 
-private simulated function PlayerController GetPlayerController()
+private simulated function KFPlayerController GetKFPC()
 {
-	local PlayerController PC;
+	`Log_Trace(`Location);
 	
-	PC = PlayerController(Owner);
+	if (KFPC != None) return KFPC;
 	
-	if (PC == None && ROLE < ROLE_Authority)
+	KFPC = KFPlayerController(Owner);
+	
+	if (KFPC == None && ROLE < ROLE_Authority)
 	{
-		PC = GetALocalPlayerController();
+		KFPC = KFPlayerController(GetALocalPlayerController());
 	}
 	
-	return PC;
+	return KFPC;
 }
 
 private simulated function SetPartyInGameWidget()
 {
-	local KFPlayerController KFPC;
-	
 	`Log_Trace(`Location);
 	
-	KFPC = KFPlayerController(GetPlayerController());
+	if (GetKFPC() == None) return;
-	if (KFPC == None) return;
+	
 	if (KFPC.MyGFxManager == None) return;
 	if (KFPC.MyGFxManager.PartyWidget == None) return;
 	
@@ -81,6 +86,8 @@ private simulated function SetPartyInGameWidget()
 
 private simulated function bool CheckPartyInGameWidget()
 {
+	`Log_Trace(`Location);
+	
 	if (PartyInGameWidget == None)
 	{
 		SetPartyInGameWidget();
@@ -91,6 +98,8 @@ private simulated function bool CheckPartyInGameWidget()
 
 private simulated function HideReadyButton()
 {
+	`Log_Trace(`Location);
+	
 	if (CheckPartyInGameWidget())
 	{
 		PartyInGameWidget.SetReadyButtonVisibility(false);
@@ -99,6 +108,8 @@ private simulated function HideReadyButton()
 
 private simulated function ShowReadyButton()
 {
+	`Log_Trace(`Location);
+	
 	if (CheckPartyInGameWidget())
 	{
 		Notification.SetVisible(false);
@@ -108,8 +119,10 @@ private simulated function ShowReadyButton()
 	}
 }
 
-private reliable client function UpdateNotification(String Title, String Downloading, String Remainig, int Percent)
+private simulated function UpdateNotification(String Title, String Downloading, String Remainig, int Percent)
 {
+	`Log_Trace(`Location);
+	
 	if (CheckPartyInGameWidget() && Notification != None)
 	{
 		Notification.SetString("itemName", Title);
@@ -133,7 +146,10 @@ private reliable client function ClientSync(class<KFWeaponDefinition> WeapDef, o
 		return;
 	}
 	
-	HideReadyButton();
+	if (!IsTimerActive(nameof(KeepNotification)))
+	{
+		SetTimer(0.1f, true, nameof(KeepNotification));
+	}
 	
 	if (Remove)
 	{
@@ -142,32 +158,44 @@ private reliable client function ClientSync(class<KFWeaponDefinition> WeapDef, o
 	else
 	{
 		AddItems.AddItem(WeapDef);
-		if (PreloadContent)
-		{
-			Helper.static.PreloadWeapon(WeapDef);
-		}
 	}
 	
 	Recieved = RemoveItems.Length + AddItems.Length;
 	
-	UpdateNotification(
+	NotificationLeftText    = Remove ? "-" : "+" @ Repl(String(WeapDef), "KFWeapDef_", "");
-		"Sync items, please wait...",
+	NotificationRightText   = Recieved @ "/" @ SyncSize;
-		Remove ? "-" : "+" @ Repl(String(WeapDef), "KFWeapDef_", ""),
+	if (SyncSize != 0)
-		Recieved @ "/" @ SyncSize,
+	{
-		(float(Recieved) / float(SyncSize)) * 100);
+		NotificationPercent = (float(Recieved) / float(SyncSize)) * 100;
+	}
+	
+	`Log_Debug("ClientSync:" @ NotificationLeftText @ NotificationRightText);
 	
 	ServerSync();
 }
 
-private simulated reliable client function SyncFinished()
+private simulated function KeepNotification()
+{
+	HideReadyButton();
+	UpdateNotification(
+		NotificationHeaderText,
+		NotificationLeftText,
+		NotificationRightText,
+		NotificationPercent);
+}
+
+private simulated reliable client function ClientSyncFinished()
 {
 	local KFGameReplicationInfo KFGRI;
 	
 	`Log_Trace(`Location);
 	
-	if (WorldInfo == None || WorldInfo.GRI == None)
+	if (WorldInfo.GRI == None)
 	{
-		SetTimer(1.0f, false, nameof(SyncFinished));
+		`Log_Debug("ClientSyncFinished: WorldInfo.GRI == None");
+		NotificationHeaderText = "Waiting for GameReplicationInfo...";
+		NotificationLeftText   = String(++WaitingGRI) $ "s";
+		SetTimer(1.0f, false, nameof(ClientSyncFinished));
 		return;
 	}
 	
@@ -175,12 +203,18 @@ private simulated reliable client function SyncFinished()
 	if (KFGRI == None)
 	{
 		`Log_Fatal("Incompatible Replication info:" @ WorldInfo.GRI);
+		ClearTimer(nameof(KeepNotification));
+		UpdateNotification(
+			"Error: Incompatible Replication info:" @ WorldInfo.GRI,
+			"", "", 0);
 		SafeDestroy();
 		return;
 	}
 
 	Helper.static.ModifyTrader(KFGRI, RemoveItems, AddItems, ReplaceMode);
+	`Log_Debug("ClientSyncFinished: Helper.static.ModifyTrader");
 
+	ClearTimer(nameof(KeepNotification)); 
 	ShowReadyButton();
 	
 	SafeDestroy();
@@ -194,14 +228,12 @@ public reliable server function ServerSync()
 	
 	if (bPendingDelete || bDeleteMe) return;
 	
+	`Log_Debug("ServerSync:" @ Recieved @ "/" @ SyncSize);
 	if (SyncSize <= Recieved || WorldInfo.NetMode == NM_StandAlone)
 	{
-		if (ForcePreloadContent)
+		`Log_Debug("ServerSync: SyncFinished");
-		{
-			PreloadContentWorkaround();
-		}
 		
-		SyncFinished();
+		ClientSyncFinished();
 	
 		if (!CTI.DestroyRepLink(Controller(Owner)))
 		{
@@ -221,94 +253,6 @@ public reliable server function ServerSync()
 	}
 }
 
-private function PreloadContentWorkaround()
-{
-	local PlayerController PC;
-	local Pawn P;
-	local KFInventoryManager KFIM;
-	local class<Weapon> CW;
-	local Weapon W;
-	local int Index;
-	local DroppedPickup DP;
-	local float Time;
-	
-	`Log_Trace(`Location);
-
-	HideReadyButton();
-	PC = GetPlayerController();
-	
-	if (PC == None)
-	{
-		SetTimer(0.1f, false, nameof(PreloadContentWorkaround));
-		return;
-	}
-	
-	P = PC.Pawn;
-	if (P == None)
-	{
-		SetTimer(0.1f, false, nameof(PreloadContentWorkaround));
-		return;
-	}
-	
-	KFIM = KFInventoryManager(P.InvManager);
-	if (KFIM == None)
-	{
-		SetTimer(0.1f, false, nameof(PreloadContentWorkaround));
-		return;
-	}
-
-	KFIM.bInfiniteWeight = true;
-	Time = WorldInfo.TimeSeconds - 1.0f;
-
-	for (Index = 0; Index < AddItems.Length; Index++)
-	{
-		HideReadyButton();
-		UpdateNotification(
-			"Game isn't frozen, Don't panic",
-			"Preload content:",
-			Index @ "/" @ AddItems.Length,
-			(float(Index) / float(AddItems.Length)) * 100);
-		
-		CW = class<Weapon> (DynamicLoadObject(AddItems[Index].default.WeaponClassPath, class'Class'));
-		if (CW != None && Weapon(P.FindInventoryType(CW)) == None)
-		{
-			P.CreateInventory(CW);
-		}
-	}
-	
-	HideReadyButton();
-	UpdateNotification("Cleanup", "", "", 0);
-			
-	foreach KFIM.InventoryActors(class'Weapon', W)
-	{
-		if (W != None)
-		{
-			KFIM.PendingWeapon = W;
-			KFIM.ChangedWeapon();
-			if (W.CanThrow())
-			{
-				P.TossInventory(W);
-				W.Destroy();
-			}
-		}
-	}
-	
-	HideReadyButton();
-	UpdateNotification("Cleanup", "", "", 0);
-	
-	foreach WorldInfo.DynamicActors(class'DroppedPickup', DP)
-	{
-		if (DP.Instigator == P && DP.CreationTime > Time)
-		{
-			DP.Destroy();
-		}
-	}
-	
-	KFIM.bInfiniteWeight = false;
-	
-	`Log_Info("Force Preload Finished (" $ PC.PlayerReplicationInfo.PlayerName $ ")");
-}
-
 defaultproperties
 {
 	bAlwaysRelevant               = false
@@ -317,4 +261,9 @@ defaultproperties
 	
 	PendingSync = false
 	Recieved    = 0
+	
+	NotificationHeaderText = "Sync trader items, please wait..."
+	NotificationPercent    = 0
+	
+	WaitingGRI             = 0
 }

CTI/Classes/Helper.uc

@@ -52,31 +52,6 @@ public static simulated function ModifyTrader(
 	KFGRI.TraderItems = TraderItems;
 }
 
-public static simulated function PreloadContent(Array<class<KFWeaponDefinition> > WeapDefs)
-{
-	local class<KFWeaponDefinition> WeapDef;
-	
-	foreach WeapDefs(WeapDef)
-	{
-		PreloadWeapon(WeapDef);
-	}
-}
-
-public static simulated function PreloadWeapon(class<KFWeaponDefinition> WeapDef)
-{
-	local class<KFWeapon> KFW;
-	
-	KFW = class<KFWeapon> (DynamicLoadObject(WeapDef.default.WeaponClassPath, class'Class'));
-	if (KFW != None)
-	{
-		// This doesn't seem to have any effect right now,
-		// so we're forced to use a workaround: CTI_RepInfo.PreloadContentWorkaround()
-		// But I still leave it for the future
-		// in the hope that someday we can preload weapon models using this function
-		class'KFWeapon'.static.TriggerAsyncContentLoad(KFW);
-	}
-}
-
 defaultproperties
 {
 	

CTI/Classes/KFW_Access.uc

@@ -0,0 +1,12 @@
+class KFW_Access extends Object
+	within KFWeapon;
+
+public function KFW_StartLoadWeaponContent()
+{
+	StartLoadWeaponContent();
+}
+
+defaultproperties
+{
+	
+}

PublicationContent/description.txt

@@ -1,8 +1,8 @@
 [h1]Features[/h1]
-- remove and/or add items;
+- remove/add items to trader;
+- can preload weapon models (no lags when someone buys weapons);
 - unlock DLC weapons;
 - correct items sorting (by price);
-- can preload content (no lags during trader time);
 - don't have to worry about adding new guns after each Tripware update.
 
 [h1]Whitelisted?[/h1]
@@ -25,16 +25,12 @@ No. This mod is not whitelisted and will unrank your server. Any XP gained will
 3. Start the server and wait while the mutator is downloading;
 4. Add mutator to server start parameters: [b]?Mutator=CTI.CTIMut[/b] and restart the server.
 
-[h1]Note[/h1]
-📌 Mutator does not contain custom weapons. You must have the required weapon packs in your subscriptions to be able to add them to the trader.
-📌 If you are using this mutator to add weapons, you should [b]not[/b] use mutators from weapon packs (just having them in subscriptions is enough).
-
 [h1]Setup (KFCTI.ini)[/h1]
 Config will be created at the first start.
 
 Set [b]UnlockDLC=True[/b] to allow all players to buy DLC weapons.
 
-Set [b]bForcePreloadContent=True[/b] to preload weapon models and have no lags during trader time.
+Set [b]bPreloadContent=True[/b] to load weapon models in advance and have no lags during the game.
 
 Use [b][CTI.RemoveItems][/b] to remove items from the trader inventory.
 For example: [b]Item=KFGame.KFWeapDef_Mac10[/b] will remove MAC10 from sale.
@@ -43,9 +39,15 @@ Set [b]bAll=True[/b] if you want to remove all items (can be useful if you want
 Use [b][CTI.AddItems][/b] to add items to the trader inventory.
 For example: [b]Item=WeaponPack.KFWeapDef_XM25[/b] will add [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1147408497]XM25[/url] to sale.
 
-[h1]Example config(s)[/h1]
+[h1]🔗 [url=https://steamcommunity.com/workshop/filedetails/discussion/2830826239/3409804177172972154]Weapon Packs Items[/url][/h1]
-🔗 [url=https://steamcommunity.com/workshop/filedetails/discussion/2830826239/3409804177172972154/]Reinforcement Weapon Pack[/url]
+
-🔗 [url=https://steamcommunity.com/workshop/filedetails/discussion/2830826239/3409804177173363434/]Warface Arsenal[/url]
+[h1]Notes[/h1]
+📌 Mutator does not contain custom weapons. You must have the required weapon packs in your subscriptions to be able to add them to the trader.
+📌 If you are using this mutator to add weapons, you should [b]not[/b] use mutators from weapon packs (just having them in subscriptions is enough).
+📌 Unlike [url=https://steamcommunity.com/sharedfiles/filedetails/?id=2193261170]DLC Weapon Unlocker[/url], a different method is used here.
+[url=https://steamcommunity.com/sharedfiles/filedetails/?id=2193261170]DLC Weapon Unlocker[/url] creates clones of DLC weapons and adds them to the trader. This allows you not to replace any classes in the game, so Hunter mutator has better compatibility with other mutators. However, those who have already purchased the DLC will not be able to use their skins on clones.
+CTI unlocks DLC weapons differently - it changes the trader filter allowing you to buy original DLC weapons without restrictions. Those who bought the DLC can use their skins and you don't need to update the mutator when new kf2 updates are released - unlocking will work with future weapons as well. However, when you set UnlockDLC=True CTI replaces the [b]KFGFxMoviePlayer_Manager[/b] class, so CTI may not be compatible with mods that replaces this class too. If you notice any compatibility issues, try turning off UnlockDLC.
+You can use this built-in method or add weapons from [url=https://steamcommunity.com/workshop/filedetails/discussion/2193261170/3046108212603783998]DLC Weapon Unlocker[/url] - choose what suits you best.
 
 [h1]Sources[/h1]
 [url=https://github.com/GenZmeY/KF2-CustomTraderInventory]https://github.com/GenZmeY/KF2-CustomTraderInventory[/url] (GNU GPLv3)

README.md

@@ -11,10 +11,10 @@
 Add/Remove Items in the Trader's Inventory  
 
 # Features
-- remove and/or add items;
+- remove/add items to trader;
+- can preload weapon models (no lags when buying weapons);
 - unlock DLC weapons;
 - correct items sorting (by price);
-- can preload content (no lags during trader time);
 - don't have to worry about adding new guns after each Tripware update.
 
 # Usage & Setup