com.sk89q.worldguard.bukkit

Class WorldGuardPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.sk89q.worldguard.bukkit.WorldGuardPlugin

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class WorldGuardPlugin
extends org.bukkit.plugin.java.JavaPlugin

The main class for WorldGuard as a Bukkit plugin.

Constructor Summary

Constructors

Constructor and Description
WorldGuardPlugin() Construct objects.

Method Summary

Modifier and Type	Method and Description
void	broadcastNotification(String msg) Notifies all with the worldguard.notify permission.
boolean	canBuild(org.bukkit.entity.Player player, org.bukkit.block.Block block) Checks to see if a player can build at a location.
boolean	canBuild(org.bukkit.entity.Player player, org.bukkit.Location loc) Checks to see if a player can build at a location.
void	checkPermission(org.bukkit.command.CommandSender sender, String perm) Checks permissions and throws an exception if permission is not met.
org.bukkit.entity.Player	checkPlayer(org.bukkit.command.CommandSender sender) Checks to see if the sender is a player, otherwise throw an exception.
protected Iterable<? extends org.bukkit.entity.Player>	checkPlayerMatch(List<? extends org.bukkit.entity.Player> players) Checks if the given list of players is greater than size 0, otherwise throw an exception.
String	convertThrowable(Throwable throwable) Convert the throwable into a somewhat friendly message.
void	createDefaultConfiguration(File actual, String defaultName) Create a default configuration file from the .jar.
ProtectionQuery	createProtectionQuery() Return a protection query helper object that can be used by another plugin to test whether WorldGuard permits an action at a particular place.
com.google.common.util.concurrent.ListeningExecutorService	getExecutorService() Get the global executor service for internal usage (please use your own executor service).
ConfigurationManager	getGlobalConfiguration() Deprecated. Use getGlobalStateManager() instead
GlobalRegionManager	getGlobalRegionManager() Deprecated. use getRegionContainer()
ConfigurationManager	getGlobalStateManager() Get the global ConfigurationManager.
String[]	getGroups(org.bukkit.entity.Player player) Get the groups of a player.
PlayerMoveListener	getPlayerMoveListener()
com.sk89q.squirrelid.cache.ProfileCache	getProfileCache() Get the profile cache.
com.sk89q.squirrelid.resolver.ProfileService	getProfileService() Get the profile lookup service.
RegionContainer	getRegionContainer() Get the object that manages region data.
RegionManager	getRegionManager(org.bukkit.World world) Gets the region manager for a world.
SessionManager	getSessionManager() Gets the flag state manager.
Supervisor	getSupervisor() Get the supervisor.
com.sk89q.worldedit.bukkit.WorldEditPlugin	getWorldEdit() Gets a copy of the WorldEdit plugin.
boolean	hasPermission(org.bukkit.command.CommandSender sender, String perm) Checks permissions.
boolean	inGroup(org.bukkit.entity.Player player, String group) Check whether a player is in a group.
static WorldGuardPlugin	inst() Get the current instance of WorldGuard
List<org.bukkit.entity.Player>	matchPlayerNames(String filter) Match player names.
org.bukkit.command.CommandSender	matchPlayerOrConsole(org.bukkit.command.CommandSender sender, String filter) Match only a single player or console.
Iterable<? extends org.bukkit.entity.Player>	matchPlayers(org.bukkit.command.CommandSender source, String filter) Matches players based on the specified filter string The filter string format is as follows: * returns all the players currently online If sender is a Player: #world returns all players in the world that sender is in #near reaturns all players within 30 blocks of sender's location Otherwise, the format is as specified in matchPlayerNames(String)
Iterable<org.bukkit.entity.Player>	matchPlayers(org.bukkit.entity.Player player) Get a single player as an iterator for players.
org.bukkit.entity.Player	matchSinglePlayer(org.bukkit.command.CommandSender sender, String filter) Match only a single player.
org.bukkit.World	matchWorld(org.bukkit.command.CommandSender sender, String filter) Match a world.
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, String label, String[] args)
void	onDisable()
void	onEnable() Called on plugin enable.
String	replaceMacros(org.bukkit.command.CommandSender sender, String message) Replace macros in the text.
String	toName(org.bukkit.command.CommandSender sender) Gets the name of a command sender.
String	toUniqueName(org.bukkit.command.CommandSender sender) Gets the name of a command sender.
LocalPlayer	wrapOfflinePlayer(org.bukkit.OfflinePlayer player) Wrap a player as a LocalPlayer.
LocalPlayer	wrapPlayer(org.bukkit.entity.Player player) Wrap a player as a LocalPlayer.
LocalPlayer	wrapPlayer(org.bukkit.entity.Player player, boolean silenced) Wrap a player as a LocalPlayer.

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, initialize, installDDL, isEnabled, isInitialized, isNaggable, onLoad, onTabComplete, reloadConfig, removeDDL, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorldGuardPlugin

public WorldGuardPlugin()

Construct objects. Actual loading occurs when the plugin is enabled, so this merely instantiates the objects.

Method Detail

inst

public static WorldGuardPlugin inst()

Get the current instance of WorldGuard

Returns:

WorldGuardPlugin instance

onEnable

public void onEnable()

Called on plugin enable.

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                         org.bukkit.command.Command cmd,
                         String label,
                         String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

Overrides:

onCommand in class org.bukkit.plugin.java.JavaPlugin

convertThrowable

public String convertThrowable(@Nullable
                               Throwable throwable)

Convert the throwable into a somewhat friendly message.

Parameters:

throwable - the throwable

Returns:

a message

getGlobalRegionManager

@Deprecated
public GlobalRegionManager getGlobalRegionManager()

Deprecated. use getRegionContainer()

Get the GlobalRegionManager.

Returns:

the plugin's global region manager

getRegionContainer

public RegionContainer getRegionContainer()

Get the object that manages region data.

Returns:

the region container

getGlobalConfiguration

@Deprecated
public ConfigurationManager getGlobalConfiguration()

Deprecated. Use getGlobalStateManager() instead

Get the WorldGuard Configuration.

Returns:

ConfigurationManager

getSessionManager

public SessionManager getSessionManager()

Gets the flag state manager.

Returns:

The flag state manager

getGlobalStateManager

public ConfigurationManager getGlobalStateManager()

Get the global ConfigurationManager. USe this to access global configuration values and per-world configuration values.

Returns:

The global ConfigurationManager

getSupervisor

public Supervisor getSupervisor()

Get the supervisor.

Returns:

the supervisor

getExecutorService

public com.google.common.util.concurrent.ListeningExecutorService getExecutorService()

Get the global executor service for internal usage (please use your own executor service).

Returns:

the global executor service

getProfileService

public com.sk89q.squirrelid.resolver.ProfileService getProfileService()

Get the profile lookup service.

Returns:

the profile lookup service

getProfileCache

public com.sk89q.squirrelid.cache.ProfileCache getProfileCache()

Get the profile cache.

Returns:

the profile cache

inGroup

public boolean inGroup(org.bukkit.entity.Player player,
                       String group)

Check whether a player is in a group. This calls the corresponding method in PermissionsResolverManager

Parameters:

player - The player to check

group - The group

Returns:

whether player is in group

getGroups

public String[] getGroups(org.bukkit.entity.Player player)

Get the groups of a player. This calls the corresponding method in PermissionsResolverManager.

Parameters:

player - The player to check

Returns:

The names of each group the playe is in.

toUniqueName

public String toUniqueName(org.bukkit.command.CommandSender sender)

Gets the name of a command sender. This is a unique name and this method should never return a "display name".

Parameters:

sender - The sender to get the name of

Returns:

The unique name of the sender.

toName

public String toName(org.bukkit.command.CommandSender sender)

Gets the name of a command sender. This play be a display name.

Parameters:

sender - The CommandSender to get the name of.

Returns:

The name of the given sender

hasPermission

public boolean hasPermission(org.bukkit.command.CommandSender sender,
                             String perm)

Checks permissions.

Parameters:

sender - The sender to check the permission on.

perm - The permission to check the permission on.

Returns:

whether sender has perm

checkPermission

public void checkPermission(org.bukkit.command.CommandSender sender,
                            String perm)
                     throws com.sk89q.minecraft.util.commands.CommandPermissionsException

Checks permissions and throws an exception if permission is not met.

Parameters:

sender - The sender to check the permission on.

perm - The permission to check the permission on.

Throws:

com.sk89q.minecraft.util.commands.CommandPermissionsException - if sender doesn't have perm

checkPlayer

public org.bukkit.entity.Player checkPlayer(org.bukkit.command.CommandSender sender)
                                     throws com.sk89q.minecraft.util.commands.CommandException

Checks to see if the sender is a player, otherwise throw an exception.

Parameters:

sender - The CommandSender to check

Returns:

sender casted to a player

Throws:

com.sk89q.minecraft.util.commands.CommandException - if sender isn't a Player

matchPlayerNames

public List<org.bukkit.entity.Player> matchPlayerNames(String filter)

Match player names. The filter string uses the following format:

Parameters:

filter - The filter string to check.

Returns:

A List of players who match filter

checkPlayerMatch

protected Iterable<? extends org.bukkit.entity.Player> checkPlayerMatch(List<? extends org.bukkit.entity.Player> players)
                                                                 throws com.sk89q.minecraft.util.commands.CommandException

Checks if the given list of players is greater than size 0, otherwise throw an exception.

Parameters:

players - The List to check

Returns:

players as an Iterable

Throws:

com.sk89q.minecraft.util.commands.CommandException - If players is empty

matchPlayers

public Iterable<? extends org.bukkit.entity.Player> matchPlayers(org.bukkit.command.CommandSender source,
                                                                 String filter)
                                                          throws com.sk89q.minecraft.util.commands.CommandException

Matches players based on the specified filter string The filter string format is as follows: * returns all the players currently online If sender is a Player: #world returns all players in the world that sender is in #near reaturns all players within 30 blocks of sender's location Otherwise, the format is as specified in matchPlayerNames(String)

Parameters:

source - The CommandSender who is trying to find a player

filter - The filter string for players

Returns:

iterator for players

Throws:

com.sk89q.minecraft.util.commands.CommandException - if no matches are found

matchSinglePlayer

public org.bukkit.entity.Player matchSinglePlayer(org.bukkit.command.CommandSender sender,
                                                  String filter)
                                           throws com.sk89q.minecraft.util.commands.CommandException

Match only a single player.

Parameters:

sender - The CommandSender who is requesting a player match

filter - The filter string.

Returns:

The single player

Throws:

com.sk89q.minecraft.util.commands.CommandException - If more than one player match was found

See Also:

for filter string syntax

matchPlayerOrConsole

public org.bukkit.command.CommandSender matchPlayerOrConsole(org.bukkit.command.CommandSender sender,
                                                             String filter)
                                                      throws com.sk89q.minecraft.util.commands.CommandException

Match only a single player or console. The filter string syntax is as follows: #console, *console, or ! return the server console All syntax from matchSinglePlayer(org.bukkit.command.CommandSender, String)

Parameters:

sender - The sender trying to match a CommandSender

filter - The filter string

Returns:

The resulting CommandSender

Throws:

com.sk89q.minecraft.util.commands.CommandException - if either zero or more than one player matched.

matchPlayers

public Iterable<org.bukkit.entity.Player> matchPlayers(org.bukkit.entity.Player player)

Get a single player as an iterator for players.

Parameters:

player - The player to return in an Iterable

Returns:

iterator for player

matchWorld

public org.bukkit.World matchWorld(org.bukkit.command.CommandSender sender,
                                   String filter)
                            throws com.sk89q.minecraft.util.commands.CommandException

Match a world. The filter string syntax is as follows: #main returns the main world #normal returns the first world with a normal environment #nether return the first world with a nether environment #player:[name] returns the world that a player named name is located in, if the player is online. [name] A world with the name name

Parameters:

sender - The sender requesting a match

filter - The filter string

Returns:

The resulting world

Throws:

com.sk89q.minecraft.util.commands.CommandException - if no world matches

getWorldEdit

public com.sk89q.worldedit.bukkit.WorldEditPlugin getWorldEdit()
                                                        throws com.sk89q.minecraft.util.commands.CommandException

Gets a copy of the WorldEdit plugin.

Returns:

The WorldEditPlugin instance

Throws:

com.sk89q.minecraft.util.commands.CommandException - If there is no WorldEditPlugin available

wrapPlayer

public LocalPlayer wrapPlayer(org.bukkit.entity.Player player)

Wrap a player as a LocalPlayer.

Parameters:

player - The player to wrap

Returns:

The wrapped player

wrapPlayer

public LocalPlayer wrapPlayer(org.bukkit.entity.Player player,
                              boolean silenced)

Wrap a player as a LocalPlayer.

Parameters:

player - The player to wrap

silenced - True to silence messages

Returns:

The wrapped player

wrapOfflinePlayer

public LocalPlayer wrapOfflinePlayer(org.bukkit.OfflinePlayer player)

Wrap a player as a LocalPlayer.

This implementation is incomplete -- permissions cannot be checked.

Parameters:

player - The player to wrap

Returns:

The wrapped player

createProtectionQuery

public ProtectionQuery createProtectionQuery()

Return a protection query helper object that can be used by another plugin to test whether WorldGuard permits an action at a particular place.

Returns:

an instance

createDefaultConfiguration

public void createDefaultConfiguration(File actual,
                                       String defaultName)

Create a default configuration file from the .jar.

Parameters:

actual - The destination file

defaultName - The name of the file inside the jar's defaults folder

broadcastNotification

public void broadcastNotification(String msg)

Notifies all with the worldguard.notify permission. This will check both superperms and WEPIF, but makes sure WEPIF checks don't result in duplicate notifications

Parameters:

msg - The notification to broadcast

canBuild

public boolean canBuild(org.bukkit.entity.Player player,
                        org.bukkit.Location loc)

Checks to see if a player can build at a location. This will return true if region protection is disabled.

Parameters:

player - The player to check.

loc - The location to check at.

Returns:

whether player can build at loc

See Also:

GlobalRegionManager.canBuild(org.bukkit.entity.Player, org.bukkit.Location)

canBuild

public boolean canBuild(org.bukkit.entity.Player player,
                        org.bukkit.block.Block block)

Checks to see if a player can build at a location. This will return true if region protection is disabled.

Parameters:

player - The player to check

block - The block to check at.

Returns:

whether player can build at block's location

See Also:

GlobalRegionManager.canBuild(org.bukkit.entity.Player, org.bukkit.block.Block)

getRegionManager

public RegionManager getRegionManager(org.bukkit.World world)

Gets the region manager for a world.

Parameters:

world - world to get the region manager for

Returns:

the region manager or null if regions are not enabled

getPlayerMoveListener

public PlayerMoveListener getPlayerMoveListener()

replaceMacros

public String replaceMacros(org.bukkit.command.CommandSender sender,
                            String message)

Replace macros in the text. The macros replaced are as follows: %name%: The name of sender. See toName(org.bukkit.command.CommandSender) %id%: The unique name of the sender. See toUniqueName(org.bukkit.command.CommandSender) %online%: The number of players currently online on the server If sender is a Player: %world%: The name of the world sender is located in %health%: The health of sender. See Damageable.getHealth()

Parameters:

sender - The sender to check

message - The message to replace macros in

Returns:

The message with macros replaced