Index
All Classes and Interfaces|All Packages
A
- API - Enum constant in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
The tour was stopped prematurely via the API
C
- canExit() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Checks whether the player is currently allowed to exit.
- capitalize(String) - Static method in class com.melluh.servertours.api.util.FormattingUtils
- clearDescription() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Removes this point's description.
- clearLabel() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Removes this point's label.
- clearTitle() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Removes this point's title.
- com.melluh.servertours.api - package com.melluh.servertours.api
- com.melluh.servertours.api.event - package com.melluh.servertours.api.event
- com.melluh.servertours.api.object - package com.melluh.servertours.api.object
- com.melluh.servertours.api.util - package com.melluh.servertours.api.util
- COMMAND - Enum constant in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
The tour was stopped prematurely by (another) player running
/tour stop <player/all>
- createPoint(Location, RoutePointType) - Method in interface com.melluh.servertours.api.object.Route
-
Creates a new point at the specified location, and of the specified type.
- createRoute(String) - Method in interface com.melluh.servertours.api.RouteManager
-
Creates a new route with the specified name.
D
- DIFFERENT_WORLD - Enum constant in enum class com.melluh.servertours.api.object.InterpolatePoint.Validity
-
The point is invalid because the next route point is in a different world, and thus cannot be interpolated to.
E
- exit() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Stops playback of the tour for the player.
- EXITED - Enum constant in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
The player exited the tour prematurely by pressing the sneak key
F
- FINISHED - Enum constant in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
The tour was ended because the end was reached
- formatEnumName(String) - Static method in class com.melluh.servertours.api.util.FormattingUtils
- FormattingUtils - Class in com.melluh.servertours.api.util
G
- getBukkitPlayer() - Method in class com.melluh.servertours.api.event.RoutePlayerEvent
- getCurrentPoint() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Gets the route point the player is currently viewing.
- getDescription() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets this point's description.
- getDescription() - Method in enum class com.melluh.servertours.api.object.RoutePointType
- getDescription() - Method in interface com.melluh.servertours.api.util.LocalizableEnum
- getDistance() - Method in interface com.melluh.servertours.api.object.OrbitPoint
- getExitLocation() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Gets where the player will be teleported to when they finish the tour.
- getHandlerList() - Static method in class com.melluh.servertours.api.event.RouteCreateEvent
- getHandlerList() - Static method in class com.melluh.servertours.api.event.RoutePlaybackBeginEvent
- getHandlerList() - Static method in class com.melluh.servertours.api.event.RoutePlaybackEndEvent
- getHandlerList() - Static method in class com.melluh.servertours.api.event.RoutePlaybackPointEvent
- getHandlerList() - Static method in class com.melluh.servertours.api.event.RouteRemoveEvent
- getHandlerList() - Static method in class com.melluh.servertours.api.event.RoutesLoadEvent
- getHandlers() - Method in class com.melluh.servertours.api.event.RouteCreateEvent
- getHandlers() - Method in class com.melluh.servertours.api.event.RoutePlaybackBeginEvent
- getHandlers() - Method in class com.melluh.servertours.api.event.RoutePlaybackEndEvent
- getHandlers() - Method in class com.melluh.servertours.api.event.RoutePlaybackPointEvent
- getHandlers() - Method in class com.melluh.servertours.api.event.RouteRemoveEvent
- getHandlers() - Method in class com.melluh.servertours.api.event.RoutesLoadEvent
- getHeight() - Method in interface com.melluh.servertours.api.object.OrbitPoint
- getImplementation() - Static method in class com.melluh.servertours.api.ServerToursAPI
- getIndex() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets this point's index in the route.
- getLabel() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets this point's label.
- getLocation() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets the location of this route point.
- getName() - Method in interface com.melluh.servertours.api.object.Route
-
Gets the name of the route.
- getName() - Method in enum class com.melluh.servertours.api.object.RoutePointType
- getName() - Method in interface com.melluh.servertours.api.util.LocalizableEnum
- getNumPoints() - Method in interface com.melluh.servertours.api.object.Route
-
Gets the number of points this route contains.
- getPlaybackManager() - Static method in class com.melluh.servertours.api.ServerToursAPI
- getPlaybackManager() - Method in interface com.melluh.servertours.api.ServerToursAPI.ServerToursPlugin
- getPlayer() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Gets the Bukkit player instance.
- getPoint() - Method in class com.melluh.servertours.api.event.RoutePlaybackPointEvent
- getPoint(int) - Method in interface com.melluh.servertours.api.object.Route
-
Gets the point at the specified index in this route.
- getPointProgress() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Gets the progress this player has made over the current point.
- getPoints() - Method in interface com.melluh.servertours.api.object.Route
-
Gets the points this route contains as an immutable list.
- getReason() - Method in class com.melluh.servertours.api.event.RoutePlaybackEndEvent
- getRoute() - Method in class com.melluh.servertours.api.event.RouteEvent
- getRoute() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets the
Route
this point belongs to. - getRoute() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Gets the route this player is viewing.
- getRoute(String) - Method in interface com.melluh.servertours.api.RouteManager
- getRouteManager() - Static method in class com.melluh.servertours.api.ServerToursAPI
- getRouteManager() - Method in interface com.melluh.servertours.api.ServerToursAPI.ServerToursPlugin
- getRouteName() - Method in class com.melluh.servertours.api.event.RouteEvent
- getRouteNames() - Method in interface com.melluh.servertours.api.RouteManager
- getRouteProgress() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Gets the progress this player has made over the whole tour.
- getRoutes() - Method in interface com.melluh.servertours.api.RouteManager
- getSpeed() - Method in interface com.melluh.servertours.api.object.OrbitPoint
- getStartingPoint() - Method in interface com.melluh.servertours.api.object.OrbitPoint
- getTicksVisible() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets the number of ticks this point is visible during playback.
- getTitle() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets this point's title.
- getTitleFadeInTime() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets the fade-in time for this point's title.
- getTitleFadeOutTime() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets the fade-out time for this point's title.
- getTitleStayTime() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets the stay time for this point's title.
- getTouringPlayer() - Method in class com.melluh.servertours.api.event.RoutePlayerEvent
- getTouringPlayer(Player) - Method in interface com.melluh.servertours.api.PlaybackManager
-
Gets the
TouringPlayer
object for the specified player. - getTouringPlayers() - Method in interface com.melluh.servertours.api.PlaybackManager
-
Gets all the
TouringPlayer
that are currently watching a tour route. - getTouringPlayers(Route) - Method in interface com.melluh.servertours.api.PlaybackManager
-
Gets all the
TouringPlayer
that are currently watching the specified tour route. - getTranslation(String) - Method in interface com.melluh.servertours.api.ServerToursAPI.ServerToursPlugin
- getType() - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Gets the type of this route point.
- getValidity() - Method in interface com.melluh.servertours.api.object.InterpolatePoint
-
Returns the current
InterpolatePoint.Validity
of this interpolate point.
I
- indexOf(RoutePoint) - Method in interface com.melluh.servertours.api.object.Route
-
Returns the index of the specified point in the route.
- insertPoint(int, Location, RoutePointType) - Method in interface com.melluh.servertours.api.object.Route
-
Creates a new point at the specified location, and of the specified type.
- INTERPOLATE - Enum constant in enum class com.melluh.servertours.api.object.RoutePointType
- InterpolatePoint - Interface in com.melluh.servertours.api.object
- InterpolatePoint.Validity - Enum Class in com.melluh.servertours.api.object
- isActionBarEnabled() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Checks whether the action bar message is enabled.
- isBedrockPlayer(Player) - Method in interface com.melluh.servertours.api.ServerToursAPI.ServerToursPlugin
- isCancelled() - Method in class com.melluh.servertours.api.event.RoutePlaybackEndEvent
- isConfirmUponEnter() - Method in enum class com.melluh.servertours.api.object.RoutePointType
-
Whether the touring player should be asked for confirmation to continue upon entering the route point, or upon leaving the route point.
- isExitByMoving() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Checks whether the player can exit by moving.
- isProgressBarEnabled() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Checks whether the progress bar is enabled.
- isValid() - Method in interface com.melluh.servertours.api.object.InterpolatePoint
-
Checks if the interpolate point is valid in its current form.
- isWaitingForConfirmation() - Method in interface com.melluh.servertours.api.TouringPlayer
-
Checks whether this player is waiting for confirmation to continue.
L
- LocalizableEnum - Interface in com.melluh.servertours.api.util
M
- move(Location) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Moves this route point to a new location.
N
- NO_NEXT_POINT - Enum constant in enum class com.melluh.servertours.api.object.InterpolatePoint.Validity
-
The point is invalid because it has no next route point to interpolate towards.
O
- ORBIT - Enum constant in enum class com.melluh.servertours.api.object.RoutePointType
- OrbitPoint - Interface in com.melluh.servertours.api.object
P
- PlaybackManager - Interface in com.melluh.servertours.api
- PLUGIN_DISABLED - Enum constant in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
The tour was stopped prematurely because ServerTours was disabled
Q
- QUIT - Enum constant in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
The player exited the tour prematurely by leaving the server
R
- removePoint(int) - Method in interface com.melluh.servertours.api.object.Route
-
Removes the point at the specified index.
- removePoint(RoutePoint) - Method in interface com.melluh.servertours.api.object.Route
-
Removes the specified point from the route.
- removeRoute(Route) - Method in interface com.melluh.servertours.api.RouteManager
-
Removes the specified route.
- removeRoute(String) - Method in interface com.melluh.servertours.api.RouteManager
-
Attempts to remove the route with the specified name.
- Route - Interface in com.melluh.servertours.api.object
- RouteCreateEvent - Class in com.melluh.servertours.api.event
-
Triggered when a new tour route is created.
- RouteCreateEvent(Route) - Constructor for class com.melluh.servertours.api.event.RouteCreateEvent
- RouteEvent - Class in com.melluh.servertours.api.event
- RouteEvent(Route) - Constructor for class com.melluh.servertours.api.event.RouteEvent
- RouteManager - Interface in com.melluh.servertours.api
- RoutePlaybackBeginEvent - Class in com.melluh.servertours.api.event
-
Triggered when a tour starts.
- RoutePlaybackBeginEvent(TouringPlayer) - Constructor for class com.melluh.servertours.api.event.RoutePlaybackBeginEvent
- RoutePlaybackEndEvent - Class in com.melluh.servertours.api.event
-
Triggered when a tour ends, whether it was finished completely or exited prematurely.
- RoutePlaybackEndEvent(TouringPlayer, RoutePlaybackEndEvent.EndReason) - Constructor for class com.melluh.servertours.api.event.RoutePlaybackEndEvent
- RoutePlaybackEndEvent.EndReason - Enum Class in com.melluh.servertours.api.event
- RoutePlaybackPointEvent - Class in com.melluh.servertours.api.event
-
Triggered whenever a player reaches the next point in the tour they're viewing.
- RoutePlaybackPointEvent(TouringPlayer, RoutePoint) - Constructor for class com.melluh.servertours.api.event.RoutePlaybackPointEvent
- RoutePlayerEvent - Class in com.melluh.servertours.api.event
- RoutePlayerEvent(TouringPlayer) - Constructor for class com.melluh.servertours.api.event.RoutePlayerEvent
- RoutePoint - Interface in com.melluh.servertours.api.object
- RoutePointType - Enum Class in com.melluh.servertours.api.object
- RouteRemoveEvent - Class in com.melluh.servertours.api.event
-
Called when a tour route is removed.
- RouteRemoveEvent(Route) - Constructor for class com.melluh.servertours.api.event.RouteRemoveEvent
- RoutesLoadEvent - Class in com.melluh.servertours.api.event
-
Triggered after the plugin has finished loading tour routes on startup.
- RoutesLoadEvent() - Constructor for class com.melluh.servertours.api.event.RoutesLoadEvent
S
- saveToDisk() - Method in interface com.melluh.servertours.api.object.Route
-
Saves the route to disk in its current state.
- ServerToursAPI - Class in com.melluh.servertours.api
- ServerToursAPI.ServerToursPlugin - Interface in com.melluh.servertours.api
- setActionBarEnabled(boolean) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Sets whether the action bar is enabled.
- setCancelled(boolean) - Method in class com.melluh.servertours.api.event.RoutePlaybackEndEvent
- setCanExit(boolean) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Sets whether the player should be allowed to exit.
- setCurrentPoint(int) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Changes the point the player is currently viewing.
- setCurrentPoint(RoutePoint) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Changes the point the player is currently viewing.
- setDescription(String) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Changes this point's description.
- setDistance(float) - Method in interface com.melluh.servertours.api.object.OrbitPoint
- setExitByMoving(boolean) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Sets whether the player is able to exit by moving.
- setExitLocation(Location) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Sets wherer the player will be teleported when they finish the tour.
- setHeight(float) - Method in interface com.melluh.servertours.api.object.OrbitPoint
- setImplementation(ServerToursAPI.ServerToursPlugin) - Static method in class com.melluh.servertours.api.ServerToursAPI
- setLabel(String) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Changes this point's label.
- setProgressBarEnabled(boolean) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Sets whether the progress bar is enabled.
- setSpeed(float) - Method in interface com.melluh.servertours.api.object.OrbitPoint
- setStartingPoint(float) - Method in interface com.melluh.servertours.api.object.OrbitPoint
- setTicksVisible(int) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Changes the number of ticks this point is visible during playback.
- setTitle(String) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Changes this point's title.
- setTitleFadeInTime(float) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Changes the fade-in time for this point's title.
- setTitleFadeOutTime(float) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Changes the fade-out time for this point's title.
- setTitleStayTime(float) - Method in interface com.melluh.servertours.api.object.RoutePoint
-
Changes the stay time for this point's title.
- setWaitingForConfirmation(boolean) - Method in interface com.melluh.servertours.api.TouringPlayer
-
Sets whether this player is waiting for confirmation to continue.
- showTour(Player, Route) - Method in interface com.melluh.servertours.api.PlaybackManager
-
Starts playing the specified tour route for a player.
- STATIONARY - Enum constant in enum class com.melluh.servertours.api.object.RoutePointType
- StationaryPoint - Interface in com.melluh.servertours.api.object
T
- TouringPlayer - Interface in com.melluh.servertours.api
V
- VALID - Enum constant in enum class com.melluh.servertours.api.object.InterpolatePoint.Validity
-
The point is valid in its current form, and will function correctly.
- valueOf(String) - Static method in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.melluh.servertours.api.object.InterpolatePoint.Validity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.melluh.servertours.api.object.RoutePointType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.melluh.servertours.api.event.RoutePlaybackEndEvent.EndReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.melluh.servertours.api.object.InterpolatePoint.Validity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.melluh.servertours.api.object.RoutePointType
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages