Merge pull request #797 from TeamREPENTOGON/persistent_entity_mod_data

Add EntitySaveStateManager

Author: Guantol-Lemat

changelog.txt

@@ -1,5 +1,6 @@
 v1.1.x -
 Added:
+* Added EntitySaveStateManager class to support persistent, modded save data for entities.
 * EntityLaser
 	- SetInitSound(SoundEffect sound)
 	- Get/SetNumChainedLasers

libzhl/IsaacRepentance_static.cpp

@@ -602,50 +602,6 @@ void Entity_Bomb::UpdateDirtColor() {
     }
 }
 
-void Entity_Pickup::InitFlipState(CollectibleType collectType, bool setupCollectibleGraphics) {
-	 
-	if (_variant == PICKUP_COLLECTIBLE && CanReroll() && !_dead) {
-
-		EntitySaveState* emptySaveState = new EntitySaveState();
-
-		_flipSaveState.SetP(emptySaveState);
-		EntitySaveState* flipState = _flipSaveState.saveState;
-
-		flipState->type = _type, flipState->variant = _variant;
-
-		RNG rng = RNG();
-		rng.SetSeed(_initSeed, 39);
-		unsigned int seed = rng.Next();
-
-		flipState->_initSeed = seed;
-
-		int collectibleID = (collectType != COLLECTIBLE_NULL) ? collectType :  g_Game->_itemPool.GetSeededCollectible(flipState->_initSeed, true, g_Game->_room->_descriptor); //to-do: add valid itemconfig check
-
-		flipState->subtype = collectibleID;
-
-		_altPedestalANM2.Reset();
-		if (setupCollectibleGraphics) {
-			
-
-			ANM2 copySprite = ANM2();
-			copySprite.construct_from_copy(&_sprite);
-
-			Isaac::SwapANM2(&_altPedestalANM2, &copySprite);
-
-			Entity_Pickup::SetupCollectibleGraphics(&_altPedestalANM2, 1, (CollectibleType)flipState->subtype, flipState->_initSeed, false);
-
-			_altPedestalANM2.LoadGraphics(true);
-
-			_altPedestalANM2.Play(_sprite.GetAnimationData(0)->GetName().c_str(), true);
-			_altPedestalANM2.Update();
-		}
-	}
-
-	
-
-	return;
-}
-
 void DestinationQuad::RotateRadians(const Vector& pivot, float radians)
 {
 	if (radians == 0.0)
@@ -680,4 +636,26 @@ void DestinationQuad::RotateRadians(const Vector& pivot, float radians)
 	_topRight += pivot;
 	_bottomLeft += pivot;
 	_bottomRight += pivot;
+}
+
+ModReference* LuaEngine::GetModRefByTable(int tblIdx)
+{
+	lua_State* L = this->_state;
+	int tblAbsIdx = lua_absindex(L, tblIdx);
+	std::list<ModReference>& mods = g_Mods;
+
+	for (ModReference& mod : mods)
+	{
+		int modRefTbl = mod._luaTableRef->_ref;
+		lua_rawgeti(L, LUA_REGISTRYINDEX, modRefTbl);
+		bool eq = lua_rawequal(L, tblAbsIdx, -1);
+		lua_pop(L, 1);
+
+		if (eq)
+		{
+			return &mod;
+		}
+	}
+
+	return nullptr;
 }

libzhl/functions/ASM.zhl

@@ -201,4 +201,29 @@ asm EntityPlayer_RecomputeWispCollectibles_TriggerCollectibleRemoved "e8????????
 // ExtraRenderSteps
 asm Manager_Init_PreInitCursor "0f84????????c785????????000000006a20";
 asm Manager_Render_PreCursorRender "80bf????????000f84????????8b47??83f80274";
-asm Manager_Render_OnCursorRender "e8????????a1????????80b8????????000f84????????b9";
+asm Manager_Render_OnCursorRender "e8????????a1????????80b8????????000f84????????b9";
+
+// EntitySaveStateManagement
+asm KAGE_ReferenceCount_EntitySaveState_DecrementReference_SaveStateDestructor "e8????????6a7857";
+asm Game_RestoreState_PostBackwardsStageDescRestore "8987????????8b4e??c70600000000";
+asm Level_Init_PostMyosotisEffect "8b35????????8d87????????8987";
+asm Level_RestoreGameState_PreRoomLoad "8983????????e8????????e8";
+asm Level_place_rooms_backwards_Boss_AssignEntitySaveStateVector "ff75??ff36ff76??e8????????8b55";
+asm Level_place_rooms_backwards_Treasure_AssignEntitySaveStateVector "ff75??8bcaff36";
+asm Level_generate_dark_closet_PostGenerateCollectibleSaveState "c745??010000008bc2";
+asm Room_SaveState_ClearSavedEntities "8b4e??83c174";
+asm Room_RestoreState_ClearSavedEntities "8b78??8b70??3bf7";
+asm PlayerManager_RestoreGameState_AssignBackupFamiliarData "ff75??ffb3";
+asm EntityPlayer_UseActiveItem_MovingBox_ClearVector "8d8f????????e8????????6a006848020000";
+asm EntityPlayer_StoreGameState_FamiliarStoreState "8b8e????????3b8e";
+asm EntityPlayer_StoreGameState_AssignUnlistedFamiliarData "ff75??ff70??ff30e8????????e9";
+asm EntityPickup_InitFlipState_PostSaveStateConstructor "8db7????????508bcee8????????8b0e";
+asm EntityPickup_TryFlip_PostRestoreFlipState "837d??0075??33c0";
+asm EntityNPC_ai_mothers_shadow_ChangeMineshaftRoom "8b41??6aff";
+
+// EntityLifecycle
+asm EntityList_destructor_RemoveEntityMainEL "8b0c??8b01ff50??463b77??72??33f6";
+asm EntityList_destructor_RemoveEntityPersistentEL "8b0c??8b01ff50??463b77??72??8d9f";
+asm EntityList_Reset_RemoveNonPersistentEntity "8b0c??8b01ff50??463b73";
+asm EntityList_Update_RemoveEntityMainEL "8b028bcaff50??8b47";
+asm EntityList_Update_RemoveEntityPersistentEL "8a82????????8bca";

libzhl/functions/Entity.zhl

@@ -193,6 +193,7 @@ struct Entity depends (AnimationState, ANM2, RNG, Vector, EntityPtr) {
     bool _visible : 0x171;
     bool _exists : 0x172;
     bool _dead : 0x173;
+	bool _removedByFactory : 0x177;
     int _entityGridCollisionClass : 0x184;
     int _entityCollisionClass : 0x188;
     // 0x18c is a boolean related to collisions. Seems to be essentially a "_collidesWithEntity"
@@ -279,7 +280,10 @@ struct Entity depends (AnimationState, ANM2, RNG, Vector, EntityPtr) {
 		void SetColor(ColorMod *color, int Duration, int Priority, bool Fadeout, bool Shared);
 
 		skip; // SetCollisionDamage
-		skip; // ClearReferences
+
+		"558bec515356578bf98b8f":
+		void ClearReferences();
+
 		skip; // CanShutDoors
 		skip; // IsBoss
 		skip; // IsValidTarget

libzhl/functions/EntityFactory.zhl

@@ -1,6 +1,7 @@
 "558bec518b45??535657":
 __thiscall Entity* EntityFactory::Create(unsigned int type, bool force);
 
-struct EntityFactory depends(Entity, Entity_Familiar){
-	Entity_Familiar _familiar[64] : 0xf8008;
+struct EntityFactory depends(Entity, Entity_Familiar, Entity_Pickup){
+	Entity_Familiar _familiar[64] : 0x130008;
+	Entity_Pickup _pickup[512] : 0x357630;
 } : 0x695c60 ;

libzhl/functions/EntityFamiliar.zhl

@@ -67,6 +67,9 @@ __thiscall void Entity_Familiar::delirium_morph();
 "558bec6aff68????????64a1????????5083ec24535657a1????????33c5508d45??64a3????????894d??8b0d":
 static __fastcall int Entity_Familiar::GetRandomWisp(RNG& rng);
 
+"558bec6aff68????????64a1????????5081ec80000000a1????????33c58945??535657508d45??64a3????????8bf9":
+__thiscall void Entity_Familiar::RestoreState(FamiliarData* saveData);
+
 struct Entity_Familiar depends (ColorMod, ItemConfig_Item, NPCAI_Pathfinder) : public Entity {
 {{
 	inline Entity_Player** GetPlayer() { return &this->_player; }

libzhl/functions/EntityNPC.zhl

@@ -94,6 +94,9 @@ __thiscall void Entity_NPC::Hornfel_UpdateAI();
 "558bec83e4f85153568bf15783be????????0a":
 __thiscall void Entity_NPC::Hornfel_UpdateFrame();
 
+"558bec6aff68????????64a1????????5081ec2c010000":
+static __cdecl void Entity_NPC::moms_heart_mausoleum_death();
+
 /*
 // Minecart functions
 "558bec51538bd98b8b":

libzhl/functions/EntityPickup.zhl

@@ -89,8 +89,6 @@ struct Entity_Pickup depends (ANM2, KAGE_SmartPointer_EntitySaveState) : public
 	static inline bool ShouldIgnoreModifiers() { return s_EntityPickup_IgnoreModifiers != 0; }
 	static inline void BeginIgnoreModifiers() { s_EntityPickup_IgnoreModifiers++; }
 	static inline void EndIgnoreModifiers() { s_EntityPickup_IgnoreModifiers--; }
-	
-	void LIBZHL_API Entity_Pickup::InitFlipState(CollectibleType collectType, bool setupCollectibleGraphics);
 }} 
 
 	__vtable {

libzhl/functions/EntityPlayer.zhl

@@ -8,6 +8,9 @@ __thiscall void Entity_Player::AnimatePickup(ANM2 *param_1,bool param_2,char *pa
 "538bdc83ec0883e4f883c404558b6b??896c24??8bec6aff68????????64a1????????505383ec085657a1????????33c5508d45??64a3????????8bf9":
 __thiscall void Entity_Player::constructor();
 
+"558bec6aff68????????64a1????????5051535657a1????????33c5508d45??64a3????????8bf98b8f":
+__thiscall void Entity_Player::destructor();
+
 "558bec83e4f8a1????????83ec1483b8????????02":
 __thiscall void Entity_Player::update_red_hearts();
 
@@ -570,10 +573,19 @@ __thiscall bool Entity_Player::HasInvincibility(uint64_t damageFlags, EntityRef*
 "558bec6aff68????????64a1????????50b8dc190000":
 __thiscall void Entity_Player::UseActiveItem(short* resultFlags, CollectibleType collectible, unsigned int useFlags, int activeSlot, int varData);
 
+"538bdc83ec0883e4f883c404558b6b??896c24??8bec6aff68????????64a1????????505381ec800000005657a1????????33c5508d45??64a3????????8bf9":
+__thiscall void Entity_Player::StoreGameState(GameStatePlayer* saveState, bool saveTemporaryFamiliars);
+
+"538bdc83ec0883e4f883c404558b6b??896c24??8bec6aff68????????64a1????????505383ec40a1????????33c58945??5657508d45??64a3????????8bf9897d??83bf????????00":
+__thiscall void Entity_Player::RestoreGameState(GameStatePlayer* saveState);
+
+"558bec83e4f883ec6453568b75":
+__thiscall void Entity_Player::RestoreGameState_PostLevelInit(GameStatePlayer* saveState);
+
 "558bec83e4f883ec1453568bf157897424":
 __thiscall Entity_Pickup* Entity_Player::DropTrinket(Vector* DropPos, bool ReplaceTick);
 
-struct Entity_Player depends (Vector, ANM2, ColorMod, KColor, PlayerCostumeMap, TemporaryEffects, ConsumableData, History, BagOfCraftingOutput, EntityDesc) : public Entity { {{
+struct Entity_Player depends (Vector, ANM2, ColorMod, KColor, PlayerCostumeMap, TemporaryEffects, ConsumableData, History, BagOfCraftingOutput, EntityDesc, GameStatePlayer) : public Entity { {{
     inline int* GetMaxHearts() {return &this->_maxHearts; }
 	inline int* GetRedHearts() {return &this->_redHearts; }
 	inline int* GetEternalHearts() {return &this->_eternalHearts; }
@@ -806,6 +818,9 @@ struct Entity_Player depends (Vector, ANM2, ColorMod, KColor, PlayerCostumeMap,
 	int _wildCardItem : 0x2068;
 	bool _isCoopGhost : 0x207d;
 	PlayerHUD* _playerHUD : 0x20a8;
+	bool _hasUnlistedRestoreState : 0x20bc; // States if the _unlistedRestoreState is usable
+	GameStatePlayer _unlistedRestoreState : 0x20c0; // This state represents the state the player was in before being replaced by a player that was not in the player list (this is used by T.Lazarus and Esau Jr.)
+	Entity_Player* _replacedPlayer : 0x267c; // The other player in the last PlayerManager::ReplacePlayer for this player
 } : 0x2ea0;
 
 "68(????????)68????????f30f59c16a00":

libzhl/functions/EntitySaveState.zhl

@@ -1,10 +1,10 @@
 "33c0c701000000008941":
 __thiscall void EntitySaveState::constructor();
 
-"558bec6aff68????????64a1????????505657a1????????33c5508d45??64a3????????8bf98d77??c745??000000008b4e??85c974??8b018b40??ffd084c074??a1????????85c074??56ffd083c4048d77??c745??010000008b4e??85c974??8b018b40??ffd084c074??a1????????85c074??56ffd083c4048b4d??64890d????????595f5e8be55dc3??????????????????????????????????????558bec6aff68????????64a1????????5083ec14":
-__thiscall void** EntitySaveState::Clear();
+"558bec6aff68????????64a1????????505657a1????????33c5508d45??64a3????????8bf98d77??c745??000000008b4e??85c974??8b018b40??ffd084c074??a1????????85c074??56ffd083c4048d77??c745??010000008b4e??85c974??8b018b40??ffd084c074??a1????????85c074??56ffd083c4048b4d??64890d????????595f5e8be55dc3??????????????????????????????????????55":
+__thiscall void EntitySaveState::destructor();
 
-struct EntitySaveState depends (Vector) {
+struct EntitySaveState depends (Vector, KAGE_SmartPointer_EntitySaveState) {
     int type : 0x0;
     int variant : 0x4;
     int subtype : 0x8;
@@ -13,12 +13,12 @@ struct EntitySaveState depends (Vector) {
 	unsigned int intStorage3 : 0x14;
     int intStorage4 : 0x18;
 	int intStorage5 : 0x1c;
-    int16_t gridSpawnIdx : 0x20;
+    int16_t gridSpawnIdx : 0x20; // HIJACKED by ESSM
 	bool boolStorage1 : 0x22;
 	bool boolStorage2 : 0x23;
 	unsigned int intStorage6 : 0x24;
     Vector targetPosition : 0x28;
-	unsigned int _intStorage7 : 0x30;
+	unsigned int _intStorage7 : 0x30; // HIJACKED by ESSM
     unsigned int _initSeed : 0x34;
 	unsigned int _dropSeed : 0x38;
     int spawnerType : 0x3c;
@@ -27,71 +27,11 @@ struct EntitySaveState depends (Vector) {
 	float floatStorage2 : 0x54;
 	unsigned int intStorage8: 0x5c;
 	int8_t byteStorage : 0x60;
+	KAGE_SmartPointer_EntitySaveState entitySaveState : 0x6c;
 
 	{{
-		struct Bomb;
-		struct Pickup;
-		struct NPC; // FIREPLACE and MOVABLE_TNT only
-		struct Effect;
-		struct Minecart;
-		
 		EntitySaveState() {
 			this->constructor();
 		}
-		
 	}}
-} : 0x78;
-
-{{
-	struct EntitySaveState::Bomb
-	{
-		static inline uint32_t* GetScale(EntitySaveState& saveState) { return (uint32_t*)&saveState.intStorage1; }
-		static inline BitSet128* GetTearFlags(EntitySaveState& saveState) { return (BitSet128*)&saveState.intStorage2; }
-		static inline bool* GetIsFetus(EntitySaveState& saveState) { return (bool*)&saveState.boolStorage2; }
-		static inline float* GetExplosionDamage(EntitySaveState& saveState) { return (float*)&saveState.floatStorage1; }
-		static inline float* GetRadiusMulti(EntitySaveState& saveState) { return (float*)&saveState.floatStorage2; }
-		static inline int8_t* GetSpawnerPlayerIndex(EntitySaveState& saveState) { return (int8_t*)&saveState.byteStorage; } // -1 if not spawned by player
-	};
-
-	struct EntitySaveState::Pickup
-	{
-		static inline int* GetCharge(EntitySaveState& saveState) { return (int*)&saveState.intStorage2; }
-		static inline int* GetPrice(EntitySaveState& saveState) { return (int*)&saveState.intStorage3; }
-		static inline bool* GetAutoUpdatePrice(EntitySaveState& saveState) { return (bool*)&saveState.byteStorage; }
-		static inline int* GetShopItemId(EntitySaveState& saveState) { return (int*)&saveState.intStorage4; }
-		static inline bool* GetTouched(EntitySaveState& saveState) { return (bool*)&saveState.boolStorage1; }
-		static inline int* GetOptionsPickupIndex(EntitySaveState& saveState) { return (int*)&saveState._intStorage7; }
-		static inline int* GetTimeout(EntitySaveState& saveState) { return (int*)&saveState.intStorage5; }
-		static inline bool* GetIsBlind(EntitySaveState& saveState) { return (bool*)&saveState.boolStorage2; }
-		static inline int* GetAlternatePedestal(EntitySaveState& saveState) { return (int*)&saveState.intStorage1; }
-		static inline int* GetActiveVarData(EntitySaveState& saveState) { return (int*)&saveState.intStorage8; }
-		static inline int* GetSourcePoolType(EntitySaveState& saveState) { return (int*)&saveState.floatStorage1; }
-		static inline float* GetSpriteScale(EntitySaveState& saveState) { return (float*)&saveState.floatStorage2; }
-		static inline std::array<int, 8>* GetCycleCollectibles(EntitySaveState& saveState) { return *(std::array<int, 8>**)((char*)&saveState + 0x64); } // 0 is used as a terminator if < 8
-		static inline EntitySaveState* GetFlipSaveState(EntitySaveState& saveState) { return *(EntitySaveState**)((char*)&saveState + 0x6c); }
-	};
-
-	struct EntitySaveState::Slot
-	{
-		static inline int* GetDonationValue(EntitySaveState& saveState) { return (int*)&saveState.intStorage1; }
-		static inline int* GetTriggerTimer(EntitySaveState& saveState) { return (int*)&saveState.intStorage2; } // Only used by SHOP_RESTOCK_MACHINE 
-		static inline int* GetPrizeCollectible(EntitySaveState& saveState) { return (int*)&saveState._intStorage7; }
-	};
-
-	struct EntitySaveState::NPC // FIREPLACE and MOVABLE_TNT
-	{
-		static inline int* GetHealth(EntitySaveState& saveState) { return (int*)&saveState.intStorage1; }
-	};
-
-	struct EntitySaveState::Effect
-	{
-		static inline int* GetState(EntitySaveState& saveState) { return (int*)&saveState.intStorage1; } // Used by DIRT_PATCH, SPAWNER and LIL_GHOST
-		static inline int* GetVarData0(EntitySaveState& saveState) { return (int*)&saveState.intStorage4; } // Used by SPAWNER
-		static inline int* GetVarData1(EntitySaveState& saveState) { return (int*)&saveState.intStorage2; } // Used by SPAWNER
-	};
-
-	struct EntitySaveState::Minecart
-	{
-		static inline float* GetAngleDegrees(EntitySaveState& saveState) { return (float*)&saveState.floatStorage1; }
-	};
-}}
+} : 0x78; // 0x78