Interface IPath<Waypoint extends IPathWaypoint>

All Known Subinterfaces:
IPrefabPath
All Known Implementing Classes:
PatrolPath, TransientPath, WorldPath
public interface IPath<Waypoint extends IPathWaypoint>
Created on 17/08/2018

  • Method Summary

    Modifier and Type
    Method
    Description
    Waypoint
    get(int index)
    Returns the waypoint at the specified index
    UUID
    getId()
     
    String
    getName()
    Returns a (non-unique) friendly name that can be used to filter the path
    List<Waypoint>
    getPathWaypoints()
    Returns an immutable copy of the path waypoint list
    int
    length()
     

  • Method Details

    • getId

      @Nullable UUID getId()

    • getName

      @Nullable String getName()
      Returns a (non-unique) friendly name that can be used to filter the path
      Returns:
      the friendly name of the path

    • getPathWaypoints

      List<Waypoint> getPathWaypoints()
      Returns an immutable copy of the path waypoint list
      Returns:
      the list of waypoints

    • length

      int length()

    • get

      Waypoint get(int index)
      Returns the waypoint at the specified index
      Parameters:
      index - the index to fetch
      Returns:
      the waypoint at said index