Fast Region Wrapper

Lightweight library for developers to switch and handle easily between different region spigot mc plugins.

Dependency Usage

Maven

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.r3back</groupId>
    <artifactId>fast-region-wrapper</artifactId>
    <version>LATEST</version>
</dependency>

Gradle

repositories {
    maven { 
        url 'https://jitpack.io' 
    }
}

dependencies {
    compileOnly 'com.github.r3back:fast-region-wrapper:LATEST'
}

API Usage

/**
 * Fast Region Plugin Wrapper Interface
 */
public interface FastWrapperAPI {
    /**
     *
     * @return {@link RegionAddon}
     */
    public RegionAddon getRegionAddon();
}

/**
 * Region Addon interface
 */
public interface RegionAddon extends DependencyPlugin {
    /**
     * Check if a location is inside any of given regions
     *
     * @param location {@link Location} location to check
     * @param regions  List of regions to check
     * @return true if location is in region
     */
    public default boolean isInAnyRegion(final Location location, final List<String> regions) {
        if (regions.isEmpty()) {
            return false;
        }

        return this.getRegions(location)
                .stream()
                .anyMatch(regions::contains);
    }

    /**
     * Checks if a location is inside a region
     * 
     * @param location {@link Location} location to check
     * @param region   Region to check
     * @return true if location is inside region
     */
    public default boolean isInRegion(final Location location, final String region) {
        if (region == null) {
            return false;
        }

        return this.getRegions(location)
                .stream()
                .anyMatch(region::equals);
    }

    /**
     * Retrieves a list of regions given a location
     * 
     * @param location {@link Location} location to check
     * @return List of regions in for a location
     */
    public Set<String> getRegions(final Location location);
}

License

This App is licensed under the permissive MIT license. Please see LICENSE.txt for more info.