IParkour (HubParkour API v2.8.1)

```
public interface IParkour
```
Represents a parkour.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCheckpoint(Checkpoint point, int checkNo)` Adds a new checkpoint to the parkour.
`void`	`addHologram(ILeaderboardHologram hologram)` Add a hologram as a part of this parkour.
`void`	`deleteCheckpoint(Checkpoint point)` Deletes a checkpoint from the parkour.
`void`	`deleteExitPoint()` Removes the exit point.
`void`	`generateHolograms()` Generates all of the holograms for points.
`List<PressurePlate>`	`getAllPoints()` Get a list of all points for this parkour.
`List<BorderPoint>`	`getBorders()` Get a list of the border points setup for the map.
`Checkpoint`	`getCheckpoint(int checkpointNo)` Get a specific checkpoint for this parkour.
`List<Checkpoint>`	`getCheckpoints()` Get the list of checkpoints active in this parkour.
`int`	`getCustomModelData()` Retrieves the custom model data of the item associated with this parkour.
`List<String>`	`getEndCommands()` Get the list of commands to execute for the end of the parkour.
`EndPoint`	`getEndPoint()` Get the parkour end point pressure plate.
`ExitPoint`	`getExitPoint()` Get the exit point pressure plate.
`List<String>`	`getGlobalCheckpointCommands()` Returns a list commands to execute for every checkpoint the user gets to.
`int`	`getId()` Gets the ID of this parkour.
`short`	`getItemData()` Retrieves the data for the item associated with this parkour.
`org.bukkit.Material`	`getItemMaterial()` Retrieves the material of the item associated with this parkour.
`List<ILeaderboardHologram>`	`getLeaderboards()` Retrieves a list of leaderboard holograms attached to this parkour.
`String`	`getName()` Get the name of this parkour.
`int`	`getNoCheckpoints()` Gets the number of checkpoints this parkour has.
`List<IHubParkourPlayer>`	`getPlayers()` Gets the list of all players currently playing in the parkour.
`RestartPoint`	`getRestartPoint()` Gets the restart point of this parkour.
`int`	`getRewardCooldown()` Get the configured reward cooldown.
`UUID`	`getServer()` Get the UUID of the server this parkour is attached to.
`StartPoint`	`getStart()` Gets the start point of this parkour.
`void`	`playerEnd(IHubParkourPlayer p)` End the player on this parkour.
`void`	`playerStart(IHubParkourPlayer p)` Start a player on this parkour.
`void`	`removeHologram(ILeaderboardHologram hologram)` Remove a hologram that is a part of this parkour.
`void`	`removeHolograms()` Remove all of the holograms for points.
`void`	`setEndCommands(List<String> endCommands)` Set the end commands for the parkour.
`void`	`setEndPoint(EndPoint point)` Set the end point of the parkour.
`void`	`setExitPoint(ExitPoint exitPoint, boolean alreadyExists)` Set the exit point of the parkour.
`void`	`setGlobalCheckpointCommands(List<String> globalCheckpointCommands)` Sets the commands that will be executed globally for every checkpoint in this parkour.
`void`	`setItem(org.bukkit.Material material, short data, int customModelData)` Sets the item associated with this parkour.
`void`	`setName(String name)` Set the name of the parkour.
`void`	`setRestartPoint(RestartPoint point)` Set the restart point of the parkour.
`void`	`setStartPoint(StartPoint point)` Set the start point of the parkour.

- Method Detail
  - getNoCheckpoints
```
int getNoCheckpoints()
```
    Gets the number of checkpoints this parkour has.
    
    Returns:
    
    the number of checkpoints.
  - getId
```
int getId()
```
    Gets the ID of this parkour.
    
    Returns:
    
    the parkour's id.
  - getName
```
String getName()
```
    Get the name of this parkour. This includes colour codes.
    
    Returns:
    
    the parkour's name.
  - getEndPoint
```
EndPoint getEndPoint()
```
    Get the parkour end point pressure plate.
    
    Returns:
    
    the end plate.
  - getExitPoint
```
ExitPoint getExitPoint()
```
    Get the exit point pressure plate.
    
    Returns:
    
    the exit point.
  - getCheckpoints
```
List<Checkpoint> getCheckpoints()
```
    Get the list of checkpoints active in this parkour.
    
    Returns:
    
    list of all checkpoints.
  - getPlayers
```
List<IHubParkourPlayer> getPlayers()
```
    Gets the list of all players currently playing in the parkour.
    
    Returns:
    
    list of active players.
  - getRestartPoint
```
RestartPoint getRestartPoint()
```
    Gets the restart point of this parkour.
    
    Returns:
    
    the restart point of this parkour.
  - getStart
```
StartPoint getStart()
```
    Gets the start point of this parkour.
    
    Returns:
    
    the start point of this parkour.
  - getGlobalCheckpointCommands
```
List<String> getGlobalCheckpointCommands()
```
    Returns a list commands to execute for every checkpoint the user gets to.
    
    Returns:
    
    the commands.
  - getEndCommands
```
List<String> getEndCommands()
```
    Get the list of commands to execute for the end of the parkour.
    
    Returns:
    
    the commands.
  - getAllPoints
```
List<PressurePlate> getAllPoints()
```
    Get a list of all points for this parkour.
    
    Returns:
    
    list of all points.
  - generateHolograms
```
void generateHolograms()
```
    Generates all of the holograms for points. Requires holographic displays to be installed.
  - removeHolograms
```
void removeHolograms()
```
    Remove all of the holograms for points. Requires holographic displays to be installed.
  - playerStart
```
void playerStart(IHubParkourPlayer p)
```
    Start a player on this parkour.
    
    Parameters:
    
    p - the player to start.
  - playerEnd
```
void playerEnd(IHubParkourPlayer p)
```
    End the player on this parkour.
    
    Parameters:
    
    p - the player to end.
  - getCheckpoint
```
Checkpoint getCheckpoint(int checkpointNo)
```
    Get a specific checkpoint for this parkour.
    
    Parameters:
    
    checkpointNo - the checkpoint to get.
    
    Returns:
    
    the checkpoint.
  - addHologram
```
void addHologram(ILeaderboardHologram hologram)
```
    Add a hologram as a part of this parkour.
    
    Parameters:
    
    hologram - the hologram
  - removeHologram
```
void removeHologram(ILeaderboardHologram hologram)
```
    Remove a hologram that is a part of this parkour.
    
    Parameters:
    
    hologram - the hologram.
  - getLeaderboards
```
List<ILeaderboardHologram> getLeaderboards()
```
    Retrieves a list of leaderboard holograms attached to this parkour.
    
    Returns:
    
    a list of leaderboards attached to this parkour.
  - setName
```
void setName(String name)
```
    Set the name of the parkour.
    
    Parameters:
    
    name - The new name for the parkour.
  - setEndCommands
```
void setEndCommands(List<String> endCommands)
```
    Set the end commands for the parkour.
    
    Parameters:
    
    endCommands - The new end commands for the parkour.
  - setGlobalCheckpointCommands
```
void setGlobalCheckpointCommands(List<String> globalCheckpointCommands)
```
    Sets the commands that will be executed globally for every checkpoint in this parkour.
    
    Parameters:
    
    globalCheckpointCommands - The list of commands to be executed for global checkpoints.
  - setStartPoint
```
void setStartPoint(StartPoint point)
```
    Set the start point of the parkour.
    
    Parameters:
    
    point - The new start point for the parkour.
  - setEndPoint
```
void setEndPoint(EndPoint point)
```
    Set the end point of the parkour.
    
    Parameters:
    
    point - The new end point for the parkour.
  - setExitPoint
```
void setExitPoint(ExitPoint exitPoint,
                  boolean alreadyExists)
```
    Set the exit point of the parkour.
    
    Parameters:
    
    exitPoint - The new exit point for the parkour.
    
    alreadyExists - Whether the point already exists.
  - setRestartPoint
```
void setRestartPoint(RestartPoint point)
```
    Set the restart point of the parkour.
    
    Parameters:
    
    point - The new restart point for the parkour.
  - addCheckpoint
```
void addCheckpoint(Checkpoint point,
                   int checkNo)
```
    Adds a new checkpoint to the parkour.
    
    Parameters:
    
    point - The new start point for the parkour.
    
    checkNo - The checkpoint number this should become.
  - deleteCheckpoint
```
void deleteCheckpoint(Checkpoint point)
```
    Deletes a checkpoint from the parkour.
    
    Parameters:
    
    point - The checkpoint to remove.
  - deleteExitPoint
```
void deleteExitPoint()
```
    Removes the exit point.
  - getBorders
```
List<BorderPoint> getBorders()
```
    Get a list of the border points setup for the map. Should only ever have length of 2.
    
    Returns:
    
    the list of 2 border points.
  - getRewardCooldown
```
int getRewardCooldown()
```
    Get the configured reward cooldown.
    
    Returns:
    
    the current reward cooldown.
  - getServer
```
UUID getServer()
```
    Get the UUID of the server this parkour is attached to.
    
    Returns:
    
    the UUID of the server, or null if this parkour is global.
  - getItemMaterial
```
org.bukkit.Material getItemMaterial()
```
    Retrieves the material of the item associated with this parkour.
    
    Returns:
    
    the material of the associated item.
  - getItemData
```
short getItemData()
```
    Retrieves the data for the item associated with this parkour.
    
    Returns:
    
    the data of the associated item.
  - getCustomModelData
```
int getCustomModelData()
```
    Retrieves the custom model data of the item associated with this parkour.
    
    Returns:
    
    the custom model data of the associated item.
  - setItem
```
void setItem(org.bukkit.Material material,
             short data,
             int customModelData)
```
    Sets the item associated with this parkour.
    
    Parameters:
    
    material - The material of the item to set.
    
    data - The data value of the item to set.
    
    customModelData - the data of the custom model to apply to the item.

Interface IParkour

Method Summary

Method Detail

getNoCheckpoints

getId

getName

getEndPoint

getExitPoint

getCheckpoints

getPlayers

getRestartPoint

getStart

getGlobalCheckpointCommands

getEndCommands

getAllPoints

generateHolograms

removeHolograms

playerStart

playerEnd

getCheckpoint

addHologram

removeHologram

getLeaderboards

setName

setEndCommands

setGlobalCheckpointCommands

setStartPoint

setEndPoint

setExitPoint

setRestartPoint

addCheckpoint

deleteCheckpoint

deleteExitPoint

getBorders

getRewardCooldown

getServer

getItemMaterial

getItemData

getCustomModelData

setItem