Distance option to prevent new towns to block old towns expansion. #7364

HydrolienF · 2024-04-15T18:44:07Z

Description:

Add a new config option to prevent town encasement a bit better for older town.
The idea is that if a new town is created close to an older town, the old town will be able to claim more land between the 2 town.
New town could have choose an other location while the old town can't move. So it's unfair for the old town if it get claim blocked by a new town.

New Nodes/Commands/ConfigOptions:

New config option min_plot_distance_from_older_town_plot.
The option is disabled by default and can be enabled by making min_plot_distance_from_older_town_plot > min_plot_distance_from_town_plot

Relevant Towny Issue ticket:

It is the feature that we talk about in #7361

I have tested this pull request for defects on a server. The feature have worked in any case I have tested and I haven't found anything broken about claim distance.

By making this pull request, I represent that I have the right to waive copyright and related rights to my contribution, and agree that all copyright and related rights in my contributions are waived, and I acknowledge that the TownyAdvanced organization has the copyright to use and modify my contribution under the Towny License for perpetuity.

LlmDl

I was able to do a bit of a review, found some changes that should be made. I should be able to do a second review after the requested changes are made. Overall it looks decent.

Towny/src/main/java/com/palmergames/bukkit/towny/object/TownyWorld.java

Towny/src/main/java/com/palmergames/bukkit/config/ConfigNodes.java

…java Co-authored-by: LlmDl <[email protected]>

- Inverse the logic of the predicate to isIgnorableTown. - Move public methods upper than the private one. - Move predicate test - Remove a non necessary anymore ==null test.

…thub.com:HydrolienF/Towny into min_plot_distance_from_town_plot_for_newest_town

HydrolienF · 2024-04-16T17:25:18Z

Thanks for reviewing step by step and helping me doing a better pull request.
I have done the changes.
Let me know if it's look good or if there is somethings else to improve.

are blocked. Extracts a few methods to keep things more readable.

LlmDl · 2024-04-30T16:24:15Z

I've gotten this about to the point that I'm happy with it.

There's a few things I don't really like. Namely, that we're essentially running the distance checks two times every time we test the distance. We are also currently testing the distance rules about twice every time there is claiming already. Once when the claiming selection is made, and then (somewhat redundantly,) checking it again in the proximity rules.

So we're basically going from testing distance twice to testing it four times with this PR.

@Warriorrrr what are you thoughts?

HydrolienF · 2024-05-01T23:31:50Z

There's a few things I don't really like. Namely, that we're essentially running the distance checks two times every time we test the distance. We are also currently testing the distance rules about twice every time there is claiming already. Once when the claiming selection is made, and then (somewhat redundantly,) checking it again in the proximity rules.

So we're basically going from testing distance twice to testing it four times with this PR.

Something that we can do to avoid calculating distance multiple time is add a new function TownyWorld#notTooCloseToOtherTowns(WorldCoord worldCoord, Town town) and make distance test in it instead of in AreaSelectionUtil#worldCoordNotTooCloseToOtherTowns(Town town, WorldCoord worldCoord)

private static boolean worldCoordNotTooCloseToOtherTowns(Town town, WorldCoord worldCoord) {
		TownyWorld townyWorld = worldCoord.getTownyWorld();
		return townyWorld != null 
				&& townyWorld.getMinDistanceFromOtherTownsPlots(worldCoord, town) >= TownySettings.getMinDistanceFromTownPlotblocks()
				&& townyWorld.getMinDistanceFromOtherOlderTownsPlots(worldCoord, town) >= TownySettings.getMinDistanceFromOlderTownPlotblocks();
	}

whould become

private static boolean worldCoordNotTooCloseToOtherTowns(Town town, WorldCoord worldCoord) {
		TownyWorld townyWorld = worldCoord.getTownyWorld();
		return townyWorld != null 
				&& townyWorld.notTooCloseToOtherTowns(worldCoord, town);
	}

And we will add a new function in TownyWorld similar to getMinDistanceFromOtherTownsPlots(...) but where the 2 distance values and the 2 predicates will be tested after distance caclualtion.

public boolean notTooCloseToOtherTowns(Coord key, Town homeTown) {
	final Map<Integer, Predicate<Town>> minDistances = Map.of(TownySettings.getMinDistanceFromTownPlotblocks(), t -> false, TownySettings.getMinDistanceFromOlderTownPlotblocks(), t -> t.getRegistered() > homeTown.getRegistered());
	final int keyX = key.getX();
	final int keyZ = key.getZ();

	for(Town town : getTowns().values()){
		if (homeTown != null && townSkippedByProximityFilter(town, homeTown, t -> false)) // No skip with the predicate here because it will be done later by the map.
			continue;

		for (TownBlock b : town.getTownBlocks()) {
			if (!b.getWorld().equals(this)) continue;

			final int tbX = b.getX();
			final int tbZ = b.getZ();
			
			if (keyX == tbX && keyZ == tbZ)
				continue;
			
			final double distSqr = MathUtil.distanceSquared((double) tbX - keyX, (double) tbZ - keyZ);
			// If there is a town that is too close, return false.
			if (minDistances.entrySet().stream().anyMatch(entry -> distSqr >= entry.getKey() && !entry.getValue().test(town)))
				return false;
		}
	}
	return true;
}

I see this change having 3 advantages:

It do distance caclulation only once.
function stop as soon as it find a too close town instead of caclulating distance for each townplot.
it make it easy to add new distance test on some town. (Just add a new int and a new predicate on the map)

If getMinDistanceFromOtherTownsPlots(...) and getMinDistanceFromOtherOlderTownsPlots(...) are used only to see if a plot is too close from a town, then we can even remove completly this 2 functions and replace them by notTooCloseToOtherTowns(...).

@LlmDl let me know what you think about it. If you think it's a great way to do it, I can update the pull request.

LlmDl · 2024-06-02T13:32:57Z

I think the direction you're planning is the way to go yes, what would be really nice is if we had test coverage applied to the distance/proximity code. Then we'd know if something breaks.

HydrolienF · 2024-06-03T08:44:38Z

Ok, then I will try to do a distance check function with a single for loop, link all current distance check to that function.
And add unit test about it.

…west_town

Update local branch

HydrolienF · 2024-07-06T22:45:48Z

I'm struggling with test part. Any advice on how to claim area with MockBukkit ?

LlmDl · 2024-07-06T22:47:45Z

You don't want to claim stuff, you just want to test the variables work, using values you know will work/not work and passing them into the ProximityUtil methods that would decide if something works or doesn't work.

HydrolienF · 2024-07-06T23:18:33Z

I don't understand how to test ProximityUtil#allowTownHomeBlockOrThrow without having at least one claim on the map.

LlmDl · 2024-07-06T23:33:54Z

For something like that you just need to make the object. Create a town and an townblock, using their constructors, then add the townblock to the town (using the same method used in the TownClaim task ie: townblock.setTown(town) if thats what TownClaim uses.

Afterwards use the town and townblock to do the test.

It's not working for now because townBlock.setTown(...) try to use the pugins, witch is null.

HydrolienF · 2024-08-20T16:09:07Z

Hi @LlmDl
I have create a test with a Town and a TownBlock.
Unfortunately townblock.setTown(town) witch is used by TownClaim to add a towny block to a town isn't working. It would like to have Towny.plugin private static var initialized, but it's not initialized.
Did I forget something in the init part?
Other tests only have

MockBukkit.getOrCreateMock();
TownySettings.loadDefaultConfig();

This is the error:

java.lang.IllegalStateException: Attempted to use getPlugin() while the plugin is null, are you shading Towny? If you do not understand this message, join the Towny discord using https://discord.com/invite/gnpVs5m and ask for support.
		at com.palmergames.bukkit.towny.Towny.getPlugin(Towny.java:764)
		at com.palmergames.bukkit.towny.TownyUniverse.(TownyUniverse.java:100)
		at com.palmergames.bukkit.towny.TownyUniverse.getInstance(TownyUniverse.java:106)
		at com.palmergames.bukkit.towny.object.TownBlock.setTown(TownBlock.java:79)
		at com.palmergames.bukkit.towny.object.TownBlock.setTown(TownBlock.java:68)

LlmDl · 2024-08-20T16:11:21Z

Hi @LlmDl
I have create a test with a Town and a TownBlock.
Unfortunately townblock.setTown(town) witch is used by TownClaim to add a towny block to a town isn't working. It would like to have Towny.plugin private static var initialized, but it's not initialized.
Did I forget something in the init part?
Other tests only have

MockBukkit.getOrCreateMock();
TownySettings.loadDefaultConfig();

This is the error:

java.lang.IllegalStateException: Attempted to use getPlugin() while the plugin is null, are you shading Towny? If you do not understand this message, join the Towny discord using https://discord.com/invite/gnpVs5m and ask for support.
		at com.palmergames.bukkit.towny.Towny.getPlugin(Towny.java:764)
		at com.palmergames.bukkit.towny.TownyUniverse.(TownyUniverse.java:100)
		at com.palmergames.bukkit.towny.TownyUniverse.getInstance(TownyUniverse.java:106)
		at com.palmergames.bukkit.towny.object.TownBlock.setTown(TownBlock.java:79)
		at com.palmergames.bukkit.towny.object.TownBlock.setTown(TownBlock.java:68)

I am away on vacation for a couple more days and I'll look at this after I return. My laptop which I took with me has gotten stuck in a boot loop, and I have only got my phone (which is useless for viewing code on.)

HydrolienF · 2024-09-30T08:14:40Z

Let me know if you have any idea to improve the tests.

LlmDl · 2024-10-01T15:15:48Z

I brought your branch into my IDE and see the issue with the tests. I'm not sure if we'll be able to do a test class that uses anything adding townblocks to towns. That's really quite unfortunate.

HydrolienF · 2024-10-02T17:16:49Z

🙁

HydrolienF · 2024-11-25T09:46:01Z

Any news about this pr ?

HydrolienF added 2 commits April 15, 2024 19:50

Distance option to prevent new towns to block old towns expansion.

1c5dc25

Fix potential NullPpointerExecption on homeTown.

761250f

LlmDl requested changes Apr 16, 2024

View reviewed changes

HydrolienF and others added 5 commits April 16, 2024 18:57

Update Towny/src/main/java/com/palmergames/bukkit/config/ConfigNodes.…

4b3954f

…java Co-authored-by: LlmDl <[email protected]>

Update Towny/src/main/java/com/palmergames/bukkit/config/ConfigNodes.…

2328876

…java Co-authored-by: LlmDl <[email protected]>

Update Towny/src/main/java/com/palmergames/bukkit/config/ConfigNodes.…

8c1474d

…java Co-authored-by: LlmDl <[email protected]>

Make requested changes in TownyAdvanced#7364

eb7f637

- Inverse the logic of the predicate to isIgnorableTown. - Move public methods upper than the private one. - Move predicate test - Remove a non necessary anymore ==null test.

Merge branch 'min_plot_distance_from_town_plot_for_newest_town' of gi…

88ca806

…thub.com:HydrolienF/Towny into min_plot_distance_from_town_plot_for_newest_town

Clean up the code, add in a new lang string to specify why newer claims

af3aa6e

are blocked. Extracts a few methods to keep things more readable.

HydrolienF marked this pull request as draft June 3, 2024 08:44

HydrolienF and others added 8 commits June 7, 2024 14:42

new distances functions to test.

e5363fb

back to Java 8

0bf47da

Back to Java 8 & remove commented code

cf10d3c

Merge branch 'distance2' into min_plot_distance_from_town_plot_for_ne…

5e6ea70

…west_town

Merge pull request #1 from TownyAdvanced/master

4e1749a

Update local branch

Java 17

644aaba

Fix map possible duplicate key and test predicate only if usefull

aa4e001

1st try with tests

ac0339f

Simple test with min claim distance.

4f20b15

It's not working for now because townBlock.setTown(...) try to use the pugins, witch is null.

HydrolienF marked this pull request as ready for review September 30, 2024 08:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Distance option to prevent new towns to block old towns expansion. #7364

Distance option to prevent new towns to block old towns expansion. #7364

HydrolienF commented Apr 15, 2024

LlmDl left a comment

HydrolienF commented Apr 16, 2024

LlmDl commented Apr 30, 2024

HydrolienF commented May 1, 2024

LlmDl commented Jun 2, 2024

HydrolienF commented Jun 3, 2024

HydrolienF commented Jul 6, 2024

LlmDl commented Jul 6, 2024

HydrolienF commented Jul 6, 2024

LlmDl commented Jul 6, 2024

HydrolienF commented Aug 20, 2024

LlmDl commented Aug 20, 2024

HydrolienF commented Sep 30, 2024

LlmDl commented Oct 1, 2024

HydrolienF commented Oct 2, 2024

HydrolienF commented Nov 25, 2024

Distance option to prevent new towns to block old towns expansion. #7364

Are you sure you want to change the base?

Distance option to prevent new towns to block old towns expansion. #7364

Conversation

HydrolienF commented Apr 15, 2024

Description:

New Nodes/Commands/ConfigOptions:

Relevant Towny Issue ticket:

LlmDl left a comment

Choose a reason for hiding this comment

HydrolienF commented Apr 16, 2024

LlmDl commented Apr 30, 2024

HydrolienF commented May 1, 2024

LlmDl commented Jun 2, 2024

HydrolienF commented Jun 3, 2024

HydrolienF commented Jul 6, 2024

LlmDl commented Jul 6, 2024

HydrolienF commented Jul 6, 2024

LlmDl commented Jul 6, 2024

HydrolienF commented Aug 20, 2024

LlmDl commented Aug 20, 2024

HydrolienF commented Sep 30, 2024

LlmDl commented Oct 1, 2024

HydrolienF commented Oct 2, 2024

HydrolienF commented Nov 25, 2024