clone/WorldGuardWrapper
1
0
Fork 1
mirror of https://github.com/CodeMC/WorldGuardWrapper.git synced 2024-09-19 20:26:57 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation

Browse Source
This commit is contained in:
Eric 2018-08-02 16:45:56 +02:00
parent c2414fd23e
commit 71eb53c38f
1 changed files with 42 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
implementation/interface/src/main/java/org/codemc/worldguardwrapper/implementation/IWorldGuardImplementation.java
View File

@ -10,15 +10,54 @@ import lombok.NonNull;
public interface IWorldGuardImplementation {
/**
* Get an instance of the WorldGuardPlugin class
*
* @return The WorldGuard plugin
*/
JavaPlugin getWorldGuardPlugin();
/**
* Get the API version of the loaded WorldGuard plugin (e.g. 6 or 7).
*
* @return The API version
*/
int getApiVersion();
Optional<Boolean> queryStateFlag(Player player, @NonNull Location location, @NonNull String flagId);
boolean registerStateFlag(@NonNull String flagId, @NonNull Boolean defaultValue);
/**
* Query a StateFlag's value for a given player at a given location.
*
* @param player The player
* @param location The location
* @param flag The flag's name
* @return The flag's value
*/
Optional<Boolean> queryStateFlag(Player player, @NonNull Location location, @NonNull String flagName);
/**
* Register a {@code StateFlag}.
*
* @param flagName The name of the flag
* @param defaultValue The flag's default value
* @return Whether the flag has been registered
*/
boolean registerStateFlag(@NonNull String flagName, @NonNull Boolean defaultValue);
/**
* Query a flag's value for a given player at a given location.
*
* @param player The player
* @param location The location
* @param flag The flag
* @return The flag's value
*/
<T> Optional<T> queryFlag(Player player, @NonNull Location location, @NonNull AbstractFlag<T> flag);
/**
* Register a flag to WorldGuard's flag registry.
*
* @param flag The flag to register
* @return Whether the flag has been registered
*/
<T> boolean registerFlag(@NonNull AbstractFlag<T> flag);
}