Interface OreAnnouncerAPI


  • public interface OreAnnouncerAPI
    • Method Detail

      • reloadPlugin

        void reloadPlugin()
        Reload OreAnnouncer configuration files
      • reloadOreAnnouncer

        @Deprecated
        default void reloadOreAnnouncer()
        Deprecated.
        Use reloadPlugin() instead
        Reload OreAnnouncer configuration files
      • isBungeeCordEnabled

        boolean isBungeeCordEnabled()
        Check if the plugin have BungeeCord option enabled
        Returns:
        True if BungeeCord support is enabled
      • getOAPlayer

        OAPlayer getOAPlayer​(UUID uuid)
        Get the player by his UUID
        Parameters:
        uuid - The UUID of the player
        Returns:
        Returns the OAPlayer of the relative player
      • getTopPlayersByDestroy

        default LinkedHashMap<OAPlayer,​Integer> getTopPlayersByDestroy​(int numberOfPlayers)
        Get top players ordered by destroy
        Parameters:
        numberOfPlayers - Number of players to get
        Returns:
        Returns a map of OAPlayer and Integer
      • getTopPlayersByDestroy

        default LinkedHashMap<OAPlayer,​Integer> getTopPlayersByDestroy​(int numberOfPlayers,
                                                                             OABlock block)
        Get top players ordered by given block destroy
        Parameters:
        numberOfPlayers - Number of players to get
        block - The block to use as filter
        Returns:
        Returns a map of OAPlayer and Integer
      • getTopPlayersByDestroy

        default LinkedHashMap<OAPlayer,​Integer> getTopPlayersByDestroy​(int numberOfPlayers,
                                                                             int offset)
        Get top players ordered by destroy
        Parameters:
        numberOfPlayers - Number of players to get
        offset - Offset of players list
        Returns:
        Returns a map of OAPlayer and Integer
      • getTopPlayersByDestroy

        LinkedHashMap<OAPlayer,​Integer> getTopPlayersByDestroy​(int numberOfPlayers,
                                                                     OABlock block,
                                                                     int offset)
        Get top players ordered by block destroy
        Parameters:
        numberOfPlayers - Number of players to get
        block - The block to use as filter
        offset - Offset of players list
        Returns:
        Returns a map of OAPlayer and Integer
      • getTopPlayersByFound

        default LinkedHashMap<OAPlayer,​Integer> getTopPlayersByFound​(int numberOfPlayers)
        Get top players ordered by found
        Parameters:
        numberOfPlayers - Number of players to get
        Returns:
        Returns a map of OAPlayer and Integer
      • getTopPlayersByFound

        default LinkedHashMap<OAPlayer,​Integer> getTopPlayersByFound​(int numberOfPlayers,
                                                                           OABlock block)
        Get top players ordered by block found
        Parameters:
        numberOfPlayers - Number of players to get
        block - The block to use as filter
        Returns:
        Returns a map of OAPlayer and Integer
      • getTopPlayersByFound

        default LinkedHashMap<OAPlayer,​Integer> getTopPlayersByFound​(int numberOfPlayers,
                                                                           int offset)
        Get top players ordered by found
        Parameters:
        numberOfPlayers - Number of players to get
        offset - Offset of players list
        Returns:
        Returns a map of OAPlayer and Integer
      • getTopPlayersByFound

        LinkedHashMap<OAPlayer,​Integer> getTopPlayersByFound​(int numberOfPlayers,
                                                                   OABlock block,
                                                                   int offset)
        Get top players ordered by block found
        Parameters:
        numberOfPlayers - Number of players to get
        block - The block to use as filter
        offset - Offset the result list
        Returns:
        Returns a map of OAPlayer and Integer
      • 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 by player
        Parameters:
        limit - The result number limit
        player - The player to use as filter
        Returns:
        Returns a set of OABlockFound
      • getLogBlocks

        default LinkedList<OABlockFound> getLogBlocks​(int limit,
                                                      OABlock block)
        Get latest blocks of block found
        Parameters:
        limit - The result number limit
        block - 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 of block found by player
        Parameters:
        limit - The result number limit
        player - The player to use as filter
        block - 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 of block found by player
        Parameters:
        limit - The result number limit
        player - The player to use as filter
        block - The block to use as filter
        offset - 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 new OABlockDestroy
        Parameters:
        playerUuid - The player UUID
        block - The block
        destroyCount - The number of destroyed blocks
        Returns:
        Returns a new instance of OABlockDestroy