Getting started with the ServerTours API

README.md

Useful links

• Javadocs

Adding the dependency

Gradle (Groovy DSL)

repositories {
    maven {
        name = "melluh-releases"
        url = "https://repo.melluh.com/releases"
    }
}

dependencies {
    compileOnly "com.melluh.servertours:servertours-api:2.0.1"
}

Gradle (Kotlin DSL)

repositories {
    maven {
        name = "melluh-releases"
        url = uri("https://repo.melluh.com/releases")
    }
}

dependencies {
    compileOnly("com.melluh.servertours:servertours-api:2.0.1")
}

Maven

<repositories>
    <repository>
        <id>melluh-releases</id>
        <url>https://repo.melluh.com/releases</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.melluh.servertours</groupId>
        <artifactId>servertours-api</artifactId>
        <version>2.0.1</version>
    </dependency>
</dependencies>

Basic Examples

Starting playback of a tour

Route route = ServerToursAPI.getRouteManager().getRoute(routeName);
ServerToursAPI.getPlaybackManager().showTour(player, route);

Kicking a player out of a tour

TouringPlayer touringPlayer = ServerToursAPI.getPlaybackManager().getTouringPlayer(player);
touringPlayer.exit();

Creating a tour route programatically

Route route = ServerToursAPI.getRouteManager().createRoute(routeName);
route.createPoint(firstLocation, RoutePointType.STATIONARY);
route.createPoint(secondLocation, RoutePointType.STATIONARY);
OrbitPoint orbitPoint = (OrbitPoint) route.createPoint(thirdLocation, RoutePointType.ORBIT);
orbitPoint.setDistance(10.0f);
route.saveToDisk(); // If this isn't called, the route won't be saved

Events

Name	Description	Cancellable?
RouteCreateEvent	Triggered when a route is created, either by a player or through the API.	No
RouteRemoveEvent	Triggered when a route is removed, either by a player or through the API.	No
RoutePlaybackBeginEvent	Triggered when a player starts watching a tour.	No
RotuePlaybackEndEvent	Triggered when a player stops watching a tour, for example by reaching the end. If cancelled, the tour will restart from the beginning.	Yes
RoutePlaybackPointEvent	Triggered when a player reaches a oint in a tour.	No