[WorldEdit API] Save that area that was set and protect it

I´m creating a minigame plugin and i don´t have any ideia of how can i set the area of the minigame in the world and protect and save it.
How can i save the area that was set for the minigame and how can i protect it with the WorldEdit API??
(When the server reload, the area of minigame still in tha same place).

 

Are you asking how would you interface with WorldEdit to define/capture the region by using its (hard to use) API? That is a very complex task. Are you up for it? Show some code of where you are at.

 

@nj2miami I never used the api, so i don´t have a code, but i really wanna try to learn and make it.

 

@PlayerNerd

Hi, I've created a few minigame plugins for my server. If you would like the regions to be protected, I'd recommend you get the latest WorldGuard and use it in your plugin. What I mainly do is create an Arena class that takes a ProtectedCuboidRegion. You can get a player's selection by doing this:

Code:

Selection sel = worldEdit.getSelection(player);

With that selection you can create a new ProtectedCuboidRegion like this:

Code:

ProtectedCuboidRegion region = new ProtectedCuboidRegion("ARENA_NAME", sel.getNativeMinimumPoint().toBlockVector(), sel.getNativeMaximumPoint().toBlockVector());

You would then pass that to your arena. That should get you on the right path. I've included some links below to help you even further. Good luck on your plugin!

ProtectedCuboidRegion API Reference page: http://docs.sk89q.com/worldguard/ap...protection/regions/ProtectedCuboidRegion.html

Information on using the WorldGuard API: http://wiki.sk89q.com/wiki/WorldGuard/Regions/API

Information on using the WorldEdit API: http://www.sk89q.com/2013/03/worldedit-selections-for-bukkit-plugins/

 

@xMakerx But when the server restarts Will it stay save? And i need make a certains regions to get points in minigame, can i make the WorldGuard doesn´t show it in /rg list??

 

@PlayerNerd

You have to manually save the region(s) yourself in a FileConfiguration or YamlConfiguration. You get the minimum and maximum points, save them, and load them when the server restarts.

 

@xMakerx I use this code when i create the arena, it creates but the region doesn´t work.

Code:

ProtectedCuboidRegion region = new ProtectedCuboidRegion(args[2],
                                        s.getNativeMinimumPoint().toBlockVector(), s.getNativeMaximumPoint().toBlockVector());
                               
                                StateFlag flag = DefaultFlag.BUILD;
                                region.setFlag(flag, State.DENY);
                                StateFlag flag2 = DefaultFlag.TNT;
                                region.setFlag(flag2, State.DENY);
                                StateFlag flag3 = DefaultFlag.PVP;
                                region.setFlag(flag3, State.DENY);

Can i make it doesn´t appear in the list of regions??

 

@PlayerNerd

I don't think you can make it so it doesn't appear in the list of regions. Is the region not denying the flags correctly?
Here's an example that you should try:

Code:

        HashMap<Flag<?>, Object> flags = new HashMap<Flag<?>, Object>();
        flags.put(DefaultFlag.BUILD, State.DENY);
        flags.put(DefaultFlag.CREEPER_EXPLOSION, State.DENY);
        flags.put(DefaultFlag.ENTITY_ITEM_FRAME_DESTROY, State.DENY);
        flags.put(DefaultFlag.PVP, State.ALLOW);
        flags.put(DefaultFlag.USE, State.ALLOW);
        flags.put(DefaultFlag.ENDERDRAGON_BLOCK_DAMAGE, State.DENY);
        flags.put(DefaultFlag.DESTROY_VEHICLE, State.DENY);
        region.setFlags(flags);

 

@xMakerx Nothing. When i use /rg list it don´t show nothing, i think that the region isn´t save.

 

You have to add the region manually like this:

Code:

WGBukkit.getRegionManager(world).addRegion(region);

 

@xMakerx How can i use the flag blocked-cmds in API??

 

@PlayerNerd

I don't understand what you mean. The flag example I gave you lets you setup flags. If you mean toggling flags with commands, you would just modify the flags after a command is executed.

 

@xMakerx Okay. Is possible detect when the player pass by a specific region??

 

Yup. Here's a thread that should help you out: http://bukkit.org/threads/check-if-a-player-is-in-a-certain-region.287693/. Do not use a PlayerMoveEvent, though, it's very expensive, try using a BukkitRunnable and test after a while. Just to make it a little cheaper on resources, try only iterating over players in the world of your minigame(s) region(s).

 

@xMakerx Thanks, i´ll try it

 

You're welcome.

 

@xMakerx Could you give me an example??

 

@PlayerNerd

I really don't want to code a brand new example, so just work from this I used for my other plugin:

Code:

    public void startOutpostListening() {
        int delayTime = 5;
        new BukkitRunnable() {
            @SuppressWarnings("deprecation")
            public void run() {
                if(stopCustomEvents) this.cancel();
                Player[] players = main.getServer().getOnlinePlayers();
                for(Player player : players) {
                    Location location = player.getLocation();
                    ApplicableRegionSet regions = worldGuard.getRegionManager(player.getWorld()).getApplicableRegions(location);
                    if(regions.size() > 0) {
                        Outpost outpost = getOutpostFromRegion(regions);
                        if(outpost != null) {
                            main.getServer().getPluginManager().callEvent(new OutpostEnterEvent(outpost, player));
                            playersInOutposts.put(player, outpost);
                        }
                    }
                    if(playersInOutposts.containsKey(player)) {
                        Outpost outpost = playersInOutposts.get(player);
                        if(outpost != null) {
                            main.getServer().getPluginManager().callEvent(new OutpostLeaveEvent(outpost, player));
                            playersInOutposts.remove(player);
                        }
                    }
                }
            }
        }.runTaskTimer(main, (20 * delayTime), (20 * delayTime));
    }

 

@xMakerx Could you explain it??

 

Sure. This method has a BukkitRunnable that runs every 5 seconds and checks every player online's location and sees if they're inside of an Outpost region since this is for my Outpost plugin. Which for what you're making you'd probably have to iterate through each region in the ApplicableRegionSet to see if a player is in your minigame region. Back to what my example is. On line 12 I call another custom method I made which just iterates through the regions and sees if there is an outpost at a certain region, if so, it calls a custom event that a player entered an outpost region and places a player and outpost pair into a HashMap, which is used to see if the player has left a region later on. Next, on line 12, this is what is suppose to happen if there isn't an outpost in that region, but the if statement is out of place, just act like I put it on line 23 as an else if XD. So, it if finds that a player is not in an outpost region anymore and it sees that there is a player and outpost pair for that player in the HashMap it knows that they have exited an outpost region, so it removes them from the HashMap and calls another custom event that a player has left an outpost.

Let me know if you have any other questions. I hope I explained that well enough.

 

@PlayerNerd

If you want to code a minigame, then you could always use the BattleArena Framework:
http://dev.bukkit.org/bukkit-plugins/battlearena2/

Making a minigame with BattleArena is easy:

Just make your Arena class:

Code:java

import mc.alk.arena.objects.arenas.Arena;
 
public class ExampleArena extends Arena {
 
    ExamplePlugin plugin;
 
    @Persist
    Map<Integer, Location> bases = new HashMap<Integer, Location>(); // key = teamID
 
    public ExampleArena(ExamplePlugin reference) {
        plugin = reference;
    }
 
    @ArenaEventHandler
    public void onMatchStartEvent(MatchStartEvent e) { }
 
    @Override
    public void onStart() { }
 
    @Override
    public void onFinish() { }
 
    @ArenaEventHandler
    public void onBlockBreakEvent(BlockBreakEvent e) { }
 
}

Then just register your arena class with BattleArena:

Code:java

public class ExamplePlugin extends JavaPlugin {
 
    ExampleArenaFactory factory;
 
    @Override 
    public void onEnable() {
 
        saveDefaultConfig();
        loadDefaultConfig();
 
        factory = new ExampleArenaFactory(this);
        BattleArena.registerCompetition(this, "ExampleArenaName", "example_cmd", factory, new ExampleExecutor());
 
    }
 
    @Override
    public void onDisable() {
        factory.disableArenas();
    }
}

Making Commands is easier & cleaner too. Take a look at one of mine:

Code:java

 
package mc.euro.demolition.commands;
 
import mc.euro.demolition.BombPlugin;
import java.util.List;
import java.util.Set;
import mc.alk.arena.BattleArena;
import mc.alk.arena.executors.CustomCommandExecutor;
import mc.alk.arena.executors.MCCommand;
import mc.alk.arena.objects.arenas.Arena;
import mc.alk.arena.util.SerializerUtil;
import mc.alk.tracker.objects.PlayerStat;
import mc.alk.tracker.objects.Stat;
import mc.alk.tracker.objects.StatType;
import mc.euro.demolition.BombArena;
import mc.euro.demolition.debug.DebugOff;
import mc.euro.demolition.debug.DebugOn;
import mc.euro.demolition.util.BaseType;
import org.bukkit.Bukkit;
import org.bukkit.ChatColor;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.OfflinePlayer;
import org.bukkit.Sound;
import org.bukkit.command.CommandSender;
import org.bukkit.command.ConsoleCommandSender;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.scheduler.BukkitRunnable;
 
/**
 * All the /bomb commands and subcommands.
 * @author Nikolai
 */
public class BombExecutor extends CustomCommandExecutor {
 
    BombPlugin plugin;
 
    public BombExecutor() {
        plugin = (BombPlugin) Bukkit.getServer().getPluginManager().getPlugin("BombArena");
    }
 
    @MCCommand(cmds={"addbase"}, perm="bombarena.addbase", usage="addbase <arena>")
    public boolean addbase(Player sender, Arena a) {
        if (!(a instanceof BombArena)) {
            sender.sendMessage("Arena must be a valid BombArena.");
            return false;
        }
        BombArena arena = (BombArena) a;
        Location loc = sender.getLocation();
        Location base_loc = plugin.getExactLocation(loc);
 
        if (base_loc == null) {
            sender.sendMessage("addbase command failed to find a BaseBlock near your location.");
            sender.sendMessage("Please set 2 BaseBlocks in the arena (1 for each team).");
            sender.sendMessage("If you have already set BaseBlocks, then stand closer and re-run the command.");
            return true;
        }
        if (arena.getBases().contains(base_loc)) {
            sender.sendMessage("Arena: " + a.getName() + " already contains that base");
            return true;
        }
        arena.addBase(base_loc);
        BattleArena.saveArenas(plugin);
        sender.sendMessage("Base added to arena: " + a.getName());
        return true;
    }
 
    @MCCommand(cmds={"setbase"}, perm="bombarena.setbase", usage="setbase <arena> <teamID>")
    public boolean setbase(Player sender, Arena arena, Integer i) {
        if (i < 1 || i > 2) {
            sender.sendMessage("Bomb arenas can only have 2 teams: 1 or 2");
            return true;
        }
        // path {arenaName}.{index}
        String path = arena.getName() + "." + i.toString();
        Location loc = sender.getLocation();
        Location base_loc = plugin.getExactLocation(loc);
        if (base_loc == null) {
            sender.sendMessage("setbase command failed to find a BaseBlock near your location.");
            sender.sendMessage("Please set 2 BaseBlocks in the arena (1 for each team).");
            sender.sendMessage("If you have already set BaseBlocks, then stand closer and re-run the command.");
            return true;
        }
        String sloc = SerializerUtil.getLocString(base_loc);
        plugin.basesYml.set(path, sloc);
        plugin.basesYml.saveConfig();
        sender.sendMessage("Base " + i + " is now set for arena: " + arena.getName());
        return true;
 
    }
 
    @MCCommand(cmds={"spawnbomb"}, perm="bombarena.spawnbomb", usage="spawnbomb <arena>")
    public boolean spawnbomb(Player sender, String a) {
        plugin.debug.log("arena = " + a);
        Arena arena =(BombArena) BattleArena.getArena(a);
        if (arena == null) return false;
        Material bomb = plugin.getBombBlock();
        int matchTime = arena.getParams().getMatchTime();
 
        plugin.debug.log("spawnbomb() MatchTime = " + matchTime);
 
        String selectArena = "aa select " + arena.getName();
 
        if (plugin.getServer().dispatchCommand(sender, selectArena) 
                && plugin.getServer().dispatchCommand(sender, 
                Command.addspawn(bomb.name(), matchTime))) {
            sender.sendMessage("The bomb spawn for " + arena.getName() + " has been set!");
            return true;
        }
        sender.sendMessage("The spawnbomb command has failed.");
        return false;
    }
 
    @MCCommand(cmds={"stats"}, perm="bomb.stats", usage="stats")
    public boolean stats(CommandSender sender) {
        if (sender instanceof ConsoleCommandSender) {
            sender.sendMessage("Invalid command syntax: Please specify a player name");
            sender.sendMessage("./bomb stats <player>");
            sender.sendMessage("or /bomb stats top X");
            return true;
        }
        stats(sender, plugin.getServer().getOfflinePlayer(sender.getName()));
        return true;
    }
 
    @MCCommand(cmds={"stats"}, perm="bomb.stats.other", usage="stats <player>")
    public boolean stats(CommandSender sender, OfflinePlayer p) {
        if (!plugin.ti.isEnabled()) {
            plugin.getLogger().warning("BattleTracker not found or turned off.");
            sender.sendMessage("BombArena statistics are not being tracked.");
            return true;
        }
        PlayerStat ps = plugin.ti.tracker.getPlayerRecord(p);
        int wins = ps.getWins();
        int ties = ps.getTies();
        int losses = ps.getLosses();
        int total = wins + losses;
        int percentage = (total == 0) ? 0 : (int)  (wins * 100.00) / total;
        String intro = (sender.getName().equalsIgnoreCase(p.getName())) ?
                "You have" : p.getName() + " has";
        sender.sendMessage(intro + " successfully destroyed the other teams base "
                + wins + " times out of " + total + " attempts. ("
                + percentage +"%)");
        sender.sendMessage(intro + " defused the bomb " + ties + " times.");
        return true;
    }
 
    /**
     * Shows bomb arena stats for the command sender.
     * Example Usage: /bomb stats top 5
     */
    @MCCommand(cmds={"stats"}, subCmds={"top"}, perm="bomb.stats.top", usage="stats top X")
    public boolean stats(CommandSender cs, Integer n) {
            if (!plugin.ti.isEnabled()) {
                plugin.getLogger().warning(ChatColor.AQUA + "BattleTracker not found or turned off.");
                cs.sendMessage(ChatColor.YELLOW + "Bomb Arena statistics are not being tracked.");
                return true;
            }
 
            List<Stat> planted = plugin.ti.getTopXWins(n);
            cs.sendMessage(ChatColor.AQUA  +  "Number of Bombs Planted");
            cs.sendMessage(ChatColor.YELLOW + "-----------------------");
            int i = 1;
            for (Stat w : planted) {
            if (w.getName().equalsIgnoreCase(plugin.getFakeName())) {
                continue;
            }
            int total = w.getWins() + w.getLosses();
            int percentage = (total == 0) ? 0 : (int) (w.getWins() * 100.00) / total;
            cs.sendMessage("" + i + " " + w.getName() + " " 
                    + w.getWins() + " out of " + total + " (" + percentage + "%)");
            i = i + 1;
        }
 
            List<Stat> defused = plugin.ti.getTopX(StatType.TIES, n);
            cs.sendMessage(ChatColor.AQUA + "Number of Bombs Defused");
            cs.sendMessage(ChatColor.YELLOW + "-----------------------");
            i = 1;
            for (Stat d : defused) {
                if (d.getName().equalsIgnoreCase(plugin.getFakeName())) continue;
                cs.sendMessage("" + i + " " + d.getName() + " " + d.getTies());
                i = i + 1;
            }
 
            return true;
    }
 
    @MCCommand(cmds={"setconfig"}, subCmds={"bombblock"}, 
            perm="bombarena.setconfig", usage="setconfig BombBlock <handItem>")
    public boolean setBombBlock(Player p) {
        ItemStack hand = p.getInventory().getItemInHand();
        if (hand == null) {
            p.sendMessage("There is nothing in your hand.");
            return false;
        }
        plugin.setBombBlock(hand.getType());
        p.sendMessage("BombBlock has been set to " + hand.getType());
        p.sendMessage("All of your arenas have been automatically "
                + "updated with the new BombBlock.");
        return true;
    }
 
    @MCCommand(cmds={"setconfig"}, subCmds={"baseblock"}, perm="bombarena.setconfig",
            usage="setconfig BaseBlock <handItem>")
    public boolean setBaseBlock(Player p) {
        ItemStack hand = p.getInventory().getItemInHand();
        if (hand == null) {
            p.sendMessage("There is nothing in your hand.");
            return false;
        }
        if (!BaseType.containsKey(hand.getType().name())) {
            p.sendMessage("That is not a valid BaseBlock in your hand!");
            return true;
        }
        p.sendMessage("BaseBlock has been set to " + hand.getType().name());
        plugin.setBaseBlock(hand.getType());
        return true;
    }
 
    @MCCommand(cmds={"setconfig"}, subCmds={"databasetable"}, 
            perm="bombarena.setconfig", usage="setconfig DatabaseTable <name>")
    public boolean setDatabaseTable(CommandSender sender, String table) {
        plugin.setDatabaseTable(table);
        sender.sendMessage("DatabaseTable has been set to " + table);
        return true;
    }
 
    @MCCommand(cmds={"setconfig"}, subCmds={"fakename"}, 
            perm="bombarena.setconfig", usage="setconfig FakeName <new name>")
    public boolean setFakeName(CommandSender sender, String[] name) {
        // name[] = "setconfig fakename args[2] args[3]"
        if (name.length <= 3) {
            sender.sendMessage("FakeName must have at least one space in order "
                    + "to distinguish it from a real player in the database.");
            return false;
        }
        StringBuilder sb = new StringBuilder();
        for (int index = 2; index < name.length; index++) {
            sb.append(name[index]).append(" ");
        }
        String newName = sb.toString().trim();
        plugin.setFakeName(newName);
        sender.sendMessage("FakeName has been set to " + newName);
        return true;
    }
 
    @MCCommand(cmds={"setconfig"}, subCmds={"changefakename"},
            perm="bombarena.setconfig", usage="setconfig ChangeFakeName <name>")
    public boolean setChangeFakeName(CommandSender sender, String name) {
        sender.sendMessage("This option has not been implemented.");
        return true;
    }
    @MCCommand(cmds={"setconfig"}, perm="bombarena.setconfig", usage="setconfig <option> <integer>")
    public boolean setconfig(CommandSender sender, String option, Integer value) {
        Set<String> keys = plugin.getConfig().getKeys(false);
        for (String key : keys) {
            if (option.equalsIgnoreCase(key)) {
                plugin.getConfig().set(key, value);
                sender.sendMessage("" + key + " has been set to " + value);
                plugin.saveConfig();
                plugin.loadDefaultConfig();
                return true;
            }
        }
        sender.sendMessage("Valid options: " + keys.toString());
        return false;
    }
 
    @MCCommand(cmds={"listconfig"}, perm="bombarena.setconfig", usage="listconfig")
    public boolean listconfig(CommandSender sender) {
        sender.sendMessage("Config options: " + plugin.getConfig().getKeys(false).toString());
        return true;
    }
 
    @MCCommand(cmds={"setconfig"}, subCmds={"debug"}, 
            perm="bombarena.setconfig", usage="setconfig debug <true/false>")
    public boolean setDebug(CommandSender sender, boolean b) {
        plugin.getConfig().set("Debug", (boolean) b);
        plugin.saveConfig();
        sender.sendMessage("config.yml option 'Debug' has been set to " + b);
        plugin.loadDefaultConfig();
        return true;
    }
 
    /**
     * Toggles debug mode ON / OFF.
     * Usage: /bomb debug
     */
    @MCCommand(cmds={"debug"}, perm="bombarena.debug", usage="debug")
    public boolean toggleDebug(CommandSender sender) {
        if (plugin.debug instanceof DebugOn) {
            plugin.debug = new DebugOff(plugin);
            plugin.getConfig().set("Debug", false);
            plugin.saveConfig();
            sender.sendMessage("Debugging mode for the BombArena has been turned off.");
            return true;
        } else if (plugin.debug instanceof DebugOff) {
            plugin.debug = new DebugOn(plugin);
            plugin.getConfig().set("Debug", true);
            plugin.saveConfig();
            sender.sendMessage("Debugging mode for the BombArena has been turned on.");
            return true;
        }
        return false;
    }
 
    @MCCommand(cmds={"getname"}, perm="bombarena.setconfig", usage="getname <handItem>")
    public boolean getBlockName(Player p) {
        String name = p.getItemInHand().getType().name();
        p.sendMessage("You are holding " + name);
        return true;
    }
 
    @MCCommand(cmds={"dropItemNaturally"}, op=true)
    public boolean dropItemNaturally(Player player) {
        Location location = player.getLocation();
        ItemStack item = new ItemStack(plugin.getBombBlock());
        player.getLocation().getWorld().dropItemNaturally(location, item);
        return true;
    }
 
    @MCCommand(cmds={"dropItem"}, op=true)
    public boolean dropItem(Player player) {
        Location location = player.getLocation();
        ItemStack item = new ItemStack(plugin.getBombBlock());
        player.getLocation().getWorld().dropItem(location, item);
        return true;
    }
 
    @MCCommand(cmds={"soundlist"}, op=true)
    public boolean soundList(CommandSender sender, Integer page) {
        int size = Sound.values().length;
        int pages = size / 10;
        int start = page * 10;
        int end = start + 10;
        end = (end > size) ? size : end;
        for (int index = start; index < end; index = index + 1) {
            String s = Sound.values()[index].name().toLowerCase();
            sender.sendMessage("" + index + ". " + s);
        }
        sender.sendMessage("Page " + page + " of " + pages);
        return true;
    }
 
    @MCCommand(cmds={"sound"}, op=true)
    public boolean sound(final Player player, String sound) {
        final Sound SOUND;
        final float volume = 1.0f;
        final float pitch = 1.0f;
        try {
            SOUND = Sound.valueOf(sound.toUpperCase());
        } catch (IllegalArgumentException ex) {
            return false;
        }
        final Location loc = player.getLocation();
        new BukkitRunnable() {
            int i = 6;
            @Override
            public void run() {
                i = i - 1;
                if (i <= 0) {
                    cancel();
                    return;
                }
                player.playSound(loc, SOUND, volume, pitch);
            }
 
        }.runTaskTimer(plugin, 0L, 20L);
        return true;
    }
 
 
}

Basically, BattleArena allows you to focus on the rules of your minigame (which are the events inside your Arena class)... And you don't have to worry about stuff like saving and resetting regions... BattleArena takes care of this for you (and a whole bunch of other stuff too).

 

@xMakerx Do i put the code in a new class??

 

My code was just an example, I don't recommend you use it because it's more for my plugin. However, you should use the following line of code to check if a player is in a region.

Code:

ApplicableRegionSet regions = worldGuard.getRegionManager(player.getWorld()).getApplicableRegions(location);

You would iterate through that and check if any of your Arenas has that region. Just so you know, the ApplicableRegionSet holds instances of the ProtectedRegion class, so iteration would be like this:

Code:

for(ProtectedRegion region : regions) {}

OR

for(int i = 0; i < regions.size(); i++) {}

 

@xMakerx Like it??

Code:

ApplicableRegionSet regions = WGBukkit.getRegionManager(p.getWorld()).getApplicableRegions(p.getLocation());
                                    for(ProtectedRegion region : regions)
                                    {
                                        if(region.contains((int) p.getLocation().getX(),(int) p.getLocation().getY(),(int) p.getLocation().getZ()))
                                        {
                                           
                                        }
                                    }

 

I don't think that if statement will work. I recommend you iterate through your Arenas and check if the regions are equal to eachother, or you can check if the region names are the same.