Port Filters and some Covers to MUI + Filter Rework #2345

ghzdude · 2024-01-14T04:30:48Z

What

Rework Filter Behavior
remove FilterTypeRegistry
Port some Covers to MUI

Implementation Details

port filters to mui
make filters open a gui on rightclick
remove FilterTypeRegistry
create the filter behavior as a metaitem component
filter settings are now stored/read from item NBT
deprecate old mui methods
add method slice() to GTGuiTextures for slicing an image into an array
make CoverWithUI::createTitleRow() static
fix buttons not being adaptable enough

Outcome

Currently, the covers ported are:

(simple) item filter
smart item filter
oredict item filter
(simple) fluid filter
conveyor
robot arm
pump
regulator
item voiding + advanced
fluid voiding + advanced
ender fluid link cover

As a result of the changes to filter UI and behavior, some covers that accept filters don't work correctly:

advanced item detector
advanced fluid detector

Todo

this may be updated in the future

Potential Compatibility Issues

At the moment, some method that previously existed or had functionality may be commented out or removed. If this will cause issues, let me know. There might also some parts where NBT saved in older worlds is not read to the new filter system

ALongStringOfNumbers

Noticed the following issue with tooltips while in creative mode with an item on the cursor and having moved the filter popup window over to the side. Seems like it would be mainly a MUI issue, but I thought I would bring it up here

ItemStacks in Filters in Robot Arms need to have a tooltip added to them explaining the various ways to increment/decrement the count of the itemstack in the filter. IE: Key Combo + Scroll, or Key Combo + Click
And example from the fluid filter:

Since you added the ability to configure filters when the are in your inventory and keeping NBT, you need to add shapeless NBT clearing recipes for all the filters

You can currently crash trying to put an itemstack into the fluid slots of a fluid filter

Currently you can shift right click to clear the filter NBT when it is in your inventory. This needs a tooltip.

And yeah, as talked about on discord, I think we should move button state in these reworked covers to match that of the machine controller

You are currently making GUIs both the old way and the new way for a bunch of the filters that were converted. Any reason you are keeping the old implementations around?

You are currently limited to 1 bucket per slot maximum in a fluid filter, when configuring it in inventory. Any reason for this?

src/main/java/gregtech/common/covers/filter/SimpleItemFilter.java

src/main/java/gregtech/common/covers/filter/BaseFilterContainer.java

src/main/java/gregtech/common/covers/filter/FluidFilterContainer.java

src/main/java/gregtech/common/items/behaviors/filter/BaseFilterUIManager.java

ghzdude · 2024-01-20T02:14:33Z

And yeah, as talked about on discord, I think we should move button state in these reworked covers to match that of the machine controller

I've switched around the background textures for the enum rows, so it should look better now

ALongStringOfNumbers · 2024-01-20T02:35:07Z

Found a voiding issue: Give yourself a stack of filters, right click to configure, and it sets the stacksize to 1

Also, should you be able to have duplicate itemstacks in filters? I don't think it would serve any purpose

ghzdude · 2024-01-20T15:27:21Z

Found a voiding issue: Give yourself a stack of filters, right click to configure, and it sets the stacksize to 1

should be fixed now with 2f200cb

ghzdude · 2024-01-22T04:23:14Z

ItemStacks in Filters in Robot Arms need to have a tooltip added to them explaining the various ways to increment/decrement the count of the itemstack in the filter. IE: Key Combo + Scroll, or Key Combo + Click

fixed with 5cb80df

I also noticed that the lang for fluid filter configuration has shift left/right-click to double/halve, but MUI does not do this behavior by default, should I add that behavior back for item and fluid filter slots?

ALongStringOfNumbers · 2024-01-22T04:24:52Z

ItemStacks in Filters in Robot Arms need to have a tooltip added to them explaining the various ways to increment/decrement the count of the itemstack in the filter. IE: Key Combo + Scroll, or Key Combo + Click

fixed with 5cb80df

I also noticed that the lang for fluid filter configuration has shift left/right-click to double/halve, but MUI does not do this behavior by default, should I add that behavior back for item and fluid filter slots?

That one I am on the fence about, since you can key combo + scroll. I think it could be left out for now maybe

ghzdude · 2024-01-23T21:05:37Z

I'm not totally sure about the appearance of the fluid voiding overlays from 04451a0, would like some feedback on that

ghzdude · 2024-01-26T02:29:34Z

You are currently limited to 1 bucket per slot maximum in a fluid filter, when configuring it in inventory. Any reason for this?

i consider it the default behavior of a fluid filter, as that's the behavior for a fluid filter in a pump. I could probably make it not render the fluid amount unless the fluid filter is in a regulator or advanced fluid voiding cover.

brachy84 · 2024-01-26T16:01:15Z

Phantom fluid slots have a controllsAmount property or in the sync handler. This makes the slot only be able to hold 1mb and not render the amount.

ghzdude · 2024-01-27T17:52:57Z

Phantom fluid slots have a controllsAmount property or in the sync handler. This makes the slot only be able to hold 1mb and not render the amount.

i'm using that now with 5fb69a4, thanks

src/main/java/gregtech/common/covers/CoverFluidFilter.java

src/main/java/gregtech/common/covers/CoverFluidRegulator.java

src/main/java/gregtech/common/covers/CoverFluidVoidingAdvanced.java

src/main/java/gregtech/common/covers/filter/WidgetGroupFluidFilter.java

src/main/java/gregtech/common/covers/filter/WidgetGroupItemFilter.java

src/main/java/gregtech/common/gui/widget/orefilter/ItemOreFilterTestSlot.java

src/main/java/gregtech/common/gui/widget/orefilter/OreFilterTestSlot.java

src/main/java/gregtech/integration/theoneprobe/provider/CoverInfoProvider.java

ALongStringOfNumbers

An in progress review

src/main/java/gregtech/common/covers/filter/readers/BaseFilterReader.java

ALongStringOfNumbers · 2024-02-05T03:28:02Z

src/main/java/gregtech/common/covers/filter/readers/BaseFilterReader.java

+ }
+
+ public void setMaxTransferRate(int transferRate) {
+ transferRate = MathHelper.clamp(transferRate, 1, Integer.MAX_VALUE);


The min for transfer rate should be 0 right? Not 1? I remember that currently you can set transfer rates to 0.

you can set the max transfer rate (max stack size for items) to 0, but the normal transfer rate is clamped to a min of 1

src/main/java/gregtech/common/covers/filter/readers/BaseFilterReader.java

src/main/java/gregtech/common/covers/filter/ItemFilter.java

src/main/java/gregtech/common/covers/filter/BaseFilterContainer.java

src/main/java/gregtech/common/covers/filter/SimpleFluidFilter.java

src/main/java/gregtech/common/covers/filter/ItemFilter.java

ghzdude · 2024-02-08T02:49:23Z

Summary of latest changes

The inner classes in all ItemFilter and FluidFilter classes have been moved out
Class hierarchy for filters, filter readers, and filter ui managers has been changed slightly
- Base Filter -> SimpleItemFilter, SimpleFluidFilter, SmartItemFilter, OreDictionaryItemFilter
- BaseFilterReader -> SimpleItemFilter, SimpleFluidFilter
  - SimpleItemFilter -> SmartItemFilter, OreDictionaryItemFilter
- BaseFilterUIManager -> SimpleItemFilter, SimpleFluidFilter, SmartItemFilter, OreDictionaryItemFilter
New/renamed interfaces:
- Filter<> renamed and split to IFilter, IItemFilter, IFluidFilter
- FilterReader
- FilterFactory - functional interface that takes an ItemStack and returns a Filter
FilterTypeRegistry has been reworked... again
- store a Map<ItemStack, FilterFactory> and Map<ItemStack, FilterType>
- previous maps are intended to be removed/deprecated
add types to filters to differentiate item filters from fluid filters
fixes some issues with reading legacy NBT data
fix FilterMode not syncing to client
fix issues with robot arm not respecting blacklist on smart filters
fix robot arm not working correctly with certain filters
the global limit text field should be displayed in correct situations
a few other smaller changes that i don't remember right now

ALongStringOfNumbers

The Robot Arm has the text for "Conveyor Mode" next to its Import and Output mode selection. This should probably be renamed to something more general.

Found an error with the Robot arm and item filters. Place an item filter in a Robot Arm in Transfer Any mode. Change the Mode to Keep Exact, and scrolling to change the item amount is not displayed until the filter is closed and re-opened.

What is the difference between the max stack size and the transfer stack size in BaseFilterContainer?

src/main/java/gregtech/common/items/behaviors/filter/BaseFilterUIManager.java

src/main/java/gregtech/common/covers/CoverItemFilter.java

src/main/java/gregtech/common/covers/CoverFluidFilter.java

src/main/java/gregtech/common/covers/filter/OreDictionaryItemFilter.java

ALongStringOfNumbers · 2024-02-11T05:31:35Z

src/main/java/gregtech/common/covers/filter/BaseFilterContainer.java

+ }
+
+ public void onFilterInstanceChange() {
+ dirtyNotifiable.markAsDirty();


Shouldn't this also run the onFilterInstanceChange?

could do that, though we never set the variable ourselves it seems

src/main/java/gregtech/common/covers/filter/BaseFilterContainer.java

ghzdude · 2024-02-12T01:50:26Z

What is the difference between the max stack size and the transfer stack size in BaseFilterContainer?

transferSize is the value that's set by the text field when there is no filter, if the filter is blacklist, or if it's an oredict/smart filter.
maxTransferSize is the max value that transferSize can be.

your other comments should also be addressed now

ALongStringOfNumbers

Was testing the Ore Dictionary filter, and the Case Sensitive stuff didn't seem to work. Was testing a gold ingot, so ingotGold and typing in gold into the bar matched the ingot in both case sensitive and insensitive modes. Figured out that toggling the case sensitivity option does not refresh the displayed match status. This might also happen with the match all button, but I did not test that.

Kind of an ask, but you should be able to hold backspace in the Ore Dict Filter text bar.

The amount incrementing/decrementing tooltips in an item filter should really only be shown in cases where you can change the amount, like the filter being in a robot arm. Currently they are shown when just opening the filter by itself, which is a bit confusing because none of it applies.

Opening an Ore Dictionary filter, doing nothing, and then closing the GUI gives the filter an empty NBT tag. Could this be avoided at all?

There still needs to be an icon for the filter button when in a cover (like the conveyor)

Dupe Found: Place a macerator, place a Conveyor on top (used UV), place a crate on top (Used TungstenSteel), add a stack of crates to the crate, change the mode of the conveyor to import, and it will dupe the stack of crates, 1 stack in the macerator and 1 stack remaining in the crate.
And afterwords I ran the macerator, clearing some space in the input, and the conveyor would not pull in the remaining stack of crates from the crate. However, other items added to the crate would be pulled in, so I am not sure if this is an actual dupe, or just a big desync, although I am leaning towards dupe.

src/main/java/gregtech/common/gui/widget/HighlightedTextField.java

src/main/java/gregtech/common/mui/widget/orefilter/OreFilterTestSlot.java

src/main/java/gregtech/common/covers/CoverItemFilter.java

ghzdude · 2024-03-03T23:44:58Z

Was testing the Ore Dictionary filter, and the Case Sensitive stuff didn't seem to work. Was testing a gold ingot, so ingotGold and typing in gold into the bar matched the ingot in both case sensitive and insensitive modes. Figured out that toggling the case sensitivity option does not refresh the displayed match status. This might also happen with the match all button, but I did not test that.

this should be fixed now (for both case sensitive and match all buttons)

Kind of an ask, but you should be able to hold backspace in the Ore Dict Filter text bar.

this is already what happens, at least with mui 2.4.3

The amount incrementing/decrementing tooltips in an item filter should really only be shown in cases where you can change the amount, like the filter being in a robot arm. Currently they are shown when just opening the filter by itself, which is a bit confusing because none of it applies.

are you talking about the "Count: #" tooltip? i could probably move that to only robot arm where it's most relevant

Opening an Ore Dictionary filter, doing nothing, and then closing the GUI gives the filter an empty NBT tag. Could this be avoided at all?

it's a consequence of calling getStackTag() for checking if a stack's tag exists, and adding an empty one if it doesn't.

Dupe Found: Place a macerator, place a Conveyor on top (used UV), place a crate on top (Used TungstenSteel), add a stack of crates to the crate, change the mode of the conveyor to import, and it will dupe the stack of crates, 1 stack in the macerator and 1 stack remaining in the crate. And afterwords I ran the macerator, clearing some space in the input, and the conveyor would not pull in the remaining stack of crates from the crate. However, other items added to the crate would be pulled in, so I am not sure if this is an actual dupe, or just a big desync, although I am leaning towards dupe.

i cannot replicate this. i do remember that the crate's UI was not syncing to the client properly in the past, but i'm not seeing that anymore either

ghzdude · 2024-03-04T00:47:45Z

There still needs to be an icon for the filter button when in a cover (like the conveyor)

this should be fixed now

ALongStringOfNumbers · 2024-03-07T03:44:32Z

The amount incrementing/decrementing tooltips in an item filter should really only be shown in cases where you can change the amount, like the filter being in a robot arm. Currently they are shown when just opening the filter by itself, which is a bit confusing because none of it applies.

are you talking about the "Count: #" tooltip? i could probably move that to only robot arm where it's most relevant

I am talking about this tooltip for adjusting the amount of items in the filter

The scroll wheel, key combos, click to increase/decrease. But yeah, the count is part of that too. Making that tooltip only show in robot arms would make sense to me, as it is the only time that matters. Except for fluid regulators. It matters there as well

ghzdude · 2024-03-07T04:01:54Z

I am talking about this tooltip for adjusting the amount of items in the filter
...
The scroll wheel, key combos, click to increase/decrease. But yeah, the count is part of that too. Making that tooltip only show in robot arms would make sense to me, as it is the only time that matters. Except for fluid regulators. It matters there as well

Ah, I see. I can fix that for the item filters, but MUI adds the tooltip for the phantom fluid slots. In order to change that I would have to override the slot's class or rebuild the tooltip from scratch.

spotless

move draw calls to a more appropriate method

do `string, string` function instead

remove legacy tag when loaded remove some methods from IFilter

yeet IItemFilter.java and IFluidFilter.java test/match against Object and cast appropriately remove MatchResult's generics move similar methods into BaseFilterContainer

…component

ALongStringOfNumbers · 2024-03-27T20:16:51Z

Even with the most recent commit, whitelist/blacklist modes are not preserved on existing filters as covers when loading into a world with filters created before switching to this branch.

ALongStringOfNumbers · 2024-03-27T22:26:02Z

From testing transferring old worlds with old filters, into new worlds, I found the following issues:

The above, with whitelist/blacklist with filters as covers
In Robot arms, Any items that were filtered in an existing filter in a robot arm are not carried over. Testing case: Robot arm, keep exact, with an item filter. The filter has a stack of 132 EV robot arms in the filter (Although this also happened when the stacksize was 1). We are in whitelist mode. When changing to this branch, the contents of the filter are empty.
For filters in robot arms, the Respect NBT setting of the filter is not carried over when changing into the new world. Whitelist/blacklist is carried over correctly, and I did not test Respect Damage
For Filters in Pumps, the fluid stored in the filter is not carried over when loading into a new world with this PR. (The filter gets a capacity of 1, unsure if that would be blocking anything)
For Filters in Fluid Regulars, the fluid stored in the filter is not carried over when loading into a new world with this PR.
For Fluid Regulators, when in supply exact mode with no filter, specifying a supply exact rate and then loading the world with this PR see that the rate is not carried across. (Example, I had a rate of 131, loaded with this PR, and it was 1)
In the Item Voiding Cover, when using the Ore Dict filter, the stored ore dict phrase is not carried over after loading this PR
In the Item Voiding Cover, when using the Smart Item filter, the filter mode is not carried over after loading this PR
In the Item Voiding Cover, using a regular item filter, the filter contents, respect damage, and respect NBT settings are not carried over
In the Advanced Item Voiding Cover (Both Void Matching and Void Overflow), using a regular item filter, the filter contents, respect damage, and respect NBT settings are not carried over. (I am not going to report this one any more, because it seems like one fix could fix them all)
Same as above with the ore dict filter and smart filter in the regular voiding filter, but in the advanced one
The private mode tank Icon in the Ender Fluid Link cover is missing
The Pump mode buttons in the Ender Fluid Link cover don't have Icons
In the Advanced Fluid Voiding cover, Bucket Mode is not carried over, and also the void overflow amount is not carried over when switching to this PR
In the Advanced Item Detector Cover, the Inverted Button is titled "Working Enabled/Disabled" instead of Inverted

fix missing overlays/buttons

ghzdude · 2024-03-30T21:08:04Z

i'm pretty sure most if not all of the legacy nbt reading is handled correctly now

The private mode tank Icon in the Ender Fluid Link cover is missing

The Pump mode buttons in the Ender Fluid Link cover don't have Icons

both of these are fixed now

In the Advanced Fluid Voiding cover, Bucket Mode is not carried over, and also the void overflow amount is not carried over when switching to this PR

bucket mode previously was not saved (iirc) for pumps/regulators. i'll try to save it now

In the Advanced Item Detector Cover, the Inverted Button is titled "Working Enabled/Disabled" instead of Inverted

fixed now

ALongStringOfNumbers

Looks mostly good, but this PR is getting a bit too unwieldy. We should merge this now, and have a followup PR for any required bugfixes

ghzdude added the type: refactor Suggestion to refactor a section of code label Jan 14, 2024

ghzdude force-pushed the gh-mui-filter-cover-rework branch from 6107e02 to 8a79b8b Compare January 18, 2024 07:15

ghzdude marked this pull request as ready for review January 19, 2024 23:43

ghzdude requested review from a team as code owners January 19, 2024 23:43

ghzdude changed the title ~~Port Filters, Conveyors and Robot Arm to MUI + Filter Rework~~ Port Filters and some Covers to MUI + Filter Rework Jan 20, 2024

ALongStringOfNumbers reviewed Jan 20, 2024

View reviewed changes

TechLord22 reviewed Jan 28, 2024

View reviewed changes

ghzdude mentioned this pull request Jan 30, 2024

MUI transition cleanups #2280

Open

7 tasks

ALongStringOfNumbers reviewed Feb 5, 2024

View reviewed changes

ALongStringOfNumbers reviewed Feb 11, 2024

View reviewed changes

ghzdude force-pushed the gh-mui-filter-cover-rework branch 2 times, most recently from 2975608 to 63dcf5e Compare February 18, 2024 05:42

ALongStringOfNumbers reviewed Mar 3, 2024

View reviewed changes

ghzdude force-pushed the gh-mui-filter-cover-rework branch from 68968ce to f66cf3b Compare March 7, 2024 05:22

ghzdude added 12 commits March 20, 2024 13:15

address reviews part 2

63472eb

add icon for filter settings

62031ef

spotless

forgor fluid container

7ec7a75

rename filter settings

60899a1

only show controls tooltip for robot arm or adv item voiding cover

c51a6b2

fix an issue with global transfer limit slider

86076c8

:servernotforrendering:

1dcd18e

move draw calls to a more appropriate method

try and cache the highlighted string

e4976f3

do `string, string` function instead

don't set fluid tag with an empty tag

f6f58fc

remove legacy tag when loaded remove some methods from IFilter

ah shit, here we go again

9a50a6f

yeet IItemFilter.java and IFluidFilter.java test/match against Object and cast appropriately remove MatchResult's generics move similar methods into BaseFilterContainer

remove todo

c4d0d4d

try to make failing to get a filter less aggressive

a0534e7

ghzdude force-pushed the gh-mui-filter-cover-rework branch from 4f51192 to a0534e7 Compare March 20, 2024 20:15

ghzdude added 4 commits March 23, 2024 16:28

deprecate FilterTypeRegistry completey and add filters as a metaitem …

9c54559

…component

yeet FilterTypeRegistry.java

91b9209

small change

bdfa1da

fix legacy nbt reading for filter as cover

6335a05

ghzdude force-pushed the gh-mui-filter-cover-rework branch from f4d946f to 6335a05 Compare March 26, 2024 18:03

read blacklist correctly

0654d1b

ghzdude added 4 commits March 30, 2024 13:22

The Great NBT re-reading of 2024

bed55db

remove deprecated method

14a6af7

fix missing overlays/buttons

sbobls

ec86c14

change lang keys

4117298

save bucket mode

77c795a

ALongStringOfNumbers approved these changes Apr 4, 2024

View reviewed changes

TechLord22 merged commit f33da7f into GregTechCEu:master Apr 4, 2024
3 checks passed

marisathewitch mentioned this pull request Jul 6, 2024

Update ru_RU lang for 2.8.9 #2523

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port Filters and some Covers to MUI + Filter Rework #2345

Port Filters and some Covers to MUI + Filter Rework #2345

ghzdude commented Jan 14, 2024 •

edited

Loading

ALongStringOfNumbers left a comment •

edited

Loading

ghzdude commented Jan 20, 2024

ALongStringOfNumbers commented Jan 20, 2024

ghzdude commented Jan 20, 2024

ghzdude commented Jan 22, 2024

ALongStringOfNumbers commented Jan 22, 2024

ghzdude commented Jan 23, 2024

ghzdude commented Jan 26, 2024

brachy84 commented Jan 26, 2024

ghzdude commented Jan 27, 2024

ALongStringOfNumbers left a comment

ALongStringOfNumbers Feb 5, 2024

ghzdude Feb 5, 2024

ghzdude commented Feb 8, 2024 •

edited

Loading

ALongStringOfNumbers left a comment

ALongStringOfNumbers Feb 11, 2024

ghzdude Feb 11, 2024

ghzdude commented Feb 12, 2024

ALongStringOfNumbers left a comment

ghzdude commented Mar 3, 2024

ghzdude commented Mar 4, 2024

ALongStringOfNumbers commented Mar 7, 2024

ghzdude commented Mar 7, 2024

ALongStringOfNumbers commented Mar 27, 2024

ALongStringOfNumbers commented Mar 27, 2024

ghzdude commented Mar 30, 2024 •

edited

Loading

ALongStringOfNumbers left a comment

Port Filters and some Covers to MUI + Filter Rework #2345

Port Filters and some Covers to MUI + Filter Rework #2345

Conversation

ghzdude commented Jan 14, 2024 • edited Loading

What

Implementation Details

Outcome

Todo

Potential Compatibility Issues

ALongStringOfNumbers left a comment • edited Loading

Choose a reason for hiding this comment

ghzdude commented Jan 20, 2024

ALongStringOfNumbers commented Jan 20, 2024

ghzdude commented Jan 20, 2024

ghzdude commented Jan 22, 2024

ALongStringOfNumbers commented Jan 22, 2024

ghzdude commented Jan 23, 2024

ghzdude commented Jan 26, 2024

brachy84 commented Jan 26, 2024

ghzdude commented Jan 27, 2024

ALongStringOfNumbers left a comment

Choose a reason for hiding this comment

ALongStringOfNumbers Feb 5, 2024

Choose a reason for hiding this comment

ghzdude Feb 5, 2024

Choose a reason for hiding this comment

ghzdude commented Feb 8, 2024 • edited Loading

Summary of latest changes

ALongStringOfNumbers left a comment

Choose a reason for hiding this comment

ALongStringOfNumbers Feb 11, 2024

Choose a reason for hiding this comment

ghzdude Feb 11, 2024

Choose a reason for hiding this comment

ghzdude commented Feb 12, 2024

ALongStringOfNumbers left a comment

Choose a reason for hiding this comment

ghzdude commented Mar 3, 2024

ghzdude commented Mar 4, 2024

ALongStringOfNumbers commented Mar 7, 2024

ghzdude commented Mar 7, 2024

ALongStringOfNumbers commented Mar 27, 2024

ALongStringOfNumbers commented Mar 27, 2024

ghzdude commented Mar 30, 2024 • edited Loading

ALongStringOfNumbers left a comment

Choose a reason for hiding this comment

ghzdude commented Jan 14, 2024 •

edited

Loading

ALongStringOfNumbers left a comment •

edited

Loading

ghzdude commented Feb 8, 2024 •

edited

Loading

ghzdude commented Mar 30, 2024 •

edited

Loading