From 0a050622f6d2b535bed3ddf28de9ef861469b759 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Thu, 19 May 2022 21:04:32 -0400 Subject: tweak asset propagator to avoid assumption that assets must be reloaded --- src/SMAPI/Metadata/CoreAssetPropagator.cs | 396 ++++++++++++++---------------- 1 file changed, 188 insertions(+), 208 deletions(-) (limited to 'src') diff --git a/src/SMAPI/Metadata/CoreAssetPropagator.cs b/src/SMAPI/Metadata/CoreAssetPropagator.cs index 6cb5a73a..dabd802d 100644 --- a/src/SMAPI/Metadata/CoreAssetPropagator.cs +++ b/src/SMAPI/Metadata/CoreAssetPropagator.cs @@ -110,12 +110,12 @@ namespace StardewModdingAPI.Metadata { case AssetBucket.Sprite: if (!ignoreWorld) - this.ReloadNpcSprites(propagatedAssets); + this.UpdateNpcSprites(propagatedAssets); break; case AssetBucket.Portrait: if (!ignoreWorld) - this.ReloadNpcPortraits(propagatedAssets); + this.UpdateNpcPortraits(propagatedAssets); break; default: @@ -198,7 +198,7 @@ namespace StardewModdingAPI.Metadata } var oldWarps = GetWarpSet(location); - this.ReloadMap(info); + this.UpdateMap(info); var newWarps = GetWarpSet(location); changedWarps = changedWarps || oldWarps.Count != newWarps.Count || oldWarps.Any(p => !newWarps.Contains(p)); @@ -219,7 +219,7 @@ namespace StardewModdingAPI.Metadata ** Animals ****/ case "animals/horse": - return !ignoreWorld && this.ReloadPetOrHorseSprites(content, assetName); + return !ignoreWorld && this.UpdatePetOrHorseSprites(content, assetName); /**** ** Buildings @@ -249,7 +249,7 @@ namespace StardewModdingAPI.Metadata case "characters/farmer/farmer_base_bald": case "characters/farmer/farmer_girl_base": case "characters/farmer/farmer_girl_base_bald": - return !ignoreWorld && this.ReloadPlayerSprites(assetName); + return !ignoreWorld && this.UpdatePlayerSprites(assetName); case "characters/farmer/hairstyles": // Game1.LoadContent FarmerRenderer.hairStylesTexture = this.LoadTexture(key); @@ -301,10 +301,10 @@ namespace StardewModdingAPI.Metadata return true; case "data/farmanimals": // FarmAnimal constructor - return !ignoreWorld && this.ReloadFarmAnimalData(); + return !ignoreWorld && this.UpdateFarmAnimalData(); case "data/hairdata": // Farmer.GetHairStyleMetadataFile - return this.ReloadHairData(); + return this.UpdateHairData(); case "data/movies": // MovieTheater.GetMovieData case "data/moviesreactions": // MovieTheater.GetMovieReactions @@ -312,7 +312,7 @@ namespace StardewModdingAPI.Metadata return true; case "data/npcdispositions": // NPC constructor - return !ignoreWorld && this.ReloadNpcDispositions(content, assetName); + return !ignoreWorld && this.UpdateNpcDispositions(content, assetName); case "data/npcgifttastes": // Game1.LoadContent Game1.NPCGiftTastes = content.Load>(key); @@ -392,7 +392,7 @@ namespace StardewModdingAPI.Metadata } if (!ignoreWorld) - this.ReloadDoorSprites(content, assetName); + this.UpdateDoorSprites(content, assetName); return true; case "loosesprites/cursors2": // Game1.LoadContent @@ -424,7 +424,7 @@ namespace StardewModdingAPI.Metadata return true; case "loosesprites/suspensionbridge": // SuspensionBridge constructor - return !ignoreWorld && this.ReloadSuspensionBridges(content, assetName); + return !ignoreWorld && this.UpdateSuspensionBridges(content, assetName); /**** ** Content\Maps @@ -455,13 +455,13 @@ namespace StardewModdingAPI.Metadata return false; case "minigames/titlebuttons": // TitleMenu - return this.ReloadTitleButtons(content, assetName); + return this.UpdateTitleButtons(content, assetName); /**** ** Content\Strings ****/ case "strings/stringsfromcsfiles": - return this.ReloadStringsFromCsFiles(content); + return this.UpdateStringsFromCsFiles(content); /**** ** Content\TileSheets @@ -479,14 +479,14 @@ namespace StardewModdingAPI.Metadata return true; case "tilesheets/chairtiles": // Game1.LoadContent - return this.ReloadChairTiles(content, assetName, ignoreWorld); + return this.UpdateChairTiles(content, assetName, ignoreWorld); case "tilesheets/craftables": // Game1.LoadContent Game1.bigCraftableSpriteSheet = content.Load(key); return true; case "tilesheets/critters": // Critter constructor - return !ignoreWorld && this.ReloadCritterTextures(content, assetName) > 0; + return !ignoreWorld && this.UpdateCritterTextures(content, assetName); case "tilesheets/crops": // Game1.LoadContent Game1.cropSpriteSheet = content.Load(key); @@ -540,7 +540,7 @@ namespace StardewModdingAPI.Metadata return true; case "terrainfeatures/grass": // from Grass - return !ignoreWorld && this.ReloadGrassTextures(content, assetName); + return !ignoreWorld && this.UpdateGrassTextures(content, assetName); case "terrainfeatures/hoedirt": // from HoeDirt HoeDirt.lightTexture = content.Load(key); @@ -555,27 +555,27 @@ namespace StardewModdingAPI.Metadata return true; case "terrainfeatures/mushroom_tree": // from Tree - return !ignoreWorld && this.ReloadTreeTextures(content, assetName, Tree.mushroomTree); + return !ignoreWorld && this.UpdateTreeTextures(content, assetName, Tree.mushroomTree); case "terrainfeatures/tree_palm": // from Tree - return !ignoreWorld && this.ReloadTreeTextures(content, assetName, Tree.palmTree); + return !ignoreWorld && this.UpdateTreeTextures(content, assetName, Tree.palmTree); case "terrainfeatures/tree1_fall": // from Tree case "terrainfeatures/tree1_spring": // from Tree case "terrainfeatures/tree1_summer": // from Tree case "terrainfeatures/tree1_winter": // from Tree - return !ignoreWorld && this.ReloadTreeTextures(content, assetName, Tree.bushyTree); + return !ignoreWorld && this.UpdateTreeTextures(content, assetName, Tree.bushyTree); case "terrainfeatures/tree2_fall": // from Tree case "terrainfeatures/tree2_spring": // from Tree case "terrainfeatures/tree2_summer": // from Tree case "terrainfeatures/tree2_winter": // from Tree - return !ignoreWorld && this.ReloadTreeTextures(content, assetName, Tree.leafyTree); + return !ignoreWorld && this.UpdateTreeTextures(content, assetName, Tree.leafyTree); case "terrainfeatures/tree3_fall": // from Tree case "terrainfeatures/tree3_spring": // from Tree case "terrainfeatures/tree3_winter": // from Tree - return !ignoreWorld && this.ReloadTreeTextures(content, assetName, Tree.pineTree); + return !ignoreWorld && this.UpdateTreeTextures(content, assetName, Tree.pineTree); } /**** @@ -585,24 +585,24 @@ namespace StardewModdingAPI.Metadata { // dynamic textures if (assetName.StartsWith("animals/cat")) - return this.ReloadPetOrHorseSprites(content, assetName); + return this.UpdatePetOrHorseSprites(content, assetName); if (assetName.StartsWith("animals/dog")) - return this.ReloadPetOrHorseSprites(content, assetName); + return this.UpdatePetOrHorseSprites(content, assetName); if (assetName.IsDirectlyUnderPath("Animals")) - return this.ReloadFarmAnimalSprites(content, assetName); + return this.UpdateFarmAnimalSprites(content, assetName); if (assetName.IsDirectlyUnderPath("Buildings")) - return this.ReloadBuildings(assetName); + return this.UpdateBuildings(assetName); if (assetName.StartsWith("LooseSprites/Fence")) - return this.ReloadFenceTextures(assetName); + return this.UpdateFenceTextures(assetName); // dynamic data if (assetName.IsDirectlyUnderPath("Characters/Dialogue")) - return this.ReloadNpcDialogue(assetName); + return this.UpdateNpcDialogue(assetName); if (assetName.IsDirectlyUnderPath("Characters/schedules")) - return this.ReloadNpcSchedules(assetName); + return this.UpdateNpcSchedules(assetName); } return false; @@ -613,14 +613,14 @@ namespace StardewModdingAPI.Metadata ** Private methods *********/ /**** - ** Reload texture methods + ** Update texture methods ****/ - /// Reload buttons on the title screen. - /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns whether any textures were reloaded. + /// Update buttons on the title screen. + /// The content manager through which to update the asset. + /// The asset name to update. + /// Returns whether any references were updated. /// Derived from the constructor and . - private bool ReloadTitleButtons(LocalizedContentManager content, IAssetName assetName) + private bool UpdateTitleButtons(LocalizedContentManager content, IAssetName assetName) { if (Game1.activeClickableMenu is TitleMenu titleMenu) { @@ -641,12 +641,12 @@ namespace StardewModdingAPI.Metadata return false; } - /// Reload the sprites for matching pets or horses. + /// Update the sprites for matching pets or horses. /// The animal type. - /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns whether any textures were reloaded. - private bool ReloadPetOrHorseSprites(LocalizedContentManager content, IAssetName assetName) + /// The content manager through which to update the asset. + /// The asset name to update. + /// Returns whether any references were updated. + private bool UpdatePetOrHorseSprites(LocalizedContentManager content, IAssetName assetName) where TAnimal : NPC { // find matches @@ -664,12 +664,12 @@ namespace StardewModdingAPI.Metadata return true; } - /// Reload the sprites for matching farm animals. - /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns whether any textures were reloaded. + /// Update the sprites for matching farm animals. + /// The content manager through which to update the asset. + /// The asset name to update. + /// Returns whether any references were updated. /// Derived from . - private bool ReloadFarmAnimalSprites(LocalizedContentManager content, IAssetName assetName) + private bool UpdateFarmAnimalSprites(LocalizedContentManager content, IAssetName assetName) { // find matches FarmAnimal[] animals = this.GetFarmAnimals().ToArray(); @@ -695,10 +695,10 @@ namespace StardewModdingAPI.Metadata return texture.IsValueCreated; } - /// Reload building textures. - /// The asset name to reload. - /// Returns whether any textures were reloaded. - private bool ReloadBuildings(IAssetName assetName) + /// Update building textures. + /// The asset name to update. + /// Returns whether any references were updated. + private bool UpdateBuildings(IAssetName assetName) { // get paint mask info const string paintMaskSuffix = "_PaintMask"; @@ -731,12 +731,12 @@ namespace StardewModdingAPI.Metadata return removedFromCache; } - /// Reload map seat textures. + /// Update map seat textures. /// The content manager through which to reload the asset. - /// The asset name to reload. + /// The asset name to update. /// Whether the in-game world is fully unloaded (e.g. on the title screen), so there's no need to propagate changes into the world. - /// Returns whether any textures were reloaded. - private bool ReloadChairTiles(LocalizedContentManager content, IAssetName assetName, bool ignoreWorld) + /// Returns whether any references were updated. + private bool UpdateChairTiles(LocalizedContentManager content, IAssetName assetName, bool ignoreWorld) { MapSeat.mapChairTexture = content.Load(assetName.BaseName); @@ -755,11 +755,11 @@ namespace StardewModdingAPI.Metadata return true; } - /// Reload critter textures. + /// Update critter textures. /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns the number of reloaded assets. - private int ReloadCritterTextures(LocalizedContentManager content, IAssetName assetName) + /// The asset name to update. + /// Returns whether any references were updated. + private bool UpdateCritterTextures(LocalizedContentManager content, IAssetName assetName) { // get critters Critter[] critters = @@ -772,21 +772,21 @@ namespace StardewModdingAPI.Metadata ) .ToArray(); if (!critters.Any()) - return 0; + return false; // update sprites Texture2D texture = content.Load(assetName.BaseName); foreach (Critter entry in critters) entry.sprite.spriteTexture = texture; - return critters.Length; + return true; } - /// Reload the sprites for interior doors. + /// Update the sprites for interior doors. /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns whether any doors were affected. - private bool ReloadDoorSprites(LocalizedContentManager content, IAssetName assetName) + /// The asset name to update. + /// Returns whether any references were updated. + private void UpdateDoorSprites(LocalizedContentManager content, IAssetName assetName) { Lazy texture = new Lazy(() => content.Load(assetName.BaseName)); @@ -806,29 +806,12 @@ namespace StardewModdingAPI.Metadata door.Sprite.texture = texture.Value; } } - - return texture.IsValueCreated; - } - - /// Reload the data for matching farm animals. - /// Returns whether any farm animals were affected. - /// Derived from the constructor. - private bool ReloadFarmAnimalData() - { - bool changed = false; - foreach (FarmAnimal animal in this.GetFarmAnimals()) - { - animal.reloadData(); - changed = true; - } - - return changed; } - /// Reload the sprites for a fence type. - /// The asset name to reload. - /// Returns whether any textures were reloaded. - private bool ReloadFenceTextures(IAssetName assetName) + /// Update the sprites for a fence type. + /// The asset name to update. + /// Returns whether any references were updated. + private bool UpdateFenceTextures(IAssetName assetName) { // get fence type (e.g. LooseSprites/Fence3 => 3) if (!int.TryParse(this.GetSegments(assetName.BaseName)[1].Substring("Fence".Length), out int fenceType)) @@ -852,11 +835,11 @@ namespace StardewModdingAPI.Metadata return true; } - /// Reload tree textures. + /// Update tree textures. /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns whether any textures were reloaded. - private bool ReloadGrassTextures(LocalizedContentManager content, IAssetName assetName) + /// The asset name to update. + /// Returns whether any references were updated. + private bool UpdateGrassTextures(LocalizedContentManager content, IAssetName assetName) { Grass[] grasses = ( @@ -878,77 +861,9 @@ namespace StardewModdingAPI.Metadata return false; } - /// Reload hair style metadata. - /// Returns whether any assets were reloaded. - /// Derived from the and . - private bool ReloadHairData() - { - if (Farmer.hairStyleMetadataFile == null) - return false; - - Farmer.hairStyleMetadataFile = null; - Farmer.allHairStyleIndices = null; - Farmer.hairStyleMetadata.Clear(); - - return true; - } - - /// Reload the map for a location. - /// The location whose map to reload. - private void ReloadMap(LocationInfo locationInfo) - { - GameLocation location = locationInfo.Location; - Vector2? playerPos = Game1.player?.Position; - - // reload map - location.interiorDoors.Clear(); // prevent errors when doors try to update tiles which no longer exist - location.reloadMap(); - - // reload interior doors - location.interiorDoors.Clear(); - location.interiorDoors.ResetSharedState(); // load doors from map properties - location.interiorDoors.ResetLocalState(); // reapply door tiles - - // reapply map changes (after reloading doors so they apply theirs too) - location.MakeMapModifications(force: true); - - // update for changes - location.updateWarps(); - location.updateDoors(); - locationInfo.ParentBuilding?.updateInteriorWarps(); - - // reset player position - // The game may move the player as part of the map changes, even if they're not in that - // location. That's not needed in this case, and it can have weird effects like players - // warping onto the wrong tile (or even off-screen) if a patch changes the farmhouse - // map on location change. - if (playerPos.HasValue) - Game1.player!.Position = playerPos.Value; - } - - /// Reload the disposition data for matching NPCs. - /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns whether any NPCs were affected. - private bool ReloadNpcDispositions(LocalizedContentManager content, IAssetName assetName) - { - IDictionary data = content.Load>(assetName.BaseName); - bool changed = false; - foreach (NPC npc in this.GetCharacters()) - { - if (npc.isVillager() && data.ContainsKey(npc.Name)) - { - npc.reloadData(); - changed = true; - } - } - - return changed; - } - - /// Reload the sprites for matching NPCs. - /// The asset keys which are being propagated. - private void ReloadNpcSprites(IDictionary propagated) + /// Update the sprites for matching NPCs. + /// The asset names being propagated. + private void UpdateNpcSprites(IDictionary propagated) { // get NPCs var characters = @@ -970,9 +885,9 @@ namespace StardewModdingAPI.Metadata } } - /// Reload the portraits for matching NPCs. - /// The asset keys which are being propagated. - private void ReloadNpcPortraits(IDictionary propagated) + /// Update the portraits for matching NPCs. + /// The asset names being propagated. + private void UpdateNpcPortraits(IDictionary propagated) { // get NPCs var characters = @@ -1009,9 +924,9 @@ namespace StardewModdingAPI.Metadata } } - /// Reload the sprites for matching players. - /// The asset name to reload. - private bool ReloadPlayerSprites(IAssetName assetName) + /// Update the sprites for matching players. + /// The asset name to update. + private bool UpdatePlayerSprites(IAssetName assetName) { Farmer[] players = ( @@ -1032,11 +947,11 @@ namespace StardewModdingAPI.Metadata return players.Any(); } - /// Reload suspension bridge textures. + /// Update suspension bridge textures. /// The content manager through which to reload the asset. - /// The asset name to reload. - /// Returns whether any textures were reloaded. - private bool ReloadSuspensionBridges(LocalizedContentManager content, IAssetName assetName) + /// The asset name to update. + /// Returns whether any references were updated. + private bool UpdateSuspensionBridges(LocalizedContentManager content, IAssetName assetName) { Lazy texture = new Lazy(() => content.Load(assetName.BaseName)); @@ -1060,12 +975,12 @@ namespace StardewModdingAPI.Metadata return texture.IsValueCreated; } - /// Reload tree textures. + /// Update tree textures. /// The content manager through which to reload the asset. - /// The asset name to reload. - /// The type to reload. - /// Returns whether any textures were reloaded. - private bool ReloadTreeTextures(LocalizedContentManager content, IAssetName assetName, int type) + /// The asset name to update. + /// The type to update. + /// Returns whether any references were updated. + private bool UpdateTreeTextures(LocalizedContentManager content, IAssetName assetName, int type) { Tree[] trees = this.GetLocations() .SelectMany(p => p.terrainFeatures.Values.OfType()) @@ -1084,12 +999,42 @@ namespace StardewModdingAPI.Metadata } /**** - ** Reload data methods + ** Update data methods ****/ - /// Reload the dialogue data for matching NPCs. - /// The asset name to reload. - /// Returns whether any assets were reloaded. - private bool ReloadNpcDialogue(IAssetName assetName) + /// Update the data for matching farm animals. + /// Returns whether any farm animals were updated. + /// Derived from the constructor. + private bool UpdateFarmAnimalData() + { + bool changed = false; + foreach (FarmAnimal animal in this.GetFarmAnimals()) + { + animal.reloadData(); + changed = true; + } + + return changed; + } + + /// Update hair style metadata. + /// Returns whether any data was updated. + /// Derived from the and . + private bool UpdateHairData() + { + if (Farmer.hairStyleMetadataFile == null) + return false; + + Farmer.hairStyleMetadataFile = null; + Farmer.allHairStyleIndices = null; + Farmer.hairStyleMetadata.Clear(); + + return true; + } + + /// Update the dialogue data for matching NPCs. + /// The asset name to update. + /// Returns whether any NPCs were updated. + private bool UpdateNpcDialogue(IAssetName assetName) { // get NPCs string name = Path.GetFileName(assetName.BaseName); @@ -1116,10 +1061,30 @@ namespace StardewModdingAPI.Metadata return true; } - /// Reload the schedules for matching NPCs. - /// The asset name to reload. - /// Returns whether any assets were reloaded. - private bool ReloadNpcSchedules(IAssetName assetName) + /// Update the disposition data for matching NPCs. + /// The content manager through which to reload the asset. + /// The asset name to update. + /// Returns whether any NPCs were updated. + private bool UpdateNpcDispositions(LocalizedContentManager content, IAssetName assetName) + { + IDictionary data = content.Load>(assetName.BaseName); + bool changed = false; + foreach (NPC npc in this.GetCharacters()) + { + if (npc.isVillager() && data.ContainsKey(npc.Name)) + { + npc.reloadData(); + changed = true; + } + } + + return changed; + } + + /// Update the schedules for matching NPCs. + /// The asset name to update. + /// Returns whether any NPCs were updated. + private bool UpdateNpcSchedules(IAssetName assetName) { // get NPCs string name = Path.GetFileName(assetName.BaseName); @@ -1150,11 +1115,11 @@ namespace StardewModdingAPI.Metadata return true; } - /// Reload cached translations from the Strings\StringsFromCSFiles asset. + /// Update cached translations from the Strings\StringsFromCSFiles asset. /// The content manager through which to reload the asset. - /// Returns whether any data was reloaded. + /// Returns whether any data was updated. /// Derived from the . - private bool ReloadStringsFromCsFiles(LocalizedContentManager content) + private bool UpdateStringsFromCsFiles(LocalizedContentManager content) { Game1.samBandName = content.LoadString("Strings/StringsFromCSFiles:Game1.cs.2156"); Game1.elliottBookName = content.LoadString("Strings/StringsFromCSFiles:Game1.cs.2157"); @@ -1171,6 +1136,42 @@ namespace StardewModdingAPI.Metadata return true; } + /**** + ** Update map methods + ****/ + /// Update the map for a location. + /// The location whose map to update. + private void UpdateMap(LocationInfo locationInfo) + { + GameLocation location = locationInfo.Location; + Vector2? playerPos = Game1.player?.Position; + + // reload map + location.interiorDoors.Clear(); // prevent errors when doors try to update tiles which no longer exist + location.reloadMap(); + + // reload interior doors + location.interiorDoors.Clear(); + location.interiorDoors.ResetSharedState(); // load doors from map properties + location.interiorDoors.ResetLocalState(); // reapply door tiles + + // reapply map changes (after reloading doors so they apply theirs too) + location.MakeMapModifications(force: true); + + // update for changes + location.updateWarps(); + location.updateDoors(); + locationInfo.ParentBuilding?.updateInteriorWarps(); + + // reset player position + // The game may move the player as part of the map changes, even if they're not in that + // location. That's not needed in this case, and it can have weird effects like players + // warping onto the wrong tile (or even off-screen) if a patch changes the farmhouse + // map on location change. + if (playerPos.HasValue) + Game1.player!.Position = playerPos.Value; + } + /**** ** Helpers ****/ @@ -1299,29 +1300,8 @@ namespace StardewModdingAPI.Metadata } /// Metadata about a location used in asset propagation. - private readonly struct LocationInfo - { - /********* - ** Accessors - *********/ - /// The location instance. - public GameLocation Location { get; } - - /// The building which contains the location, if any. - public Building? ParentBuilding { get; } - - - /********* - ** Public methods - *********/ - /// Construct an instance. - /// The location instance. - /// The building which contains the location, if any. - public LocationInfo(GameLocation location, Building? parentBuilding) - { - this.Location = location; - this.ParentBuilding = parentBuilding; - } - } + /// The location instance. + /// The building which contains the location, if any. + private record LocationInfo(GameLocation Location, Building? ParentBuilding); } } -- cgit