Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2025-04-09 13:46:33 +02:00
Code Issues Projects Releases Wiki Activity

Started javadoc-ing Flags

Browse Source
This commit is contained in:
Florian CUNY 2019-02-02 11:30:43 +01:00
parent 53eec634fb
commit ade4a141c4
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/main/java/world/bentobox/bentobox/lists/Flags.java
View File

@ -51,6 +51,9 @@ import world.bentobox.bentobox.listeners.flags.clicklisteners.CommandRankClickLi
import world.bentobox.bentobox.listeners.flags.clicklisteners.GeoLimitClickListener; import world.bentobox.bentobox.listeners.flags.clicklisteners.GeoLimitClickListener;
import world.bentobox.bentobox.managers.RanksManager; import world.bentobox.bentobox.managers.RanksManager;
/**
* Contains built-in {@link Flag Flags} that are registered by default into the {@link world.bentobox.bentobox.managers.FlagsManager FlagsManager} at startup.
*/
public final class Flags { public final class Flags {
private Flags() {} private Flags() {}
@ -58,10 +61,21 @@ public final class Flags {
// Disabled setting 'rank' // Disabled setting 'rank'
private static final int DISABLED = -1; private static final int DISABLED = -1;
/**
* Prevents players from breaking blocks on one's island.
* @see BreakBlocksListener
*/
public static final Flag BREAK_BLOCKS = new Flag.Builder("BREAK_BLOCKS", Material.STONE).listener(new BreakBlocksListener()).build(); public static final Flag BREAK_BLOCKS = new Flag.Builder("BREAK_BLOCKS", Material.STONE).listener(new BreakBlocksListener()).build();
/**
* Prevents players from placing blocks on one's island.
* @see PlaceBlocksListener
*/
public static final Flag PLACE_BLOCKS = new Flag.Builder("PLACE_BLOCKS", Material.GRASS).listener(new PlaceBlocksListener()).build(); public static final Flag PLACE_BLOCKS = new Flag.Builder("PLACE_BLOCKS", Material.GRASS).listener(new PlaceBlocksListener()).build();
// Frost walker - uses the place block listener /**
* Prevents players from generated Frosted Ice on one's island using boots enchanted with "Frost Walker".
* @see PlaceBlocksListener
*/
public static final Flag FROST_WALKER = new Flag.Builder("FROST_WALKER", Material.ICE).build(); public static final Flag FROST_WALKER = new Flag.Builder("FROST_WALKER", Material.ICE).build();
// Block interactions - all use BlockInteractionListener() // Block interactions - all use BlockInteractionListener()
@ -247,7 +261,9 @@ public final class Flags {
public static final Flag OBSIDIAN_SCOOPING = new Flag.Builder("OBSIDIAN_SCOOPING", Material.OBSIDIAN).type(Type.WORLD_SETTING) public static final Flag OBSIDIAN_SCOOPING = new Flag.Builder("OBSIDIAN_SCOOPING", Material.OBSIDIAN).type(Type.WORLD_SETTING)
.listener(new ObsidianScoopingListener()).defaultSetting(true).build(); .listener(new ObsidianScoopingListener()).defaultSetting(true).build();
/** /**
* Provides a list of all the Flag instances contained in this class using reflection.
* @return List of all the flags in this class * @return List of all the flags in this class
*/ */
public static List<Flag> values() { public static List<Flag> values() {