Package de.z0rdak.yawp.api.core

Interface IRegionManager

All Known Implementing Classes:
RegionManager
public interface IRegionManager

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    createDimRegion(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
    Creates a new DimensionalRegionCache (and DimensionalRegion) for the specified dimension.
    net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>
    getDimApiKey(String dimKey)
    Create the corresponding ResourceKey for the provided resource key string (e.g.
    Optional<IProtectedRegion>
    getDimensionalRegion(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
    You can safely cast the returned instance of to DimensionalRegion, but it doesn't provide any benefit.
    Optional<DimensionRegionCache>
    getDimensionCache(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
    Gets the DimensionRegionCache for the specified dimension.
    Set<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>>
    getDimensions()
    Returns a set of resource keys for all created Dimensional Regions
    Optional<IDimensionRegionApi>
    getDimRegionApi(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
    Gets the DimensionalRegion API for the specified dimension key.
    Optional<IDimensionRegionApi>
    getDimRegionApiByKey(String dimKey)
    Gets the DimensionalRegion API for the specified dimension key (E.g.
    GlobalRegion
    getGlobalRegion()
     
    boolean
    hasRegionFor(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
    Check whether a DimensionalRegion for the specified dimension already exists.
    void
    resetDimension(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
    Resets the DimensionalRegion as well as all LocalRegions of the corresponding level.
    void
    resetGlobal()
    This only resets the Global Region, not its child regions.
    void
    save()
    Flag the scheduler to save the region data.

  • Method Details

    • getGlobalRegion

      GlobalRegion getGlobalRegion()

    • resetGlobal

      void resetGlobal()
      This only resets the Global Region, not its child regions.

    • getDimensionalRegion

      Optional<IProtectedRegion> getDimensionalRegion(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
      You can safely cast the returned instance of to DimensionalRegion, but it doesn't provide any benefit.
      Parameters:
      dim - the resource key of the dimension/level * @return the DimensionRegionCache corresponding to dim

    • getDimensionCache

      Optional<DimensionRegionCache> getDimensionCache(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
      Gets the DimensionRegionCache for the specified dimension. A DimensionRegionCache manages the DimensionalRegion and all Local Regions of the corresponding dimensions.
      Parameters:
      dim - the resource key of the dimension/level
      Returns:
      the DimensionRegionCache corresponding to dim

    • save

      void save()
      Flag the scheduler to save the region data. This usually happens either - cyclic (when enabled) - when leaving the world (in single player) - shutting down the server gracefully - or executing the '/save-all' command.

    • getDimRegionApi

      Optional<IDimensionRegionApi> getDimRegionApi(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
      Gets the DimensionalRegion API for the specified dimension key.
      Parameters:
      dim - the dimension key to get the API for
      Returns:
      the DimensionalRegionApi for the specified dimension key if it exists, otherwise Optional.Empty

    • getDimRegionApiByKey

      Optional<IDimensionRegionApi> getDimRegionApiByKey(String dimKey)
      Gets the DimensionalRegion API for the specified dimension key (E.g. "minecraft:overworld").
      Parameters:
      dimKey - the dimension key to get the API for
      Returns:
      the DimensionalRegionApi for the specified dimension key if it exists, otherwise Optional.Empty

    • getDimApiKey

      net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> getDimApiKey(String dimKey)
      Create the corresponding ResourceKey for the provided resource key string (e.g. 'minecraft:overworld') Basically a wrapper around `ResourceKey.create(Registries.DIMENSION, ResourceLocation.parse(dimKey));`
      Parameters:
      dimKey - resource key of the level/dimension
      Returns:
      the corresponding ResourceKey for the level/dimension

    • hasRegionFor

      boolean hasRegionFor(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
      Check whether a DimensionalRegion for the specified dimension already exists.
      Parameters:
      dim - the dimension key to check for
      Returns:
      true if a DimensionalRegion exists, false otherwise

    • createDimRegion

      boolean createDimRegion(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
      Creates a new DimensionalRegionCache (and DimensionalRegion) for the specified dimension.
      Parameters:
      dim - the dimension identifier of the dimension
      Returns:
      true if a new DimensionalRegionCache was created, false if it already existed

    • getDimensions

      Set<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>> getDimensions()
      Returns a set of resource keys for all created Dimensional Regions
      Returns:
      a set of resource keys corresponding to registered DimensionalRegions

    • resetDimension

      void resetDimension(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
      Resets the DimensionalRegion as well as all LocalRegions of the corresponding level.
      Parameters:
      dim - the resource key of the level/dimension you want to reset its corresponding data for.