Package sawfowl.regionguard.api

Interface RegionAPI

All Known Implementing Classes:
Api
public interface RegionAPI

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    RegionAPI.PostAPI
    This interface is designed to access the plugin's API.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addTempRegion(UUID user, Region region)
    Adding a temporary region
    void
    addTempRegion(Region region)
    Deprecated.
    void
    deleteRegion(Region region)
    Deleting a region.
    Region
    findIntersectsRegion(Region region)
    Search for the region with which the intersection occurs.
    Region
    findRegion(org.spongepowered.api.ResourceKey worldkey, org.spongepowered.math.vector.Vector3i position)
    Search for a region in the world using the specified coordinates.
    If the region contains child regions, the deepest child region will be returned.
    Region
    findRegion(org.spongepowered.api.world.server.ServerWorld world, org.spongepowered.math.vector.Vector3i position)
    Search for a region in the world using the specified coordinates.
    Optional<Region>
    findRegion(org.spongepowered.api.world.server.ServerWorld world, org.spongepowered.math.vector.Vector3i position, Predicate<Region> filter)
    Search for a region in the world using the specified coordinates.
    double
    getBuyBlockPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the value of the block price for the player.
    double
    getBuyClaimPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the value of the region price for the player.
    double
    getBuyMembersPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting the value of the price of the region's participant limit increase.
    double
    getBuySubdivisionPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the value of the subdivision price for the player.
    long
    getClaimedBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the number of blocks that belong to the player.
    long
    getClaimedRegions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the number of regions belonging to the player.
    org.spongepowered.api.service.economy.Currency
    getCurrency(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting the currency in which the player will perform the transaction.
    Map<String,Set<FlagValue>>
    getDefaultFlags(RegionTypes regionType)
    Get the default flags for a certain type of region.
    Region
    getGlobalRegion(org.spongepowered.api.ResourceKey worldkey)
    Get world region.
    Region
    getGlobalRegion(org.spongepowered.api.world.server.ServerWorld serverWorld)
    Get world region.
    long
    getLimitBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting the limit of blocks that can claiming the player.
    long
    getLimitClaims(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting the limit of regions that can claiming the player.
    long
    getLimitMaxBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    The maximum limit of blocks a player can claim.
    long
    getLimitMaxClaims(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    The maximum limit of regions a player can claim.
    long
    getLimitMaxMembers(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    The maximum limit of members of the player region..
    long
    getLimitMaxSubdivisions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    The maximum limit of child regions a player can create.
    long
    getLimitMembers(UUID player)
    Getting the members limit for each region of a particular player.
    Each region has its own separate members limit.
    long
    getLimitMembers(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting the members limit for each region of a particular player.
    Each region has its own separate members limit.
    long
    getLimitSubdivisions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the maximum number of child regions a player can create.
    int
    getMinimalRegionSize(SelectorTypes selectorType)
    Get the minimum size of the region, which is set in the main configuration file.
    Optional<PlayerData>
    getPlayerData(UUID player)
    Getting limits and other information on the player.
    Optional<PlayerData>
    getPlayerData(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting limits and other information on the player.
    List<Region>
    getPlayerRegions(UUID playerUUID)
    Obtaining all player regions.
    List<Region>
    getPlayerRegions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Obtaining all player regions.
    Collection<Region>
    getRegions()
    Getting all registered regions except globals.
    Map<org.spongepowered.api.ResourceKey,Map<ChunkNumber,ArrayList<Region>>>
    getRegionsPerWorld()
    Obtaining a map of regions by worlds.
    Map<String,FlagConfig>
    getRegisteredFlags()
    Getting all registered flags.
    SelectorTypes
    getSelectorType(UUID uuid)
    Obtaining a type of region selector from the player.
    RegionTypes
    getSelectRegionType(UUID uuid)
    Getting the type of regions creating by the player.
    RegionTypes
    getSelectRegionType(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting the type of regions creating by the player.
    double
    getSellBlockPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the value of the block price for the player.
    double
    getSellClaimPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the value of the region price for the player.
    double
    getSellMembersPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Getting the value of the price of the region members limit decrease.
    double
    getSellSubdivisionPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Get the value of the subdivision price for the player.
    Optional<Region>
    getTempRegion(UUID uuid)
    Get a temporary region
    org.spongepowered.api.item.inventory.ItemStack
    getWandItem()
    Getting an item for selecting regions.
    WorldEditCUIAPI
    getWorldEditCUIAPI()
    Go to the API for visually highlighting regions with a mod on the WECui client.
    void
    registerFlag(String flagName, FlagConfig settings)
    FlagConfig registration.
    void
    registerRegion(Region region)
    Region registration.
    void
    registerRegionAsync(Region region)
    Region registration in asynchronous mode.
    void
    removeTempRegion(UUID uuid)
    Removing a temporary region
    void
    removeTempRegion(Region region)
    Removing a temporary region
    void
    saveRegion(Region region)
    Saving region data to disk.
    void
    setCreatingRegionType(UUID uuid, RegionTypes regionType)
    Specifies the type of regions created by the player.
    void
    setCreatingRegionType(org.spongepowered.api.entity.living.player.server.ServerPlayer player, RegionTypes claim)
    Specifies the type of regions created by the player.
    void
    setLimitBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
    Change the limit of blocks a player can claim.
    void
    setLimitClaims(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
    Set the number of regions a player can own.
    void
    setLimitMembers(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
    Set the number of players that each player region can contain.
    void
    setLimitSubdivisions(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
    Set a limit to the subdivisions a player can create.
    void
    setPlayerData(UUID player, PlayerData playerData)
    Setting limits and other information on the player.
    void
    setPlayerData(org.spongepowered.api.entity.living.player.server.ServerPlayer player, PlayerData playerData)
    Setting limits and other information on the player.
    void
    setSelectorType(UUID uuid, SelectorTypes selectorType)
    Set a type of region selector for the player.
    void
    setSelectorType(org.spongepowered.api.entity.living.player.server.ServerPlayer player, SelectorTypes selectorType)
    Set a type of region selector for the player.
    void
    unregisterRegion(Region region)
    Remove the region from the list of registered regions.
    This method will not remove the region from the disk.
    void
    updateGlobalRegionData(org.spongepowered.api.world.server.ServerWorld serverWorld, Region region)
    Update global region data.
    void
    updatePlayerData(UUID player)
    Update cached data on regions and blocks claimed by the player.
    void
    updatePlayerData(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Update cached data on regions and blocks claimed by the player.

  • Method Details

    • getRegisteredFlags

      Map<String,FlagConfig> getRegisteredFlags()
      Getting all registered flags.

    • registerFlag

      void registerFlag(String flagName, FlagConfig settings)
      FlagConfig registration. Values cannot be null.

    • updateGlobalRegionData

      void updateGlobalRegionData(org.spongepowered.api.world.server.ServerWorld serverWorld, Region region)
      Update global region data.
      Parameters:
      serverWorld - - world
      region - - world region.

    • addTempRegion

      @Deprecated void addTempRegion(Region region)
      Deprecated.
      Adding a temporary region
      Parameters:
      region -

    • addTempRegion

      void addTempRegion(UUID user, Region region)
      Adding a temporary region
      Parameters:
      region -

    • removeTempRegion

      void removeTempRegion(Region region)
      Removing a temporary region

    • removeTempRegion

      void removeTempRegion(UUID uuid)
      Removing a temporary region
      Parameters:
      uuid - - owner uuid

    • getTempRegion

      Optional<Region> getTempRegion(UUID uuid)
      Get a temporary region
      Parameters:
      uuid - - owner uuid
      Returns:
      Optional or empty

    • getSelectorType

      SelectorTypes getSelectorType(UUID uuid)
      Obtaining a type of region selector from the player.
      Parameters:
      uuid -
      Returns:
      Player-selected region selector type, or default selection type.

    • setSelectorType

      void setSelectorType(org.spongepowered.api.entity.living.player.server.ServerPlayer player, SelectorTypes selectorType)
      Set a type of region selector for the player.
      Parameters:
      selectorType - - SelectorTypes

    • setSelectorType

      void setSelectorType(UUID uuid, SelectorTypes selectorType)
      Set a type of region selector for the player.
      Parameters:
      uuid - - player uuid
      selectorType - - SelectorTypes

    • getGlobalRegion

      Region getGlobalRegion(org.spongepowered.api.world.server.ServerWorld serverWorld)
      Get world region.
      Parameters:
      serverWorld - - the world of the region.
      Returns:
      Region

    • getGlobalRegion

      Region getGlobalRegion(org.spongepowered.api.ResourceKey worldkey)
      Get world region.
      Parameters:
      worldkey - - the world key of the region.
      Returns:
      Region

    • getRegions

      Collection<Region> getRegions()
      Getting all registered regions except globals.
      Returns:
      Collection

    • getRegionsPerWorld

      Map<org.spongepowered.api.ResourceKey,Map<ChunkNumber,ArrayList<Region>>> getRegionsPerWorld()
      Obtaining a map of regions by worlds.
      Without global regions.

    • registerRegion

      void registerRegion(Region region)
      Region registration.
      The method does not save the region data to disk.
      Parameters:
      region - - Registrable region.

    • registerRegionAsync

      void registerRegionAsync(Region region)
      Region registration in asynchronous mode.
      Parameters:
      region - - Registrable region.

    • unregisterRegion

      void unregisterRegion(Region region)
      Remove the region from the list of registered regions.
      This method will not remove the region from the disk.

    • saveRegion

      void saveRegion(Region region)
      Saving region data to disk.
      Parameters:
      region - - Preservable region..

    • deleteRegion

      void deleteRegion(Region region)
      Deleting a region.
      Parameters:
      region - - Removable region.

    • findRegion

      Region findRegion(org.spongepowered.api.world.server.ServerWorld world, org.spongepowered.math.vector.Vector3i position)
      Search for a region in the world using the specified coordinates.
      If the region contains child regions, the deepest child region will be returned.
      Parameters:
      world - - The world in which the search will be performed.
      position - - Checkable position.
      Returns:
      - Found region or global region.

    • findRegion

      Optional<Region> findRegion(org.spongepowered.api.world.server.ServerWorld world, org.spongepowered.math.vector.Vector3i position, Predicate<Region> filter)
      Search for a region in the world using the specified coordinates.
      If the region contains child regions, the deepest child region will be returned.
      Parameters:
      world - - The world in which the search will be performed.
      position - - Checkable position.
      Returns:
      - Found region or global region.

    • findRegion

      Region findRegion(org.spongepowered.api.ResourceKey worldkey, org.spongepowered.math.vector.Vector3i position)
      Search for a region in the world using the specified coordinates.
      If the region contains child regions, the deepest child region will be returned.
      Parameters:
      worldkey - - The key of the world in which you want to search.
      position - - Checkable position.
      Returns:
      - Found region or global region.

    • findIntersectsRegion

      Region findIntersectsRegion(Region region)
      Search for the region with which the intersection occurs.
      Parameters:
      region - - Original region.
      Returns:
      The first region found with which there is an intersection.
      Or the original region if no intersection is found.

    • getPlayerRegions

      List<Region> getPlayerRegions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Obtaining all player regions.
      Parameters:
      player - - Owner of the regions.
      Returns:
      - List of player regions.

    • getPlayerRegions

      List<Region> getPlayerRegions(UUID playerUUID)
      Obtaining all player regions.
      Parameters:
      playerUUID - - UUID of owner of the regions.
      Returns:
      - List of player regions.

    • getWandItem

      org.spongepowered.api.item.inventory.ItemStack getWandItem()
      Getting an item for selecting regions.

    • getSelectRegionType

      RegionTypes getSelectRegionType(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting the type of regions creating by the player.
      Returns:
      RegionTypes

    • getSelectRegionType

      RegionTypes getSelectRegionType(UUID uuid)
      Getting the type of regions creating by the player.
      Parameters:
      uuid - - player uuid
      Returns:
      RegionTypes

    • setCreatingRegionType

      void setCreatingRegionType(org.spongepowered.api.entity.living.player.server.ServerPlayer player, RegionTypes claim)
      Specifies the type of regions created by the player.
      You cannot assign the types: global, subdivision, unset.

    • setCreatingRegionType

      void setCreatingRegionType(UUID uuid, RegionTypes regionType)
      Specifies the type of regions created by the player.
      You cannot assign the types: global, subdivision, unset.

    • getMinimalRegionSize

      int getMinimalRegionSize(SelectorTypes selectorType)
      Get the minimum size of the region, which is set in the main configuration file.
      Parameters:
      selectorType - - Type of region selection.
      Returns:
      - The minimum number of blocks that should be in the region.

    • getDefaultFlags

      Map<String,Set<FlagValue>> getDefaultFlags(RegionTypes regionType)
      Get the default flags for a certain type of region.

    • getClaimedBlocks

      long getClaimedBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the number of blocks that belong to the player.
      Parameters:
      player - - Checked player
      Returns:
      - The amount of blocks the player owns according to the type of allocation of each region.

    • getClaimedRegions

      long getClaimedRegions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the number of regions belonging to the player.
      Parameters:
      player - - Checked player
      Returns:
      - The number of regions belonging to the player.

    • getLimitBlocks

      long getLimitBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting the limit of blocks that can claiming the player.
      Parameters:
      player - - Checked player
      Returns:
      - The number of blocks available to the player for claiming.

    • getLimitClaims

      long getLimitClaims(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting the limit of regions that can claiming the player.
      Parameters:
      player - - Checked player
      Returns:
      - The number of regions available to the player for claiming.

    • getLimitSubdivisions

      long getLimitSubdivisions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the maximum number of child regions a player can create.
      Each basic region has its own limit.
      Parameters:
      player - - Checked player

    • getLimitMembers

      long getLimitMembers(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting the members limit for each region of a particular player.
      Each region has its own separate members limit.
      Parameters:
      player - - Checked player
      Returns:
      - The number of members limit for each region of a particular player.

    • getLimitMembers

      long getLimitMembers(UUID player)
      Getting the members limit for each region of a particular player.
      Each region has its own separate members limit.
      Parameters:
      player - - Checked player
      Returns:
      - The number of members limit for each region of a particular player.

    • getLimitMaxBlocks

      long getLimitMaxBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      The maximum limit of blocks a player can claim.
      Parameters:
      player - - Checked player
      Returns:
      - The number of blocks available to the player for claiming.

    • getLimitMaxClaims

      long getLimitMaxClaims(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      The maximum limit of regions a player can claim.
      Parameters:
      player - - Checked player
      Returns:
      - The number of regions available to the player for claiming.

    • getLimitMaxSubdivisions

      long getLimitMaxSubdivisions(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      The maximum limit of child regions a player can create.
      Each basic region has its own limit.
      Parameters:
      player - - Checked player
      Returns:
      - The number of subdivisions available to the player for creating.

    • getLimitMaxMembers

      long getLimitMaxMembers(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      The maximum limit of members of the player region..
      Each basic region has its own limit.
      Parameters:
      player - - Checked player
      Returns:
      - The maximum number of region members a player can add.

    • getBuyBlockPrice

      double getBuyBlockPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the value of the block price for the player.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getBuyClaimPrice

      double getBuyClaimPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the value of the region price for the player.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getBuySubdivisionPrice

      double getBuySubdivisionPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the value of the subdivision price for the player.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getBuyMembersPrice

      double getBuyMembersPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting the value of the price of the region's participant limit increase.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getSellBlockPrice

      double getSellBlockPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the value of the block price for the player.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getSellClaimPrice

      double getSellClaimPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the value of the region price for the player.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getSellSubdivisionPrice

      double getSellSubdivisionPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Get the value of the subdivision price for the player.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getSellMembersPrice

      double getSellMembersPrice(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting the value of the price of the region members limit decrease.
      Depending on how the permissions plugin is set up, different players may have different prices.

    • getCurrency

      org.spongepowered.api.service.economy.Currency getCurrency(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting the currency in which the player will perform the transaction. Depending on how the permissions plugin is set up, different players may have different currencies.

    • setLimitBlocks

      void setLimitBlocks(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
      Change the limit of blocks a player can claim.

    • setLimitClaims

      void setLimitClaims(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
      Set the number of regions a player can own.

    • setLimitSubdivisions

      void setLimitSubdivisions(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
      Set a limit to the subdivisions a player can create.

    • setLimitMembers

      void setLimitMembers(org.spongepowered.api.entity.living.player.server.ServerPlayer player, long limit)
      Set the number of players that each player region can contain.

    • setPlayerData

      void setPlayerData(org.spongepowered.api.entity.living.player.server.ServerPlayer player, PlayerData playerData)
      Setting limits and other information on the player.

    • setPlayerData

      void setPlayerData(UUID player, PlayerData playerData)
      Setting limits and other information on the player.

    • updatePlayerData

      void updatePlayerData(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Update cached data on regions and blocks claimed by the player.

    • updatePlayerData

      void updatePlayerData(UUID player)
      Update cached data on regions and blocks claimed by the player.

    • getPlayerData

      Optional<PlayerData> getPlayerData(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Getting limits and other information on the player.

    • getPlayerData

      Optional<PlayerData> getPlayerData(UUID player)
      Getting limits and other information on the player.

    • getWorldEditCUIAPI

      WorldEditCUIAPI getWorldEditCUIAPI()
      Go to the API for visually highlighting regions with a mod on the WECui client.