Interface OreAnnouncerAPI
-
public interface OreAnnouncerAPI
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description @Nullable OABlock
addBlock(@NotNull String materialName)
Add a block to the configuration@Nullable OABlock
getBlock(@NotNull String materialName)
Get the block from the configurationdefault LinkedList<OABlockFound>
getLogBlocks(int limit)
Get latest blocks founddefault LinkedList<OABlockFound>
getLogBlocks(int limit, OABlock block)
Get latest blocks ofblock
founddefault LinkedList<OABlockFound>
getLogBlocks(int limit, OAPlayer player)
Get latest blocks found byplayer
default LinkedList<OABlockFound>
getLogBlocks(int limit, OAPlayer player, OABlock block)
Get latest blocks ofblock
found byplayer
LinkedList<OABlockFound>
getLogBlocks(int limit, OAPlayer player, OABlock block, int offset)
Get latest blocks ofblock
found byplayer
OAPlayer
getOAPlayer(UUID uuid)
Get the player by hisUUID
default LinkedHashMap<OAPlayer,Integer>
getTopPlayersByDestroy(int numberOfPlayers)
Get top players ordered by destroydefault LinkedHashMap<OAPlayer,Integer>
getTopPlayersByDestroy(int numberOfPlayers, int offset)
Get top players ordered by destroydefault LinkedHashMap<OAPlayer,Integer>
getTopPlayersByDestroy(int numberOfPlayers, OABlock block)
Get top players ordered by given block destroyLinkedHashMap<OAPlayer,Integer>
getTopPlayersByDestroy(int numberOfPlayers, OABlock block, int offset)
Get top players ordered by block destroydefault LinkedHashMap<OAPlayer,Integer>
getTopPlayersByFound(int numberOfPlayers)
Get top players ordered by founddefault LinkedHashMap<OAPlayer,Integer>
getTopPlayersByFound(int numberOfPlayers, int offset)
Get top players ordered by founddefault LinkedHashMap<OAPlayer,Integer>
getTopPlayersByFound(int numberOfPlayers, OABlock block)
Get top players ordered by block foundLinkedHashMap<OAPlayer,Integer>
getTopPlayersByFound(int numberOfPlayers, OABlock block, int offset)
Get top players ordered by block foundboolean
isBungeeCordEnabled()
Check if the plugin have BungeeCord option enabledOABlockDestroy
makeBlockDestroy(@NotNull UUID playerUuid, @NotNull OABlock block, int destroyCount)
Make a newOABlockDestroy
default void
reloadOreAnnouncer()
Deprecated.Use reloadPlugin() insteadvoid
reloadPlugin()
Reload OreAnnouncer configuration filesvoid
removeBlock(@NotNull OABlock block)
Remove the block from the configuration
-
-
-
Method Detail
-
reloadPlugin
void reloadPlugin()
Reload OreAnnouncer configuration files
-
reloadOreAnnouncer
@Deprecated default void reloadOreAnnouncer()
Deprecated.Use reloadPlugin() insteadReload OreAnnouncer configuration files
-
isBungeeCordEnabled
boolean isBungeeCordEnabled()
Check if the plugin have BungeeCord option enabled- Returns:
- True if BungeeCord support is enabled
-
getTopPlayersByDestroy
default LinkedHashMap<OAPlayer,Integer> getTopPlayersByDestroy(int numberOfPlayers)
Get top players ordered by destroy
-
getTopPlayersByDestroy
default LinkedHashMap<OAPlayer,Integer> getTopPlayersByDestroy(int numberOfPlayers, OABlock block)
Get top players ordered by given block destroy
-
getTopPlayersByDestroy
default LinkedHashMap<OAPlayer,Integer> getTopPlayersByDestroy(int numberOfPlayers, int offset)
Get top players ordered by destroy
-
getTopPlayersByDestroy
LinkedHashMap<OAPlayer,Integer> getTopPlayersByDestroy(int numberOfPlayers, OABlock block, int offset)
Get top players ordered by block destroy
-
getTopPlayersByFound
default LinkedHashMap<OAPlayer,Integer> getTopPlayersByFound(int numberOfPlayers)
Get top players ordered by found
-
getTopPlayersByFound
default LinkedHashMap<OAPlayer,Integer> getTopPlayersByFound(int numberOfPlayers, OABlock block)
Get top players ordered by block found
-
getTopPlayersByFound
default LinkedHashMap<OAPlayer,Integer> getTopPlayersByFound(int numberOfPlayers, int offset)
Get top players ordered by found
-
getTopPlayersByFound
LinkedHashMap<OAPlayer,Integer> getTopPlayersByFound(int numberOfPlayers, OABlock block, int offset)
Get top players ordered by block found
-
getLogBlocks
default LinkedList<OABlockFound> getLogBlocks(int limit)
Get latest blocks found- Parameters:
limit
- The result number limit- Returns:
- Returns a set of
OABlockFound
-
getLogBlocks
default LinkedList<OABlockFound> getLogBlocks(int limit, OAPlayer player)
Get latest blocks found byplayer
- Parameters:
limit
- The result number limitplayer
- The player to use as filter- Returns:
- Returns a set of
OABlockFound
-
getLogBlocks
default LinkedList<OABlockFound> getLogBlocks(int limit, OABlock block)
Get latest blocks ofblock
found- Parameters:
limit
- The result number limitblock
- The block to use as filter- Returns:
- Returns a set of
OABlockFound
-
getLogBlocks
default LinkedList<OABlockFound> getLogBlocks(int limit, OAPlayer player, OABlock block)
Get latest blocks ofblock
found byplayer
- Parameters:
limit
- The result number limitplayer
- The player to use as filterblock
- The block to use as filter- Returns:
- Returns a set of
OABlockFound
-
getLogBlocks
LinkedList<OABlockFound> getLogBlocks(int limit, OAPlayer player, OABlock block, int offset)
Get latest blocks ofblock
found byplayer
- Parameters:
limit
- The result number limitplayer
- The player to use as filterblock
- The block to use as filteroffset
- Offset the result list- Returns:
- Returns a set of
OABlockFound
-
getBlock
@Nullable @Nullable OABlock getBlock(@NotNull @NotNull String materialName)
Get the block from the configuration- Parameters:
materialName
- The block to get- Returns:
- Returns the block or null if not exists
-
addBlock
@Nullable @Nullable OABlock addBlock(@NotNull @NotNull String materialName)
Add a block to the configuration- Parameters:
materialName
- The block name to add- Returns:
- Returns a new block or null if already exists
-
removeBlock
void removeBlock(@NotNull @NotNull OABlock block)
Remove the block from the configuration- Parameters:
block
- The block to remove
-
makeBlockDestroy
OABlockDestroy makeBlockDestroy(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull OABlock block, int destroyCount)
Make a newOABlockDestroy
- Parameters:
playerUuid
- The player UUIDblock
- The blockdestroyCount
- The number of destroyed blocks- Returns:
- Returns a new instance of
OABlockDestroy
-
-