Skip to content

Commit

Permalink
Implements gamemode flags API
Browse files Browse the repository at this point in the history 
#406
  • Loading branch information
@tastybento
tastybento committed Feb 12, 2019
1 parent 75c9f6f commit 03ef51d
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 25 deletions.
69 changes: 67 additions & 2 deletions src/main/java/world/bentobox/bentobox/api/flags/Flag.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@
import org.bukkit.World;
import org.bukkit.event.Listener;
import org.bukkit.inventory.ItemStack;

import org.eclipse.jdt.annotation.NonNull;

import world.bentobox.bentobox.BentoBox;
import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.api.configuration.WorldSettings;
import world.bentobox.bentobox.api.flags.clicklisteners.CycleClick;
import world.bentobox.bentobox.api.flags.clicklisteners.IslandToggleClick;
Expand Down Expand Up @@ -71,18 +72,20 @@ public Material getIcon() {
private final int defaultRank;
private final PanelItem.ClickHandler clickHandler;
private final boolean subPanel;
private final GameModeAddon gameModeAddon;

/**
* {@link Flag.Builder} should be used instead. This is only used for testing.
*/
Flag(String id, Material icon, Listener listener, Type type, int defaultRank, PanelItem.ClickHandler clickListener, boolean subPanel) {
Flag(String id, Material icon, Listener listener, Type type, int defaultRank, PanelItem.ClickHandler clickListener, boolean subPanel, GameModeAddon gameModeAddon) {
this.id = id;
this.icon = icon;
this.listener = listener;
this.type = type;
this.defaultRank = defaultRank;
this.clickHandler = clickListener;
this.subPanel = subPanel;
this.gameModeAddon = gameModeAddon;
}

private Flag(Builder builder) {
Expand All @@ -94,6 +97,7 @@ private Flag(Builder builder) {
this.defaultRank = builder.defaultRank;
this.clickHandler = builder.clickHandler;
this.subPanel = builder.usePanel;
this.gameModeAddon = builder.gameModeAddon;
}

public String getID() {
Expand Down Expand Up @@ -226,6 +230,13 @@ public String getHintReference() {
return PROTECTION_FLAGS + this.id + ".hint";
}

/**
* @return the gameModeAddon
*/
public GameModeAddon getGameModeAddon() {
return gameModeAddon;
}

/**
* Converts a flag to a panel item. The content of the flag will change depending on who the user is and where they are.
* @param plugin - plugin
Expand Down Expand Up @@ -298,6 +309,7 @@ public int compareTo(Flag o) {
}

/**
* Builder for making flags
* @author tastybento, Poslovitch
*/
public static class Builder {
Expand All @@ -321,41 +333,94 @@ public static class Builder {
// Whether there is a sub-panel or not
private boolean usePanel = false;

// GameModeAddon
private GameModeAddon gameModeAddon;

/**
* Builder for making flags
* @param id - a unique id that MUST be the same as the enum of the flag
* @param icon - a material that will be used as the icon in the GUI
*/
public Builder(String id, Material icon) {
this.id = id;
this.icon = icon;
}

/**
* The listener that should be instantiated to handle events this flag cares about.
* If the listener class already exists, then do not create it again in another flag.
* @param listener - Bukkit Listener
* @return Builder
*/
public Builder listener(Listener listener) {
this.listener = listener;
return this;
}

/**
* The type of flag.
* @param type {@link Type#PROTECTION}, {@link Type#SETTING} or {@link Type#WORLD_SETTING}
* @return Builder
*/
public Builder type(Type type) {
this.type = type;
return this;
}

/**
* The click handler to use when this icon is clicked
* @param clickHandler - click handler
* @return Builder
*/
public Builder clickHandler(PanelItem.ClickHandler clickHandler) {
this.clickHandler = clickHandler;
return this;
}

/**
* Set the default setting for {@link Type#SETTING} or {@link Type#WORLD_SETTING} flags
* @param defaultSetting - true or false
* @return Builder
*/
public Builder defaultSetting(boolean defaultSetting) {
this.defaultSetting = defaultSetting;
return this;
}

/**
* Set the default rank for {@link Type#PROTECTION} flags
* @param defaultRank - default rank
* @return Builder
*/
public Builder defaultRank(int defaultRank) {
this.defaultRank = defaultRank;
return this;
}

/**
* Set that this flag icon will open up a sub-panel
* @param usePanel - true or false
* @return Builder
*/
public Builder usePanel(boolean usePanel) {
this.usePanel = usePanel;
return this;
}

/**
* Make this flag specific to this gameMode
* @param gameModeAddon
* @return
*/
public Builder setGameMode(GameModeAddon gameModeAddon) {
this.gameModeAddon = gameModeAddon;
return this;
}

/**
* Build the flag
* @return Flag
*/
public Flag build() {
// If no clickHandler has been set, then apply default ones
if (clickHandler == null) {
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/world/bentobox/bentobox/panels/SettingsPanel.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ public static void openPanel(BentoBox plugin, User user, Flag.Type flagType, Wor
List<Flag> flags = plugin.getFlagsManager().getFlags().stream().filter(f -> f.getType().equals(flagType))
.sorted(Comparator.comparing(flag -> user.getTranslation(flag.getNameReference())))
.collect(Collectors.toList());

// Remove any that are not for this world
plugin.getIWM().getAddon(world).ifPresent(gm -> flags.removeIf(f -> f.getGameModeAddon() != null && !f.getGameModeAddon().equals(gm)));
// Use paging
flags.stream().skip(page * 43L).limit(page * 43L + 43L).forEach((f -> panelBuilder.item(f.toPanelItem(plugin, user))));
// Add forward and backward icons
Expand Down
44 changes: 22 additions & 22 deletions src/test/java/world/bentobox/bentobox/api/flags/FlagTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,52 +78,52 @@ public void setUp() throws Exception {

@Test
public void testHashCode() {
Flag flag1 = new Flag(null, null, null, null, 0, null, false);
Flag flag2 = new Flag(null, null, null, null, 0, null, false);
Flag flag1 = new Flag(null, null, null, null, 0, null, false, null);
Flag flag2 = new Flag(null, null, null, null, 0, null, false, null);
assertTrue(flag1.hashCode() == flag2.hashCode());
}

@Test
public void testFlag() {
assertNotNull(new Flag(null, null, null, null, 0, null, false));
assertNotNull(new Flag(null, null, null, null, 0, null, false, null));
}

@Test
public void testGetID() {
Flag id = new Flag("id", null, null, null, 0, null, false);
Flag id = new Flag("id", null, null, null, 0, null, false, null);
assertEquals("id", id.getID());
}

@Test
public void testGetIcon() {
Flag id = new Flag("id", Material.ACACIA_DOOR, null, null, 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, null, 0, null, false, null);
assertEquals(Material.ACACIA_DOOR, id.getIcon());
}

@Test
public void testGetListener() {
Listener l = mock(Listener.class);
Flag id = new Flag("id", Material.ACACIA_DOOR, l, null, 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, l, null, 0, null, false, null);
Optional<Listener> ol = Optional.ofNullable(l);
assertEquals(ol, id.getListener());
id = new Flag("id", Material.ACACIA_DOOR, null, null, 0, null, false);
id = new Flag("id", Material.ACACIA_DOOR, null, null, 0, null, false, null);
assertEquals(Optional.empty(), id.getListener());
}

@Test
public void testIsDefaultSetting() {
Type type = Type.SETTING;
Flag id = new Flag("id", Material.ACACIA_DOOR, null, type , 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, type , 0, null, false, null);
assertFalse(id.isSetForWorld(mock(World.class)));
id = new Flag("id", Material.ACACIA_DOOR, null, type, 0, null, false);
id = new Flag("id", Material.ACACIA_DOOR, null, type, 0, null, false, null);
id.setDefaultSetting(true);
assertTrue(id.isSetForWorld(mock(World.class)));
}

@Test
public void testSetDefaultSetting() {
Type type = Type.SETTING;
Flag id = new Flag("id", Material.ACACIA_DOOR, null, type, 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, type, 0, null, false, null);
assertFalse(id.isSetForWorld(mock(World.class)));
id.setDefaultSetting(true);
assertTrue(id.isSetForWorld(mock(World.class)));
Expand All @@ -135,44 +135,44 @@ public void testSetDefaultSetting() {
@Test
public void testIsDefaultSetting_World_Setting() {
Type type = Type.WORLD_SETTING;
Flag id = new Flag("id", Material.ACACIA_DOOR, null, type , 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, type , 0, null, false, null);
assertFalse(id.isSetForWorld(mock(World.class)));
// Default can only be set once with world settings, so use a new id for flag
id = new Flag("id2", Material.ACACIA_DOOR, null, type, 0, null, false);
id = new Flag("id2", Material.ACACIA_DOOR, null, type, 0, null, false, null);
id.setDefaultSetting(true);
assertTrue(id.isSetForWorld(mock(World.class)));
}

@Test
public void testGetType() {
Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false, null);
assertEquals(Flag.Type.PROTECTION,id.getType());
id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.SETTING, 0, null, false);
id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.SETTING, 0, null, false, null);
assertEquals(Flag.Type.SETTING,id.getType());
}

@Test
public void testGetDefaultRank() {
Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 100, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 100, null, false, null);
assertEquals(100, id.getDefaultRank());
}

@SuppressWarnings("unlikely-arg-type")
@Test
public void testEqualsObject() {
Flag flag1 = null;
Flag flag2 = new Flag(null, null, null, null, 0, null, false);
Flag flag2 = new Flag(null, null, null, null, 0, null, false, null);

assertFalse(flag2.equals(null));
int i = 45;
assertFalse(flag2.equals(i));

flag1 = new Flag(null, null, null, null, 0, null, false);
flag1 = new Flag(null, null, null, null, 0, null, false, null);
flag2 = flag1;
assertTrue(flag1.equals(flag2));
assertTrue(flag2.equals(flag1));

flag2 = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false);
flag2 = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false, null);
assertFalse(flag1.equals(flag2));
assertFalse(flag2.equals(flag1));

Expand Down Expand Up @@ -209,7 +209,7 @@ public void testToPanelItem() throws Exception {
when(rm.getRank(Mockito.eq(RanksManager.VISITOR_RANK))).thenReturn("Visitor");
when(rm.getRank(Mockito.eq(RanksManager.OWNER_RANK))).thenReturn("Owner");

Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false, null);

PanelItem pi = id.toPanelItem(plugin, user);

Expand All @@ -222,14 +222,14 @@ public void testToPanelItem() throws Exception {

@Test
public void testToString() {
Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false);
Flag id = new Flag("id", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false, null);
assertEquals("Flag [id=id, icon=ACACIA_DOOR, listener=null, type=PROTECTION, defaultSetting=false, defaultRank=0, clickHandler=null, subPanel=false]", id.toString());
}

@Test
public void testCompareTo() {
Flag aaa = new Flag("AAA", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false);
Flag bbb = new Flag("BBB", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false);
Flag aaa = new Flag("AAA", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false, null);
Flag bbb = new Flag("BBB", Material.ACACIA_DOOR, null, Flag.Type.PROTECTION, 0, null, false, null);
assertTrue(aaa.compareTo(bbb) < bbb.compareTo(aaa));
assertTrue(aaa.compareTo(aaa) == 0);
}
Expand Down

0 comments on commit 03ef51d

Please sign in to comment.