Merge pull request #385 from BF3RM/feat/saveOrder

MotorcycleEnjoyer · web-flow · commit 575d1de28c3a · 2024-08-01T15:32:48.000-04:00
Feat/save order
diff --git a/ext/Server/ProjectManager.lua b/ext/Server/ProjectManager.lua
@@ -3,7 +3,7 @@ ProjectManager = class 'ProjectManager'
 
 local m_Logger = Logger("ProjectManager", false)
 
-local SAVE_VERSION = "0.1.1"
+local SAVE_VERSION = "0.1.2"
 
 function ProjectManager:__init()
 	m_Logger:Write("Initializing ProjectManager")
@@ -19,6 +19,7 @@ function ProjectManager:RegisterVars()
 	self.m_MapName = nil
 	self.m_GameMode = nil
 	self.m_LoadedBundles = {}
+	self.m_GUID_To_Timestamps = {}
 end
 
 function ProjectManager:RegisterEvents()
@@ -92,10 +93,11 @@ end
 ---@param p_ProjectSave ProjectSave
 ---@return ProjectSave|nil projectSave, string|nil errorMessage
 function ProjectManager:UpgradeSaveStructure(p_ProjectSave)
-	local s_SaveVersion = p_ProjectSave[DataBaseManager.m_ExportDataName].saveVersion
+	local s_SaveVersion = p_ProjectSave[DataBaseManager.m_ExportHeaderName].saveVersion
 
 	if s_SaveVersion == nil then -- Save from before versioning was implemented, try to upgrade to current version
 		local s_Data = p_ProjectSave[DataBaseManager.m_ExportDataName]
+		self:InsertTimestampsIntoObjects(s_Data)
 
 		-- Some pre-versioning save files had an isVanilla flag
 		for _, l_DataEntry in pairs(s_Data) do
@@ -110,12 +112,25 @@ function ProjectManager:UpgradeSaveStructure(p_ProjectSave)
 		return p_ProjectSave
 	elseif s_SaveVersion > SAVE_VERSION then
 		return nil, 'Importing save with a higher save format version than supported, please update MapEditor before importing'
-	else
+	elseif s_SaveVersion < SAVE_VERSION then
 		-- New version updates are handled here
+		local s_Data = p_ProjectSave[DataBaseManager.m_ExportDataName]
+		self:InsertTimestampsIntoObjects(s_Data)
 
 		-- Update save version
 		p_ProjectSave[DataBaseManager.m_ExportHeaderName].saveVersion = SAVE_VERSION
 		return p_ProjectSave
+	elseif s_SaveVersion == SAVE_VERSION then
+		return p_ProjectSave
+	end
+end
+
+---@param p_Data table
+function ProjectManager:InsertTimestampsIntoObjects(p_Data)
+	for l_Index, l_DataEntry in ipairs(p_Data) do
+		if not l_DataEntry.timeStamp then
+			l_DataEntry.timeStamp = 1000000000000 + l_Index
+		end
 	end
 end
 
@@ -233,11 +248,21 @@ function ProjectManager:OnUpdatePass(p_Delta, p_Pass)
 		local s_Msg
 		s_ProjectSave, s_Msg = self:UpgradeSaveStructure(s_ProjectSave)
 
+
 		if s_ProjectSave == nil then
 			m_Logger:Error("Can't load project. Error: " .. tostring(s_Msg))
 			return
 		end
 
+		if s_ProjectSave.data ~= nil then
+			for l_Index, l_Value in ipairs(s_ProjectSave.data) do
+				-- store the timestamps to reference later
+				self.m_GUID_To_Timestamps[l_Value.guid] = l_Value.timeStamp
+				-- print(l_Value.timeStamp)
+			end
+			NetEvents:BroadcastLocal("Shared:StoreTimeStamps", self.m_GUID_To_Timestamps)
+		end
+
 		self:CreateAndExecuteImitationCommands(s_ProjectSave[DataBaseManager.m_ExportDataName])
 	end
 end
@@ -265,7 +290,6 @@ function ProjectManager:OnRequestProjectLoad(p_Player, p_ProjectId)
 		Maps[s_MapName] == nil or
 		s_GameModeName == nil or
 		GameModes[s_GameModeName] == nil then
-
 		m_Logger:Error("Failed to load project, one or more fields of the project header are not set: " .. s_MapName .. " | " .. s_GameModeName)
 		return
 	end
@@ -311,11 +335,22 @@ function ProjectManager:SaveProjectCoroutine(p_ProjectHeader)
 	-- TODO: get the GameObjectSaveDatas not from the transferdatas array, but from the GO array of the GOManager. (remove the GOTD array)
 	for _, l_GameObject in pairs(GameObjectManager.m_GameObjects) do
 		if l_GameObject:IsUserModified() == true or l_GameObject:HasOverrides() then
+			-- check the old values that are stored
+			local s_Guid = tostring(l_GameObject.guid)
+			if self.m_GUID_To_Timestamps[s_Guid] ~= nil then
+				l_GameObject.timeStamp = self.m_GUID_To_Timestamps[s_Guid]
+			else
+				self.m_GUID_To_Timestamps[s_Guid] = l_GameObject.timeStamp
+			end
 			s_Count = s_Count + 1
 			table.insert(s_GameObjectSaveDatas, GameObjectSaveData(l_GameObject):GetAsTable())
 		end
 	end
 
+	table.sort(s_GameObjectSaveDatas, function(a, b)
+		return a.timeStamp < b.timeStamp
+	end)
+
 	-- m_Logger:Write("vvvvvvvvvvvvvvvvv")
 	-- m_Logger:Write("GameObjectSaveDatas: " .. count)
 	-- for _, gameObjectSaveData in pairs(s_GameObjectSaveDatas) do
@@ -352,6 +387,7 @@ function ProjectManager:CreateAndExecuteImitationCommands(p_ProjectSaveData)
 		--end
 
 		local s_Command
+		local s_TimeStamp = self.m_GUID_To_Timestamps[s_Guid]
 
 		-- Vanilla and nohavok objects are handled in levelloader
 		if l_GameObjectSaveData.origin == GameObjectOriginType.Vanilla or
@@ -362,7 +398,8 @@ function ProjectManager:CreateAndExecuteImitationCommands(p_ProjectSaveData)
 					sender = "LoadingSaveFile",
 					type = CommandActionType.DeleteGameObjectCommand,
 					gameObjectTransferData = {
-						guid = s_Guid
+						guid = s_Guid,
+						timeStamp = s_TimeStamp
 					}
 				}
 			else
@@ -372,7 +409,8 @@ function ProjectManager:CreateAndExecuteImitationCommands(p_ProjectSaveData)
 					type = CommandActionType.SetTransformCommand,
 					gameObjectTransferData = {
 						guid = s_Guid,
-						transform = l_GameObjectSaveData.transform
+						transform = l_GameObjectSaveData.transform,
+						timeStamp = s_TimeStamp
 					}
 				}
 			end
@@ -390,6 +428,7 @@ function ProjectManager:CreateAndExecuteImitationCommands(p_ProjectSaveData)
 					name = l_GameObjectSaveData.name,
 					blueprintCtrRef = l_GameObjectSaveData.blueprintCtrRef,
 					parentData = l_GameObjectSaveData.parentData or GameObjectParentData:GetRootParentData(),
+					timeStamp = s_TimeStamp,
 					transform = l_GameObjectSaveData.transform,
 					variation = l_GameObjectSaveData.variation or 0,
 					gameEntities = {},
diff --git a/ext/Shared/Modules/CommandActions.lua b/ext/Shared/Modules/CommandActions.lua
@@ -45,14 +45,15 @@ function CommandActions:SpawnGameObject(p_Command, p_UpdatePass)
 	end
 
 	local s_SpawnResult = GameObjectManager:InvokeBlueprintSpawn(s_GameObjectTransferData.guid:upper(),
-																p_Command.sender,
-																s_GameObjectTransferData.blueprintCtrRef.partitionGuid,
-																s_GameObjectTransferData.blueprintCtrRef.instanceGuid,
-																s_GameObjectTransferData.parentData,
-																s_GameObjectTransferData.transform,
-																s_GameObjectTransferData.variation,
-																false,
-																s_GameObjectTransferData.overrides
+		p_Command.sender,
+		s_GameObjectTransferData.blueprintCtrRef.partitionGuid,
+		s_GameObjectTransferData.blueprintCtrRef.instanceGuid,
+		s_GameObjectTransferData.parentData,
+		s_GameObjectTransferData.transform,
+		s_GameObjectTransferData.variation,
+		false,
+		s_GameObjectTransferData.overrides,
+		s_GameObjectTransferData.timeStamp
 	)
 
 	if s_SpawnResult == false then
@@ -94,6 +95,7 @@ function CommandActions:DeleteGameObject(p_Command, p_UpdatePass)
 
 	local s_GameObjectTransferData = {
 		guid = p_Command.gameObjectTransferData.guid,
+		timeStamp = p_Command.gameObjectTransferData.timeStamp,
 		isDeleted = true
 	}
 
@@ -119,7 +121,7 @@ function CommandActions:UndeleteGameObject(p_Command, p_UpdatePass)
 	m_Logger:Write("UndeleteGameObject with guid " .. p_Command.gameObjectTransferData.guid)
 
 	if SanitizeEnum(p_Command.gameObjectTransferData.origin) == GameObjectOriginType.Custom or
-			SanitizeEnum(p_Command.gameObjectTransferData.origin) == GameObjectOriginType.CustomChild then
+		SanitizeEnum(p_Command.gameObjectTransferData.origin) == GameObjectOriginType.CustomChild then
 		return CommandActions:SpawnGameObject(p_Command, p_UpdatePass)
 	end
 
@@ -234,7 +236,8 @@ function CommandActions:SetTransform(p_Command, p_UpdatePass)
 
 	local s_GameObjectTransferData = {
 		guid = p_Command.gameObjectTransferData.guid,
-		transform = p_Command.gameObjectTransferData.transform
+		transform = p_Command.gameObjectTransferData.transform,
+		timeStamp = p_Command.gameObjectTransferData.timeStamp
 	}
 
 	local s_CommandActionResult = {
@@ -246,7 +249,6 @@ function CommandActions:SetTransform(p_Command, p_UpdatePass)
 	return s_CommandActionResult, CARResponseType.Success
 end
 
-
 function CommandActions:SetVariation(p_Command, p_UpdatePass)
 	if p_Command.gameObjectTransferData == nil then
 		m_Logger:Error("The SetTransform needs to have a valid gameObjectTransferData set.")
diff --git a/ext/Shared/Modules/GameObjectManager.lua b/ext/Shared/Modules/GameObjectManager.lua
@@ -10,6 +10,16 @@ function GameObjectManager:__init(p_Realm)
 	m_Logger:Write("Initializing GameObjectManager: " .. tostring(p_Realm))
 	self.m_Realm = p_Realm
 	self:RegisterVars()
+	self:RegisterEvents()
+end
+
+function GameObjectManager:RegisterEvents()
+	Events:Subscribe("Shared:StoreTimeStamps", self, self.StoreTimeStamps)
+end
+
+---@param p_GUID_To_Timestamps table
+function GameObjectManager:StoreTimeStamps(p_GUID_To_Timestamps)
+	self.m_GUID_To_Timestamps = p_GUID_To_Timestamps
 end
 
 function GameObjectManager:RegisterVars()
@@ -24,6 +34,9 @@ function GameObjectManager:RegisterVars()
 
 	--- key: child (ReferenceObjectData) guid, value: parent GameObject guid
 	self.m_ReferenceObjectDatas = {}
+
+	-- workaround for origin type 3
+	self.m_GUID_To_Timestamps = {}
 end
 
 function GameObjectManager:OnLevelDestroy()
@@ -44,7 +57,8 @@ end
 ---@param p_Variation integer
 ---@param p_IsPreviewSpawn boolean
 ---@param p_Overrides table
-function GameObjectManager:InvokeBlueprintSpawn(p_GameObjectGuid, p_SenderName, p_BlueprintPartitionGuid, p_BlueprintInstanceGuid, p_ParentData, p_LinearTransform, p_Variation, p_IsPreviewSpawn, p_Overrides)
+---@param p_TimeStamp number
+function GameObjectManager:InvokeBlueprintSpawn(p_GameObjectGuid, p_SenderName, p_BlueprintPartitionGuid, p_BlueprintInstanceGuid, p_ParentData, p_LinearTransform, p_Variation, p_IsPreviewSpawn, p_Overrides, p_TimeStamp)
 	if p_BlueprintPartitionGuid == nil or
 		p_BlueprintInstanceGuid == nil or
 		p_LinearTransform == nil then
@@ -66,15 +80,15 @@ function GameObjectManager:InvokeBlueprintSpawn(p_GameObjectGuid, p_SenderName,
 
 	-- m_Logger:Write('Invoking spawning of blueprint: '.. s_ObjectBlueprint.name .. " | ".. s_Blueprint.typeInfo.name .. ", ID: " .. p_GameObjectGuid .. ", Instance: " .. tostring(p_BlueprintInstanceGuid) .. ", Variation: " .. p_Variation)
 	if p_IsPreviewSpawn == false then
-		self.m_PendingCustomBlueprintGuids[p_BlueprintInstanceGuid] = { customGuid = p_GameObjectGuid, creatorName = p_SenderName, parentData = p_ParentData, overrides = p_Overrides }
+		self.m_PendingCustomBlueprintGuids[p_BlueprintInstanceGuid] = { customGuid = p_GameObjectGuid, creatorName = p_SenderName, parentData = p_ParentData, overrides = p_Overrides, timeStamp = p_TimeStamp }
 	else
 		local s_PreviewSpawnParentData = GameObjectParentData {
 			guid = EMPTY_GUID, -- Root
 			typeName = "previewSpawn",
 		}
 		m_Logger:Write("Added s_PreviewSpawnParentData: " .. tostring(s_PreviewSpawnParentData.guid))
 		m_Logger:WriteTable(s_PreviewSpawnParentData)
-		self.m_PendingCustomBlueprintGuids[p_BlueprintInstanceGuid] = { customGuid = p_GameObjectGuid, creatorName = p_SenderName, parentData = s_PreviewSpawnParentData, overrides = p_Overrides }
+		self.m_PendingCustomBlueprintGuids[p_BlueprintInstanceGuid] = { customGuid = p_GameObjectGuid, creatorName = p_SenderName, parentData = s_PreviewSpawnParentData, overrides = p_Overrides, timeStamp = p_TimeStamp }
 	end
 
 	local s_Params = EntityCreationParams()
@@ -153,6 +167,14 @@ function GameObjectManager:OnEntityCreateFromBlueprint(p_HookCtx, p_Blueprint, p
 		end
 	end
 
+	local s_TimeStamp
+	if s_PendingCustomBlueprintInfo then
+		s_TimeStamp = s_PendingCustomBlueprintInfo.timeStamp
+	end
+	if not s_TimeStamp then
+		s_TimeStamp = SharedUtils:GetTimeMS()
+	end
+
 	---@type GameObject
 	local s_GameObject = GameObject {
 		guid = GenerateTempGuid(), -- we set a tempGuid, it will later be set to a vanilla or custom guid
@@ -161,6 +183,7 @@ function GameObjectManager:OnEntityCreateFromBlueprint(p_HookCtx, p_Blueprint, p
 		transform = p_Transform,
 		variation = s_Variation,
 		origin = GameObjectOriginType.Vanilla,
+		timeStamp = s_TimeStamp,
 		isDeleted = false,
 		isEnabled = true,
 		gameEntities = {},
@@ -318,9 +341,9 @@ function GameObjectManager:OnEntityCreateFromBlueprint(p_HookCtx, p_Blueprint, p
 			-- TODO: update blueprint data with the correct realm if its client or server only
 			if self.m_Realm == Realm.Realm_Server then
 				m_Logger:Write(s_UnresolvedRODCount .. ' client-only gameobjects weren\'t resolved')
-			-- for l_Guid, l_Value in pairs(self.m_ReferenceObjectDatas) do
-			-- 	m_Logger:Write(tostring(l_Guid) .. ', '..l_Value.typeName)
-			-- end
+				-- for l_Guid, l_Value in pairs(self.m_ReferenceObjectDatas) do
+				-- 	m_Logger:Write(tostring(l_Guid) .. ', '..l_Value.typeName)
+				-- end
 			elseif self.m_Realm == Realm.Realm_Client then
 				m_Logger:Write(s_UnresolvedRODCount .. ' server-only gameobjects weren\'t resolved')
 				-- for l_Guid, l_Value in pairs(self.m_ReferenceObjectDatas) do
@@ -360,7 +383,7 @@ end
 function GameObjectManager:ResolveRootObject(p_GameObject, p_PendingInfo)
 	self.m_GameObjects[tostring(p_GameObject.guid)] = nil -- Remove temp guid from array
 
-	if p_PendingInfo then -- We spawned this custom entitybus
+	if p_PendingInfo then                              -- We spawned this custom entitybus
 		p_GameObject.parentData = GameObjectParentData {
 			guid = p_PendingInfo.parentData.guid,
 			typeName = p_PendingInfo.parentData.typeName,
@@ -369,26 +392,46 @@ function GameObjectManager:ResolveRootObject(p_GameObject, p_PendingInfo)
 		}
 		p_GameObject.guid = Guid(p_PendingInfo.customGuid)
 		p_GameObject.origin = GameObjectOriginType.Custom
+		-- if not p_GameObject.timeStamp or p_GameObject.timeStamp == 0 then
+		-- 	self:InsertTimestamp(p_GameObject)
+		-- end
 	else
-
 		if string.find(p_GameObject.blueprintCtrRef.name:lower(), "nohavok") then
 			local s_BundleName = p_GameObject.blueprintCtrRef.name:gsub('NoHavok_', '')
 			p_GameObject.origin = GameObjectOriginType.NoHavok
 			-- No parent data, add the bundle name as an offset and use a predefined havok guid
 			p_GameObject.guid = self:GetNoHavokGuid(HAVOK_GUID, s_BundleName .. '/' .. p_GameObject.name, p_GameObject.transform.trans)
+			-- if not p_GameObject.timeStamp or p_GameObject.timeStamp == 0 then
+			-- 	self:InsertTimestamp(p_GameObject)
+			-- end
 		else
 			-- This is a vanilla root object
 			p_GameObject.guid = self:GetVanillaGuid(p_GameObject.name, p_GameObject.transform.trans)
 			p_GameObject.origin = GameObjectOriginType.Vanilla
+			-- if not p_GameObject.timeStamp or p_GameObject.timeStamp == 0 then
+			-- 	self:InsertTimestamp(p_GameObject)
+			-- end
 
 			--table.insert(self.m_VanillaGameObjectGuids, p_GameObject.guid)
 			self.m_VanillaGameObjectGuids[tostring(p_GameObject.guid)] = p_GameObject.guid
 		end
 	end
+	-- if p_GameObject.timeStamp == 0 then
+	-- 	self:InsertTimestamp(p_GameObject)
+	-- end
 
 	self.m_GameObjects[tostring(p_GameObject.guid)] = p_GameObject
 end
 
+---@param p_GameObject GameObject
+function GameObjectManager:InsertTimestamp(p_GameObject)
+	local s_ObjectTimeStamp = self.m_GUID_To_Timestamps[tostring(p_GameObject.guid)]
+	if not s_ObjectTimeStamp then
+		s_ObjectTimeStamp = SharedUtils:GetTimeMS()
+	end
+	p_GameObject.timeStamp = s_ObjectTimeStamp
+end
+
 function GameObjectManager:ResolveChildObject(p_GameObject, p_ParentGameObject)
 	-- This is a child of either a custom gameObject or a vanilla gameObject, find the parent!
 	p_GameObject.parentData = GameObjectParentData {
@@ -408,9 +451,16 @@ function GameObjectManager:ResolveChildObject(p_GameObject, p_ParentGameObject)
 	if p_GameObject.origin == GameObjectOriginType.Vanilla then
 		p_GameObject.guid = self:GetVanillaGuid(p_GameObject.name, p_GameObject.transform.trans)
 		--table.insert(self.m_VanillaGameObjectGuids, p_GameObject.guid)
+		-- if not p_GameObject.timeStamp or p_GameObject.timeStamp == 0 then
+		-- 	self:InsertTimestamp(p_GameObject)
+		-- end
 		self.m_VanillaGameObjectGuids[tostring(p_GameObject.guid)] = p_GameObject.guid
 	elseif p_GameObject.origin == GameObjectOriginType.NoHavok then
 		p_GameObject.guid = self:GetNoHavokGuid(p_GameObject.parentData.guid, p_GameObject.name, p_GameObject.transform.trans)
+
+		-- if not p_GameObject.timeStamp or p_GameObject.timeStamp == 0 then
+		-- 	self:InsertTimestamp(p_GameObject)
+		-- end
 	else
 		local i = 1
 		local s_CustomGuid
@@ -422,6 +472,10 @@ function GameObjectManager:ResolveChildObject(p_GameObject, p_ParentGameObject)
 
 		p_GameObject.guid = s_CustomGuid
 		p_GameObject.origin = GameObjectOriginType.CustomChild
+
+		-- if not p_GameObject.timeStamp or p_GameObject.timeStamp == 0 then
+		-- 	self:InsertTimestamp(p_GameObject)
+		-- end
 	end
 
 	self.m_GameObjects[tostring(p_GameObject.guid)] = p_GameObject
diff --git a/ext/Shared/Types/Definitions.lua b/ext/Shared/Types/Definitions.lua
@@ -12,6 +12,7 @@
 ---@field guid string
 ---@field blueprintCtrRef table|nil
 ---@field transform LinearTransform
+---@field timeStamp number
 ---@field origin GameObjectOriginType
 ---@field original table|nil
 ---@field localTransform LinearTransform
diff --git a/ext/Shared/Types/GameObject.lua b/ext/Shared/Types/GameObject.lua
diff --git a/ext/Shared/Types/GameObjectSaveData.lua b/ext/Shared/Types/GameObjectSaveData.lua
