pathoschild / stardewmods Goto Github PK

Pull request. Imported from Pathoschild/ChestsAnywhere#12. Posted by @Kithio. Original date: 2016-10-22 14:33 UTC.

…(Start button) and click the Back Button by default, can be changed in config]

Closes #52
Closes #51
Closes #49

If the screen resolution is smaller than expected (≈≤1280×768), the lookup UI crashes with the following error:

[ERROR] An error occured in the overridden draw loop: System.ArgumentException: The scissor rectangle is invalid. The scissor rectangle cannot be larger than or outside of the current render target bounds.
Parameter name: value
   at Microsoft.Xna.Framework.Graphics.GraphicsDevice.set_ScissorRectangle(Rectangle value)
   at Pathoschild.LookupAnything.Components.LookupMenu.draw(SpriteBatch spriteBatch)
   at StardewModdingAPI.Inheritance.SGame.Draw(GameTime gameTime)
[03:42:31.174 PM] [ERROR] An error occured in the overridden draw loop: System.InvalidOperationException: Begin cannot be called again until End has been successfully called.
   at Microsoft.Xna.Framework.Graphics.SpriteBatch.Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect, Matrix transformMatrix)
   at Microsoft.Xna.Framework.Graphics.SpriteBatch.Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState)
   at StardewModdingAPI.Inheritance.SGame.Draw(GameTime gameTime)

Reported in the forums (see 2016-10-06 #1 and 2016-10-06 #2).

Before the player has met an NPC (reproduced by running on a new save) you can go to the calendar in town and lookup NPCs you haven't met. The failing reference is in the player's friendship's here: https://github.com/Pathoschild/LookupAnything/blob/master/LookupAnything/Framework/Subjects/CharacterSubject.cs#L69-L72

I suggest that we render a You haven't met this NPC yet field now for this case. An alternative I suppose is to suggest schedules #4 / where you can meet the NPC.

Imported from Pathoschild/ChestsAnywhere#8. Posted by @kriana. Original date: 2016-10-18 21:57 UTC.

I made one if you're interested. I figure people will more likely find it here.
https://github.com/kriana/ChestsAnywhere/releases/tag/1.6m

Is it possible to use description texts of other language such as Chinese?

Currently the mod simply hides the cursor. What would be better is if cursor stays visible, and you could click anywhere to hide the info dialog.

Create a way to search for a subject from anywhere.

For example, hold F1 to bring up a search box with a dropdown of matches. Click one of the matches to pop up the normal lookup UI:

        ┌────────────┐
Search: │ A          │
        └────────────┘─┐
          │ Abigail    │
          │ Apple      │
          │ Apple Tree │
          │ Apricot    │
          │ ...        │
          └────────────┘

Mentioned in the forums.

Imported from Pathoschild/ChestsAnywhere#2. Original date: 2016-10-05 22:07 UTC.

...but you can't identify which physical chest has which name (without using separate mods):

Show a tooltip when you point the cursor at a chest which shows the chest name.
Discussed in the forums.

In rare cases, Stardew Valley's Utility.getAllCharacters() will return the same NPC instance twice, because the game thinks they're in two places at once. It's not clear why this happens, and only one of them is actually visible in the game.

When iterating NPCs, ignore duplicate references to the same instance.

When an update check fails (e.g. because the connection is offline), a scary red block of text is shown:

Show a much more user-friendly error message.

SMAPI enables the game's built-in debug mode when you press F2. This activates several hotkeys, including m to end the current season and immediately save the game. Since SMAPI's debug hotkey is so close to Lookup Anything's F1 key, a few players have lost an entire season that way. Add an option to suppress debug mode by default.

Issue reported via reddit and Nexus private message.

See related: Pathoschild/SMAPI#120.

When looking up an item, add the number of times it was shipped and show progress towards the Polyculture and Full Shipment achievements.

Discussed on the forums.

Looking up a Daffodil incorrectly says Jodi likes them (she actually hates them). Looking up Jodi correctly doesn't show Daffodil as a liked item.

Reported via private message on Nexus mods.

When the player is behind a tree and it goes semi-transparent, don't consider it a valid lookup target. This would let the player lookup things behind the tree, which isn't currently possible.

Discussed in the forums.

Imported from Pathoschild/ChestsAnywhere#5. Original date: 2016-10-08 15:06 UTC.

When you configure a controller button as the Toggle hotkey, it correctly opens the menu but doesn't close it when open.

Theoretically that shouldn't happen, because the receiveKeyPress and receiveGamePadButton events both just pass through to ReceiveKey<T>, which handles keyboard and controller input agnostically.

Reported in the forums.

Add support for Linux and Mac. This involves the following changes:

• Preparation:
  • Add the default Linux/Mac paths to the game path detection.
  • Document the compile steps automated by the Windows-only build script.
• Adjust build process:
  • Detect the platform during the build process.
  • On Linux/Mac, swap the XNA references for MonoGame.
  • On Linux/Mac, disable the mod deploy script.

Thanks to @kriana and @vizv for doing the initial research and creating a Mac fork and Linux fork respectively!

Add support for looking up an item in the player's toolbar.

Imported from Pathoschild/ChestsAnywhere#9. Original date: 2016-10-20 02:39 UTC.

To simplify chest navigation:

• Make sure the PrevChest and NextChest hotkeys only navigate within the current category.
• Add PrevCategory and NextCategory hotkeys (defaulting to the up and down keys).

Suggested via Nexus forums; see comment (2016-10-19) and bug (2016-10-20).

When looking up equipment (e.g. melee weapon, ring, or boots), Lookup Anything shows double the actual sell price.

Reported in the forums.

When the data.json file is outdated, the mod can fail at runtime with null reference exceptions deep in the code which are difficult to troubleshoot. Add validation on startup that checks (a) a version number in the file to ensure it's updated, and (b) that no properties are missing.

Imported from Pathoschild/ChestsAnywhere#1. Original date: 2016-10-05 22:04 UTC.

The mod lets you edit chests through the Chests Anywhere screen:

...but there's no way to edit a chest from the game's default UI:

Add a button to the default UI to access the chest's edit screen.

Discussed in the forums.

Imported from Pathoschild/ChestsAnywhere#6. Original date: 2016-10-11 13:27 UTC.

Add an option to disable the tooltips when pointing at a chest (mainly for players also using Chest Label System).

Requested via Nexus Mods comment.

Add an optional 'advanced mode' that shows more raw data, including...

• item ID;
• object type;
• NPC's raw friendship/happiness/health/attack/defence values;
• tree health.

Add an optional mode where colour-coded text switches to higher contrast (e.g. using bold/faded instead of gray/black). This should support colourblind players too.

Requested on the forums by someone using f.lux on a TV screen.

Imported from Pathoschild/ChestsAnywhere#4. Original date: 2016-10-07 05:52 UTC.

Even if the player hasn't unlocked the fridge yet, it's still shown in the chest dropdown list.

Let players lookup events in the calendar. This should show a brief summary of each event. For the Luau, it should show a list of items they can bring grouped by how much the villagers will like them, colour-coded to indicate which ones the player ows.

If you look something up during the Stardew Valley Fair (and possibly some other events), the game crashes with the following error:

System.InvalidOperationException: Nesting more than one SpriteBatch.Begin when using a SpriteBatch with SpriteSortMode.Immediate is not allowed.
   at Microsoft.Xna.Framework.Graphics.SpriteBatch.Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect, Matrix transformMatrix)
   at Microsoft.Xna.Framework.Graphics.SpriteBatch.Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState)
   at Pathoschild.LookupAnything.Components.LookupMenu.draw(SpriteBatch spriteBatch)
   at StardewModdingAPI.Inheritance.SGame.Draw(GameTime gameTime) in Z:\Projects\SMAPI\src\StardewModdingAPI\Inheritance\SGame.cs:line 1302

This happens because Lookup Anything uses a separate sprite batch for the pagination clipping, which always works except if the game uses SpriteSortMode.Immediate (which it apparently does during certain events).

Reported via Nexus mod bug and Nexus private message.

The gift tastes list for an NPC can be pretty overwhelming:

Use the following rules to simplify it:

• For an item:
  • If everyone likes an item (with up to 2 exceptions), say "everyone" or "everyone (except A and B)" instead of listing them. For example: everyone (except Abigail and Harvey).
• For an NPC:
  • If an NPC likes an entire category (with up to 3 exceptions), say "all " or "all (except A and B)" instead of listing the items. For example: all crops (except parsnips).

Let the player specify a custom hotkey sequence that opens a specific chest (e.g. CTRL + M for monster loot).

Requested on the forums.

When you look up an item that can have a quality, it always shows the price for iridium quality. However only animal products, fruit, cask-aged artisanal products,and forage foods can have an iridium quality.

Reported via forums.

Imported from Pathoschild/ChestsAnywhere#11. Original date: 2016-10-22 01:59 UTC.

When you have a large number of chests, the chest list scrolls inconsistently and strangely.

Reported via 2016-10-20 Nexus Mods bug:

as in the title the scroll of the mouse its very... i don't know how to explain it very "nonsensitive" sometimes its like i just touch the scroll on the mouse and it goes all the way down (never up) many times i cant scroll until i switch to another chest ( sometimes i have to do it many times), that's when i have luck. BUT most of the time what happens is i open the scrolldown and it goes all the way down and can't scroll up.
[...]
[...] its like the dropdown/list of chests has a very long delay between me scrolling up or down and the mod receiving it. Also a problem that i realized its that when you scroll VERY slow it seems to work better but scrolling like normal or a little "fast" it doesn't respond most of the time. im thinking that its probably that i have like 61 chest in the same category because i haven't organized it yet in that farm when i organized them in the other farm it works perfectly fine with not having to scroll.

If an artifact should be donated to the museum for the A Complete Collection achievement, add it to the item 'needed for' field.

After marrying an NPC, their heart meter is expanded to twelve hearts (with a hidden thirteenth heart):

Fix Lookup Anything to show the expanded heart meter for a married NPC.

You can lookup an item from your inventory, but you can't do it from the normal chest UI. Add support for the chest menu (including both chest and inventory boxes):

Let players lookup water to see fishing/crabpot data (e.g. which fish can spawn, percentage chance, etc).

This only occurs when looking up something in the "standalone" crafting page, the only one I know of being the cooking interface via your kitchen. The exception is:

[17:45:29 TRACE LookupAnything] Received a lookup request... searching the open 'CraftingPage' menu... an error occurred.
[17:45:29 ERROR LookupAnything] Something went wrong looking that up:
System.ArgumentNullException: Value cannot be null.
Parameter name: value
   at System.Runtime.Caching.MemoryCacheEntry..ctor(String key, Object value, DateTimeOffset absExp, TimeSpan slidingExp, CacheItemPriority priority, Collection`1 dependencies, CacheEntryRemovedCallback removedCallback, MemoryCache cache)
   at System.Runtime.Caching.MemoryCache.AddOrGetExistingInternal(String key, Object value, CacheItemPolicy policy)
   at System.Runtime.Caching.MemoryCache.AddOrGetExisting(String key, Object value, CacheItemPolicy policy, String regionName)
   at System.Runtime.Caching.ObjectCache.Add(String key, Object value, CacheItemPolicy policy, String regionName)
   at StardewModdingAPI.Framework.Reflection.ReflectionHelper.GetCached[TMemberInfo](String key, Func`1 fetch) in D:\source\_Stardew\SMAPI\src\StardewModdingAPI\Framework\Reflection\ReflectionHelper.cs:line 235
   at StardewModdingAPI.Framework.Reflection.ReflectionHelper.GetFieldFromHierarchy[TValue](Type type, Object obj, String name, BindingFlags bindingFlags) in D:\source\_Stardew\SMAPI\src\StardewModdingAPI\Framework\Reflection\ReflectionHelper.cs:line 168
   at StardewModdingAPI.Framework.Reflection.ReflectionHelper.GetPrivateField[TValue](Object obj, String name, Boolean required) in D:\source\_Stardew\SMAPI\src\StardewModdingAPI\Framework\Reflection\ReflectionHelper.cs:line 41
   at StardewModdingAPI.Framework.Reflection.ReflectionHelper.GetPrivateValue[TValue](Object obj, String name, Boolean required) in D:\source\_Stardew\SMAPI\src\StardewModdingAPI\Framework\Reflection\ReflectionHelper.cs:line 73
   at Pathoschild.Stardew.LookupAnything.Framework.TargetFactory.GetSubjectFrom(IClickableMenu menu, Vector2 cursorPosition) in D:\source\_Stardew\LookupAnything\LookupAnything\Framework\TargetFactory.cs:line 362
   at Pathoschild.Stardew.LookupAnything.LookupAnythingMod.GetSubject(StringBuilder logMessage, LookupMode lookupMode) in D:\source\_Stardew\LookupAnything\LookupAnything\LookupAnythingMod.cs:line 341
   at Pathoschild.Stardew.LookupAnything.LookupAnythingMod.<>c__DisplayClass17_0.<ShowLookup>b__0() in D:\source\_Stardew\LookupAnything\LookupAnything\LookupAnythingMod.cs:line 322
   at Pathoschild.Stardew.LookupAnything.GameHelper.InterceptErrors(IMonitor monitor, String verb, String detailedVerb, Action action, Action`1 onError) in D:\source\_Stardew\LookupAnything\LookupAnything\GameHelper.cs:line 357

Imported from Pathoschild/ChestsAnywhere#10. Original date: 2016-10-22 17:27 UTC.

When an update check fails (e.g. because the connection is offline), a scary red block of text is shown:

Show a much more user-friendly error message. Related to #17.

When looking at the Calendar, F1 should detect the calendar day under the cursor and show the villager whose birthday is listed:

Suggested in the forums.

After married to Emily, on social page, scroll down, and lookup anyone on the first row after scroll it displayed information about Emily.

For example, after scrolling, when inspect "Linus" it displays "Emily" instead, other villagers than the first row displays correctly.

Imported from Pathoschild/ChestsAnywhere#3. Original date: 2016-10-06 05:36 UTC.

If a player doesn't have the full backpack, some slots are unavailable and grayed out:

Clicking one of the disabled slots crashes the game:

An error occured in the base update loop: System.ArgumentOutOfRangeException: Index was out of range. Must be non-negative and less than the size of the collection.
Parameter name: index
   at System.ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument argument, ExceptionResource resource)
   at System.Collections.Generic.List`1.get_Item(Int32 index)
   at ChestsAnywhere.Components.ChestWithInventory.receiveLeftClick(Int32 x, Int32 y, Boolean playSound)
   at ChestsAnywhere.Components.AccessChestMenu.receiveLeftClick(Int32 x, Int32 y, Boolean playSound)
   at StardewValley.Game1.updateActiveMenu(GameTime gameTime) in C:\Users\tomc\Documents\Visual Studio 2010\Projects\Stardew.XNA\Farmer\Farmer\Game1.cs:line 1829
   at StardewValley.Game1.Update(GameTime gameTime) in C:\Users\tomc\Documents\Visual Studio 2010\Projects\Stardew.XNA\Farmer\Farmer\Game1.cs:line 1568
   at StardewModdingAPI.Inheritance.SGame.Update(GameTime gameTime)

This bug has been around since 1.0.

Reported by several users: 2016-10-05 anonymouseling via Nexus comment, 2016-10-08 Bainon via Nexus bug, and 2016-10-08 Littlegal2016 via forums.

I'm a bit of a programmer myself, so I'll provide as detailed info as possible.

All other menus in the game scroll using the Right thumbstick, seemingly moving 1 "unit" (I don't know what it uses) for each time it reads the RightThumbstickUp or RightThumbstickDown "buttons". On other menus, this makes it jump up/down appropriate distances, but on your windows, it only scrolls by 1 pixel at a time. This occurs even if your mod is configured to use different controller buttons for scrolling, but the configured buttons work in the intended manner.

So, would it be at all possible to get the Right thumbstick inputs to scroll more than 1 pixel at a time? Cause I'd rather use that, since the rest of the game uses it also.

Imported from Pathoschild/ChestsAnywhere#7. Original date: 2016-10-18 20:53 UTC.

Input mapped to a controller trigger button isn't properly handled by the new menu overlay.

Reported via Nexus Mods forum.

The cursor implementation while using a controller is very clunky and often buggy and doesn't work well enough unless you're in a menu. So I have a feature suggestion to solve that.

Whenever I try to lookup something while walking around, moving the thumbstick causes the cursor to appear in seemingly random places, forcing me to use my mouse to save some frustration. Could you make an additional button to configure, that would attempt a lookup on whatever object the player is facing? This would also solve the slight problem of accidentally performing a lookup on your player, when you were trying to get the thing behind them.

When looking up an item, show incomplete community bundles which need it. This should only be shown if the player hasn't demolished the community centre with Joja.

Discussed on the forums (see 2016-10-14 and 2016-10-17).

The mod crashes when calculating a day offset that extends into the next year (e.g. +5 days on Winter 24):

System.IndexOutOfRangeException: Index was outside the bounds of the array.
at Pathoschild.LookupAnything.GameHelper.GetDayOffset(Int32 offset, Int32 daysInSeason)
at Pathoschild.LookupAnything.Framework.Subjects.FarmAnimalSubject.<GetData>d__2.MoveNext()
at System.Linq.Enumerable.WhereEnumerableIterator`1.MoveNext()
at System.Linq.Buffer`1..ctor(IEnumerable`1 source)
at System.Linq.Enumerable.ToArray[TSource](IEnumerable`1 source)
at Pathoschild.LookupAnything.Components.LookupMenu..ctor(ISubject subject, Metadata metadata)
at Pathoschild.LookupAnything.LookupAnythingMod.ShowLookup()

Reported via forums.

´Not working with SMAPI 1.9 and Stardew Valley beta, otherwise really great mod

When aging something in a cask, the crafting time is shown as ≈655 days. Casks use a different algorithm for craftint time than other crafting objects, so we'll need custom logic to display it.

Reported via forums and Nexus Mods bug.

Lookup Anything tries to balance between demystifying game mechanics and spoiling the game, which means it can't show some possible spoilers. For example, players may want to learn about Abigail's relationship with her parents through her heart events, or discover gift tastes for themselves.

Consider adding a progression mode that unlocks details as the player discovers them. This might be a bit difficult, because the game doesn't keep track of enough data (e.g. whether you've grown a given crop before or seen a particular dialogue line). Lookup Anything will need a mechanism to detect and track those details itself.

Suggested or discussed several times:

• forums 2016-09-19;
• forums 2016-10-05 and 2016-10-06;
• reddit 2017-01-04;
• forums 2017-05-13;
• reddit 2018-07-07;
• GitHub 2019-02-03.

The gift tastes shown for an item or NPC are usually correct, but are wrong in a few cases. For example, Lookup Anything says Vincent likes Jelly but he actually hates it.

When looking up an NPC, show their schedule for today. It looks like we can get today's schedule from Dictionary<int, SchedulePathDescription> NPC::getSchedule(int dayOfMonth). Although it takes a day of month, it's only accurate for the current day since it checks the current conditions (e.g. rain).

Discussed in the forums.