Package com.melluh.servertours.api.object

Interface RoutePoint

All Known Subinterfaces:
InterpolatePoint, OrbitPoint, StationaryPoint
public interface RoutePoint

  • Method Details

    • move

      void move(org.bukkit.Location location)
      Moves this route point to a new location.
      Parameters:
      location - location to move to

    • getLocation

      org.bukkit.Location getLocation()
      Gets the location of this route point.
      Returns:
      the location

    • setTicksVisible

      void setTicksVisible(int ticksVisible)
      Changes the number of ticks this point is visible during playback. If a negative value is supplied, the visible time will be set to zero.
      Parameters:
      ticksVisible - number of ticks (20 = 1 second)

    • getTicksVisible

      int getTicksVisible()
      Gets the number of ticks this point is visible during playback.
      Returns:
      number of ticks (20 = 1 second)

    • getRoute

      Route getRoute()
      Gets the Route this point belongs to.
      Returns:
      the route

    • getType

      RoutePointType getType()
      Gets the type of this route point. The type cannot be modified after a route point is created.
      Returns:
      the type

    • setTitle

      void setTitle(String title)
      Changes this point's title. The title is shown to players when they reach this point during playback.
      Parameters:
      title - the title, or null to remove it
      See Also:

    • clearTitle

      void clearTitle()
      Removes this point's title. The title is shown to players when they reach this point during playback.

    • getTitle

      String getTitle()
      Gets this point's title. The title is shown to players when they reach this point during playback. If no title is set, this returns null.
      Returns:
      the title, or null

    • setTitleFadeInTime

      void setTitleFadeInTime(float fadeInTime)
      Changes the fade-in time for this point's title. The title is shown to players when they reach this point during playback.
      Parameters:
      fadeInTime - fade-in time in seconds

    • getTitleFadeInTime

      float getTitleFadeInTime()
      Gets the fade-in time for this point's title. The title is shown to players when they reach this point during playback.
      Returns:
      fade-in time in seconds

    • setTitleStayTime

      void setTitleStayTime(float stayTime)
      Changes the stay time for this point's title. The title is shown to players when they reach this point during playback.
      Parameters:
      stayTime - stay time in seconds

    • getTitleStayTime

      float getTitleStayTime()
      Gets the stay time for this point's title. The title is shown to players when they reach this point during playback.
      Returns:
      stay time in seconds

    • setTitleFadeOutTime

      void setTitleFadeOutTime(float fadeOutTime)
      Changes the fade-out time for this point's title. The title is shown to players when they reach this point during playback.
      Parameters:
      fadeOutTime - fade-out time in seconds

    • getTitleFadeOutTime

      float getTitleFadeOutTime()
      Gets the fade-out time for this point's title. The title is shown to players when they reach this point during playback.
      Returns:
      fade-out time in seconds

    • setDescription

      void setDescription(String description)
      Changes this point's description. The description is shown to players as a chat message when they reach this point during playback.
      Parameters:
      description - the description, or null to remove it
      See Also:

    • clearDescription

      void clearDescription()
      Removes this point's description. The description is shown to players as a chat message when they reach this point during playback.

    • getDescription

      String getDescription()
      Gets this point's description. The description is shown to players as a chat message when they reach this point during playback. If no description is set, this returns null.
      Returns:
      the description, or null

    • setLabel

      void setLabel(String label)
      Changes this point's label. The label isn't shown during playback, but exists mainly as a utility function for editing players to easily identify different route points.
      Parameters:
      label - the label, or null to remove it
      See Also:

    • clearLabel

      void clearLabel()
      Removes this point's label. The label isn't shown during playback, but exists mainly as a utility function for editing players to easily identify different route points.

    • getLabel

      String getLabel()
      Gets this point's label. The label isn't shown during playback, but exists mainly as a utility function for editing players to easily identify different route points. If no label is set, this returns null.
      Returns:
      the label, or null

    • getIndex

      default int getIndex()
      Gets this point's index in the route.
      Returns:
      the index, starting from zero