Added an option to toggle oredict substitutions for patterns. #1891

yueh · Sep 21, 2015

It adds a backward compatibility to convert current patterns to use
oredict by default, which should be removed with rv4 stable.

Closes #1156

orod-org · Sep 21, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org · Sep 21, 2015

src/main/java/appeng/core/sync/packets/PacketValueConfig.java

@@ -158,6 +158,10 @@ else if( this.Name.equals( "PatternTerminal.Clear" ) )
 			{
 				cpt.clear();
 			}
+			else if( this.Name.equals( "PatternTerminal.Substitute" ) )


Move the "PatternTerminal.Substitute" string literal on the left side of this string comparison.

orod-org · Sep 21, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org · Sep 21, 2015

src/main/java/appeng/core/sync/packets/PacketValueConfig.java

@@ -158,6 +158,10 @@ else if( this.Name.equals( "PatternTerminal.Clear" ) )
 			{
 				cpt.clear();
 			}
+			else if( this.Name.equals( "PatternTerminal.Substitute" ) )
+			{
+				cpt.ct.setSubstitution( this.Value.equals( "1" ) );


Move the "1" string literal on the left side of this string comparison.

orod-org · Sep 21, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org · Sep 21, 2015

src/main/java/appeng/crafting/CraftingTreeNode.java

-	boolean sim;
+	private int bytes = 0;
+	private boolean canEmit = false;
+	private boolean cannotUse = false;


Remove this unused "cannotUse" private field.

orod-org · Sep 21, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org · Sep 21, 2015

src/main/java/appeng/core/localization/ButtonToolTips.java

@@ -54,7 +54,7 @@

 	LevelType, LevelType_Energy, LevelType_Item, InventoryTweaks, TerminalStyle, TerminalStyle_Full, TerminalStyle_Tall, TerminalStyle_Small,

-	Stash, StashDesc, Encode, EncodeDescription, Substitutions, SubstitutionsOn, SubstitutionsOff, SubstitutionsDesc, CraftOnly, CraftEither,
+	Stash, StashDesc, Encode, EncodeDescription, Substitutions, SubstitutionsOn, SubstitutionsOff, SubstitutionsDescEnabled, SubstitutionsDescDisabled, CraftOnly, CraftEither,


Rename this constant name to match the regular expression '^[A-Z][A-Z0-9]([A-Z0-9]+)_$'.

orod-org · Sep 21, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org · Sep 21, 2015

src/main/java/appeng/core/localization/GuiText.java

+	And,
+	With,
+	Substitute,
+	Yes,


Rename this constant name to match the regular expression '^[A-Z][A-Z0-9]([A-Z0-9]+)_$'.

orod-org · Sep 21, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org · Sep 21, 2015

src/main/java/appeng/core/localization/GuiText.java

+	With,
+	Substitute,
+	Yes,
+	No,


Rename this constant name to match the regular expression '^[A-Z][A-Z0-9]([A-Z0-9]+)_$'.

orod-org · Sep 21, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org · Sep 21, 2015

src/main/java/appeng/core/localization/GuiText.java

+	Yes,
+	No,
+
+	MolecularAssembler,


Rename this constant name to match the regular expression '^[A-Z][A-Z0-9]([A-Z0-9]+)_$'.

I am also not fully convinced about how to handle the backward compatibility.
Should we consider any "old" pattern as oredict enabled or not. According to the existing code in PatternHelper.canSubstitute(), they were actually not intended to use any substitute.

yueh · Sep 23, 2015

I am also not fully convinced about how to handle the backward compatibility.
Should we consider any "old" pattern as oredict enabled or not. According to the existing code in PatternHelper.canSubstitute(), they were actually not intended to use any substitute.

I think oredict should be off by default.

thatsIch · Sep 23, 2015

I think oredict should be off by default.

I also tend to this option, but will potentially cause more issues to players when upgrading and their tendency to ignore changelogs.

yueh · Sep 23, 2015

I also tend to this option, but will potentially cause more issues to players when upgrading and their tendency to ignore changelogs.

ah, the old pattern did support oredict right,
then 1.7 on by default with a //TODO marker?

thatsIch · Sep 23, 2015

ah, the old pattern did support oredict right,
then 1.7 on by default with a //TODO marker?

Old patterns are supporting oredict as it was the only option. But codewise it seems they should not.

New patterns will now have a new nbttag, but nonexistant nbttags will by default fallback to false, so it currently checks if the tag exists and if not will fallback to true instead.
It would be possible to simply negate it at one point, but this is really clunky, if the code works with "can", but stored as "cannot".

Also there is already a TODO for the pattern helper to remove it at one point.
If completely new patterns then use oredict or not by default is not really important. I honestly have currently even no idea what the default option is.

yueh · Sep 23, 2015

Old patterns are supporting oredict as it was the only option. But codewise it seems they should not.

New patterns will now have a new nbttag, but nonexistant nbttags will by default fallback to false, so it currently checks if the tag exists and if not will fallback to true instead.
It would be possible to simply negate it at one point, but this is really clunky, if the code works with "can", but stored as "cannot".

Also there is already a TODO for the pattern helper to remove it at one point.
If completely new patterns then use oredict or not by default is not really important. I honestly have currently even no idea what the default option is.

I think new patterns should have ore dict off per default.
You could also add a transition item with a text like "put into bench to convert to new" or so like the old TE pipes in 1.6

Might be the cleanest solution from player perspective

thatsIch · Sep 23, 2015

I think new patterns should have ore dict off per default.
You could also add a transition item with a text like "put into bench to convert to new" or so like the old TE pipes in 1.6

Might be the cleanest solution from player perspective

A transition item would be extremely intrusive to existing builds as this would mean update every single pattern.

Disabling it would mean only recreate needed ones, but still will require some player interaction.

Enabling will keep the current behaviour, but need like 5 lines of code extra to handle it.

yueh · Sep 23, 2015

A transition item would be extremely intrusive to existing builds as this would mean update every single pattern.

Disabling it would mean only recreate needed ones, but still will require some player interaction.

Enabling will keep the current behaviour, but need like 5 lines of code extra to handle it.

I slowly tend towards disabling it even for old patterns. The crafting system is already designed around precise items when calculating the crafting tree and most requests are about disabling this feature in general.

I really cannot remember any real feedback regarding it is an actually used very frequently, But the positive feedback is way more rare then negative ones.
Also the amount of patterns requiring oredict enable is probably way less then these requiring it disabled, so I would assume it will be less work for the players actually and I have no issue about closing a couple of issues and linking the changelogs.

yueh · Sep 26, 2015

I slowly tend towards disabling it even for old patterns. The crafting system is already designed around precise items when calculating the crafting tree and most requests are about disabling this feature in general.

I really cannot remember any real feedback regarding it is an actually used very frequently, But the positive feedback is way more rare then negative ones.
Also the amount of patterns requiring oredict enable is probably way less then these requiring it disabled, so I would assume it will be less work for the players actually and I have no issue about closing a couple of issues and linking the changelogs.

sounds about right

thatsIch · Sep 26, 2015

sounds about right

thatsIch · Oct 6, 2015

thatsIch reviewed Oct 6, 2015

View changes

thatsIch · Oct 6, 2015

src/api/java/appeng/api/config/Substitution.java

+package appeng.api.config;
+
+
+public enum Substitution


should probably state for what usage this is supposed to be used. Sometimes there are duplicate classes which do nearly the same but are used in different contextes and to obtain type-safety they use different ones.

thatsIch · Oct 6, 2015

thatsIch reviewed Oct 6, 2015

View changes

thatsIch · Oct 6, 2015

src/main/java/appeng/client/gui/implementations/GuiPatternTerm.java

+
+			if( this.substitutionsEnabledBtn == btn || this.substitutionsDisabledBtn == btn )
+			{
+				NetworkHandler.instance.sendToServer( new PacketValueConfig( "PatternTerminal.Substitute", this.substitutionsEnabledBtn == btn ? "0" : "1" ) );


should probably const the 0 and the 1 out to clarify meaning

Might be even an idea to refactor PacketValueConfig to also accept an enum instead of just a random string. Serialization probably still has to fall back to .ordinal() or similar.

thatsIch · Oct 6, 2015

thatsIch reviewed Oct 6, 2015

View changes

thatsIch · Oct 6, 2015

src/main/java/appeng/client/gui/implementations/GuiPatternTerm.java

+			this.substitutionsEnabledBtn.visible = false;
+			this.substitutionsDisabledBtn.visible = true;
+		}
+


just thinking as enhancement:

A class ToggleGroup or so, and if you make 1 button visible, all others are disabled via listener. Would be probably interessting in other button groups, so adding a new state is far easier than hard-coding the state.

Good idea. The whole gui could see some improvments. But simply not enough time currently to also refactor this.

thatsIch · Oct 6, 2015

thatsIch reviewed Oct 6, 2015

View changes

thatsIch · Oct 6, 2015

src/main/java/appeng/container/implementations/ContainerPatternTerm.java

+			if( this.substitute != this.ct.isSubstitution() )
+			{
+				this.substitute = this.ct.isSubstitution();
+			}


so its always this.substitute = this.ct.isSubstitution();? any performance implications why the ifis used?

Hm yeah. Mostly pointless. I think I left it intentionally there in case it needed something similar to the crafting mode and updateOrderOfOutputSlots().

thatsIch · Oct 6, 2015

thatsIch reviewed Oct 6, 2015

View changes

thatsIch · Oct 6, 2015

src/main/java/appeng/crafting/CraftingTreeNode.java

+
+			if( this.parent.details.canSubstitute() )
+			{
+				itemList = inv.getItemList().findFuzzy( this.what, FuzzyMode.IGNORE_ALL );


inv.getItemList() used in both branches

thatsIch · Oct 6, 2015

thatsIch reviewed Oct 6, 2015

View changes

thatsIch · Oct 6, 2015

src/main/java/appeng/helpers/PatternHelper.java

 	{
 		ACCEPT, DECLINE, TEST
 	}

-	static class TestLookup
+	private static class TestLookup


SonarQube analysis reported 9 issues:

4 major
5 minor

Watch the comments in this conversation to review them.
Note: the following issues could not be reported as comments because they are located on lines that are not displayed in this pull request:

Unwritten public or protected field: appeng.client.gui.widgets.GuiImgButton.fillVar
The Cyclomatic Complexity of this method "addCheckedInformation" is 11 which is greater than 10 authorized.

orod-org · Oct 6, 2015

SonarQube analysis reported 9 issues:

4 major
5 minor

Watch the comments in this conversation to review them.
Note: the following issues could not be reported as comments because they are located on lines that are not displayed in this pull request:

Unwritten public or protected field: appeng.client.gui.widgets.GuiImgButton.fillVar
The Cyclomatic Complexity of this method "addCheckedInformation" is 11 which is greater than 10 authorized.

thatsIch · Oct 8, 2015

thatsIch reviewed Oct 8, 2015

View changes

thatsIch · Oct 8, 2015

src/main/java/appeng/core/sync/packets/PacketValueConfig.java

-	public final String Name;
-	public final String Value;
+	private final String Name;
+	private final String Value;


vars should start lower case and not like classes

I know.. There are a bunch of them. Probably something I will tackle should the PR for private fields be merged. Also the whole PacketValueConfig is a bit cheesy. Something I want to address with the network refactoring.

Looks fine, I will live test it tomorrow

thatsIch · Oct 8, 2015

Looks fine, I will live test it tomorrow

A nice thing would be if you could see a difference in oredict vs not. This can be another FR though

thatsIch · Oct 10, 2015

A nice thing would be if you could see a difference in oredict vs not. This can be another FR though

Upon crafting my client crashes

thatsIch · Oct 10, 2015

Upon crafting my client crashes

Tried several times already, still failing

thatsIch · Oct 10, 2015

Tried several times already, still failing

http://paste.ee/p/Ma6uz

thatsIch · Oct 10, 2015

http://paste.ee/p/Ma6uz

This still crashes without NEI and CC

thatsIch · Oct 10, 2015

This still crashes without NEI and CC

https://imgur.com/a/VuBpG setup

thatsIch · Oct 10, 2015

https://imgur.com/a/VuBpG setup

Another thing is the place of the substitution button, not sure if this should be there, but maybe below the crafting/processing switch?

thatsIch · Oct 10, 2015

Another thing is the place of the substitution button, not sure if this should be there, but maybe below the crafting/processing switch?

The button was already there. Just hidden, so I simply kept it.

Different icon? As the tooltip already shows if enabled or not and this is also visible inside an interface terminal.

Regarding the crash see: https://bugs.mojang.com/browse/MC-32606

yueh · Oct 10, 2015

The button was already there. Just hidden, so I simply kept it.

Different icon? As the tooltip already shows if enabled or not and this is also visible inside an interface terminal.

Regarding the crash see: https://bugs.mojang.com/browse/MC-32606

Attached the HS log

http://puu.sh/kFif6/e521e32c19.log

thatsIch · Oct 10, 2015

Attached the HS log

http://puu.sh/kFif6/e521e32c19.log

Using the super latest driver fixes this issue or force not to use your 2D desktop application GFX-card

thatsIch · Oct 10, 2015

Using the super latest driver fixes this issue or force not to use your 2D desktop application GFX-card

I mean a direct indicator like upon shift show an iron ingot in the corner to indicate that these are oredictionaried.

thatsIch · Oct 10, 2015

I mean a direct indicator like upon shift show an iron ingot in the corner to indicate that these are oredictionaried.

Hm. There is just the general issue with only 16x16 pixel large icons.

But probably another FR. Also not sure if still possible with 1.8/1.9. I do not really want to add something, if we already know it needs to be reverted later.

yueh · Oct 10, 2015

Hm. There is just the general issue with only 16x16 pixel large icons.

But probably another FR. Also not sure if still possible with 1.8/1.9. I do not really want to add something, if we already know it needs to be reverted later.

yueh changed the title from Added an option to toggle oredict subsitutions for patterns. to Added an option to toggle oredict substitutions for patterns. Sep 21, 2015

yueh added this to the rv3 - 1.7.10 milestone Sep 22, 2015

Added an option to toggle oredict subsitutions for patterns.
It adds a backward compatibility to convert current patterns to use oredict by default, which should be removed with rv4 stable. Closes #1156

Loading status checks…

24224a4

thatsIch self-assigned this Oct 8, 2015

thatsIch added the review-waiting label Oct 8, 2015

thatsIch added review-rejected and removed review-waiting labels Oct 10, 2015

thatsIch added review-waiting and removed review-rejected labels Oct 10, 2015

thatsIch added review-accepted and removed review-waiting labels Oct 10, 2015

yueh added a commit that referenced this pull request Oct 10, 2015

Merge pull request #1891 from yueh/feature-1156
Added an option to toggle oredict substitutions for patterns.

5643519

AppliedEnergistics/Applied-Energistics-2

Join GitHub today

Added an option to toggle oredict substitutions for patterns. #1891

Conversation

yueh commented Sep 21, 2015

yueh changed the title from Added an option to toggle oredict subsitutions for patterns. to Added an option to toggle oredict substitutions for patterns. Sep 21, 2015

orod-org reviewed Sep 21, 2015 View changes

This comment has been minimized.

orod-org reviewed Sep 21, 2015 View changes

This comment has been minimized.

orod-org reviewed Sep 21, 2015 View changes

This comment has been minimized.

orod-org reviewed Sep 21, 2015 View changes

This comment has been minimized.

orod-org reviewed Sep 21, 2015 View changes

This comment has been minimized.

orod-org reviewed Sep 21, 2015 View changes

This comment has been minimized.

orod-org reviewed Sep 21, 2015 View changes

This comment has been minimized.

yueh added this to the rv3 - 1.7.10 milestone Sep 22, 2015

This comment has been minimized.

yueh commented Sep 23, 2015

This comment has been minimized.

thatsIch commented Sep 23, 2015

This comment has been minimized.

yueh commented Sep 23, 2015

This comment has been minimized.

thatsIch commented Sep 23, 2015

This comment has been minimized.

yueh commented Sep 23, 2015

This comment has been minimized.

thatsIch commented Sep 23, 2015

This comment has been minimized.

yueh commented Sep 23, 2015

This comment has been minimized.

yueh commented Sep 26, 2015

This comment has been minimized.

thatsIch commented Sep 26, 2015

thatsIch reviewed Oct 6, 2015 View changes

This comment has been minimized.

thatsIch reviewed Oct 6, 2015 View changes

This comment has been minimized.

This comment has been minimized.

thatsIch reviewed Oct 6, 2015 View changes

This comment has been minimized.

This comment has been minimized.

thatsIch reviewed Oct 6, 2015 View changes

This comment has been minimized.

This comment has been minimized.

thatsIch reviewed Oct 6, 2015 View changes

This comment has been minimized.

thatsIch reviewed Oct 6, 2015 View changes

This comment has been minimized.

This comment has been minimized.

orod-org commented Oct 6, 2015

thatsIch reviewed Oct 8, 2015 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

thatsIch commented Oct 8, 2015

thatsIch self-assigned this Oct 8, 2015

thatsIch added the review-waiting label Oct 8, 2015

This comment has been minimized.

thatsIch commented Oct 10, 2015

This comment has been minimized.

thatsIch commented Oct 10, 2015

This comment has been minimized.

thatsIch commented Oct 10, 2015

This comment has been minimized.

thatsIch commented Oct 10, 2015

This comment has been minimized.

thatsIch commented Oct 10, 2015

This comment has been minimized.

thatsIch commented Oct 10, 2015

thatsIch added review-rejected and removed review-waiting labels Oct 10, 2015

This comment has been minimized.

thatsIch commented Oct 10, 2015

This comment has been minimized.

yueh commented Oct 10, 2015

orod-org reviewed Sep 21, 2015

View changes

orod-org reviewed Sep 21, 2015

View changes

orod-org reviewed Sep 21, 2015

View changes

orod-org reviewed Sep 21, 2015

View changes

orod-org reviewed Sep 21, 2015

View changes

orod-org reviewed Sep 21, 2015

View changes

orod-org reviewed Sep 21, 2015

View changes

thatsIch reviewed Oct 6, 2015

View changes

thatsIch reviewed Oct 6, 2015

View changes

thatsIch reviewed Oct 6, 2015

View changes

thatsIch reviewed Oct 6, 2015

View changes

thatsIch reviewed Oct 6, 2015

View changes

thatsIch reviewed Oct 6, 2015

View changes

thatsIch reviewed Oct 8, 2015

View changes