############################################################
# +------------------------------------------------------+ #
# |                  ____  ____   ____                   | #
# |                 / ___||  _ \ / ___|                  | #
# |                | |  _ | |_) |\___ \                  | #
# |                | |_| ||  __/  ___) |                 | #
# |                 \____||_|    |____/                  | #
# |                                                      | #
# | By: Benz56                                           | #
# +------------------------------------------------------+ #
############################################################


############################################################
# +------------------------------------------------------+ #
# |              Arrow appearance settings               | #
# +------------------------------------------------------+ #
############################################################

# The block the arrow is made out of. Data values are supported.
# Implementation: Block or 'Block:Data'.
block : Quartz_Block

# The Block density / the spacing between each block in the arrow.
arrowDensity : 0.3

# Set the length of the arrow shaft.
arrowLength : 2.1

# Set the length of the arrow head parts.
headLength : 0.9

# Set the offset of the arrow head parts.
# Used for fine tuning the look of the arrow head at different sizes if necessary.
headOffset : 0.3

# Name of the arrow.
# Use %distance% as a placeholder for the remaining distance to the target.
# Use %distanceRounded% as a placeholder for the remaining rounded distance to the target.
arrowName : '&a %distance% blocks to destination'

# Display the arrows name on the action bar instead of above the arrow.
useActionbar : false


############################################################
# +------------------------------------------------------+ #
# |               Arrow position settings                | #
# +------------------------------------------------------+ #
############################################################

# Set the default horizontal and vertical offset distance from the player.
defaultHorizontalOffset : 6.0
defaultVerticalOffset : 2.5

# Set the min and max offset values for the horizontal and vertical offsets.
# These values are the min/max values for the /gps move command.
minHorizontalOffset : 3.0
maxHorizontalOffset : 10.0
minVerticalOffset : -2.0
maxVerticalOffset : 6.0



############################################################
# +------------------------------------------------------+ #
# |             Particle appearance settings             | #
# +------------------------------------------------------+ #
############################################################

# Set the density of the particles / the spacing between each particle in the line.
particleDensity : 1.0

# Set the render distance of the particles.
particleRenderDistance : 40.0

# Set the particle update rate. (update every x ticks)
particleUpdateRate : 5


# Set different colors for particles below.
# The particles use RGB color values. Use the link below:
# - https://www.w3schools.com/colors/colors_rgb.asp

# The base line color.
lineColor : 1, 1, 255

# The connected line color. If A is connected to B
# the two last particles at point B will be in the color below.
connectedColor : 1, 255, 255

# Default point highlight color. If the location is not
# the selected nor the closest this color is used.
defaultPointColor : 255, 1, 1

# Selected point highlight color. If the location is
# the selected point this color is used.
selectedPointColor : 1, 255, 1

# Closest point highlight color. If the location is
# the closest point this color is used.
closestPointColor : 255, 255, 1



############################################################
# +------------------------------------------------------+ #
# |                     GPS settings                     | #
# +------------------------------------------------------+ #
############################################################

# Max distance to entry point if a start/from parameter has not been specified.
# If the distance is greater than the value below the GPS won't start.
maxDistanceToEntry : 50.0

# Point update distance. The distance is the radius of a spherical check around
# the point, meaning it does not matter which direction the player is coming from.
pointUpdateDistance : 5.0

# GPS update interval. The interval in which the GPS updates to check if the player
# reached a new point. Setting this to 1 allows the GPS to be very responsive but
# takes up more system resources. Setting it too high will make the GPS unresponsive
# and possibly miss new points if the player is moving fast e.g. on a horse or flying.
# The sweetspot is between 2 and 5.
gpsUpdateInterval : 3



############################################################
# +------------------------------------------------------+ #
# |                    Other Settings                    | #
# +------------------------------------------------------+ #
############################################################

# Set the max distance for point selection and closest point update.
selectionDistance : 10.0

# Only show the GPS arrow for the owner.
# This setting requires you to have ProtocolLib installed on your server!
# If set to true and ProtocolLib is not installed it will fail silently and show for all.
showForOwnerOnly : true

# Particle path mode.
# This mode disables the arrow completely and instead activates the
# particle path whenever the GPS start method is called. The /gps show
# command will behave as the /gps stop command as well. Furthermore,
# it will enable Actionbar mode regardless of the setting chosen earlier.
# If you do not wish to show an Actionbar message set the arrowName to ''.
disableArrow : false

#######################################################################################
# +---------------------------------------------------------------------------------+ #
# |    ____                                            _   _                _       | #
# |   |  _ \  _   _  _ __   _ __ ___    __ _  _ __    | | | |  ___    ___  | | __   | #
# |   | | | || | | || '_ \ | '_ ` _ \  / _` || '_ \   | |_| | / _ \  / _ \ | |/ /   | #
# |   | |_| || |_| || | | || | | | | || (_| || |_) |  |  _  || (_) || (_) ||   <    | #
# |   |____/  \__, ||_| |_||_| |_| |_| \__,_|| .__/   |_| |_| \___/  \___/ |_|\_\   | #
# |           |___/                          |_|                                    | #
# |                                                                                 | #
# +---------------------------------------------------------------------------------+ #
#######################################################################################

# Enable or Disable the Dynmap GPS.
enabled : false

# Name of Marker Set.
name : 'GPS'


############################################################
# +------------------------------------------------------+ #
# |                    Point settings                    | #
# +------------------------------------------------------+ #
############################################################

# Enable disable the circular point markers.
pointMarkersEnabled : true

# Radius. Set the radius to 0 to use the update distance as the radius.
pointRadius : 0

# Set the fill style. Color is in RGB.
pointFillOpacity : 0.2
pointFillColor : 85, 85, 255

# Set the border style. Color is in RGB.
pointBorderWeight : 2
pointBorderOpacity : 0.7
pointBorderColor : 255, 0, 0

# Set the clickable popup description on each point.
# The description is written in HTML Markup.
pointDescription:
 - '<h2>Point : %point%</h2>'
 - '<b>Location:</b> %location%<hr>'
 - '<b>Connections:</b>'
 - ' %connectionList%'

# Set how lines in the connection list appears.
connectionListLine : '<i> %connection%</i>'


############################################################
# +------------------------------------------------------+ #
# |                 Connection settings                  | #
# +------------------------------------------------------+ #
############################################################

# Enable disable the connection line markers between the point markers.
connectionMarkersEnabled : true

# Set the connection line style. Color is in RGB.
connectionLineWeight : 4
connectionLineOpacity : 0.4
connectionLineColor : 85, 255, 255

# This is the Message file for all GPS messages.
#
# All messages are fully customizable and support color codes, formatting and ASCII symbols.
# Set the Prefix/ConfPrefix and use %prefix%/%confPrefix% to add the corresponding prefix to a message.
# Leave a message blank ('') to disable it.


Prefix : '&7 [&eGPS&7 ]'
ConfPrefix : '&7 [&eGPS Configurator&7 ]'
Messages:
  General:
    invalidPermission : ' %prefix% &cYou do not have permission to do this!'
    noCommands : Unknown command. Type "/help" for help.
    unknownCommand : ' %prefix% &cUnknown command!'
    unknownPlayer : ' %prefix% &cUnknown Player!'
    configurationsReloaded : ' %prefix% &aConfiguration files successfully reloaded!'
    playerOnly : ' %prefix% &cCommand can only be used as a Player!'
  GPS:
    invalidArgs : ' %prefix% &cInvalid arguments!'
    unknownPoint : ' %prefix% &cUnknown Point!'
    started : ' %prefix% &aGPS started!'
    startedPlayer : ' %prefix% &aGPS started for %player%!'
    stopped : ' %prefix% &aGPS stopped!'
    stoppedPlayer : ' %prefix% &aGPS stopped for %player%!'
    notStarted : ' %prefix% &cGPS is not active!'
    moveModeEnabled : ' %prefix% &aEnabled move mode. Use again to disable.'
    moveModeDisabled : ' %prefix% &aDisabled move mode.'
    noPath : ' %prefix% &cNo valid path.'
    noEntry : ' %prefix% &cNo entry point nearby!'
    destinationReached : ' %prefix% &aDestination reached!'
    cantReachDestination : ' %prefix% &cCannot reach destination from here!'
    pluginReload : ' %prefix% &cThe GPS has been reloaded! Exiting navigation.'
    arrowDisabled : ' %prefix% &cThe GPS arrow is disabled. Move mode unavailable.'
  Configurator:
    playerOnlyConf : ' %confPrefix% &cGPS Configurator commands are for in-game configuration only!'
    toggleEditor : ' %confPrefix% &aEditor %state%'
    editorInactive : ' %confPrefix% &cEditor not active!'
    invalidArgsConf : ' %confPrefix% &cInvalid arguments!'
    pointExists : ' %confPrefix% &cPoint already exists!'
    nonexistentPoint : ' %confPrefix% &cPoint does not exist!'
    pointCreated : ' %confPrefix% &aPoint successfully created!'
    pointDeleted : ' %confPrefix% &aPoint successfully deleted!'
    noPointsNearby : ' %confPrefix% &cNo points nearby!'
    noPointSelected : ' %confPrefix% &cNo point selected!'
    selectedPoint : ' %confPrefix% &aSelected point: &e%selected%'
    cantConnectSame : ' %confPrefix% &cCan''t connect the same point!'
    cantConnectDimension : ' %confPrefix% &cCan''t connect points between dimensions!'
    connectedPoint : ' %confPrefix% &aSuccessfully connected &e%selected% &ato &e%closest%!'
    alreadyConnected : ' %confPrefix% &cPoints are already connected!'
    cantDisconnectSame : ' %confPrefix% &cCan''t disconnect the same point!'
    disconnectedPoint : ' %confPrefix% &aSuccessfully disconnected &e%selected% &afrom &e%closest%'
    notConnected : ' %confPrefix% &cPoints are not connected!'
    otherWorld : ' %confPrefix% &cCan''t move point to another world!'
    movedPoint : ' %confPrefix% &aSuccessfully moved point!'
    locationsHasPoint : ' %confPrefix% &cThis location already contains a point!'
    invalidPoint : ' %confPrefix% &cInvalid Point: %point%!'
    teleportedToPoint : ' %confPrefix% &aSuccessfully teleported.'
    noPointInEyeSight : ' %confPrefix% &cNo point in eyesight.'
    addedStick : ' %confPrefix% &aA Configurator Stick has been added to your inventory.'

# This file stores all the GPS Points/Locations.
#
# It is advised that you use the in-game configurator when editing your setup.
# The in-game configurator lets you visually see what you are changing and avoids typing/input errors.


Points:
  world, 0, 60, 0:
    name : Test
    connections :
    - world, 10, 65, 10
  world, 10, 65, 10:
    name : Test2
    connections :
    - world, 0, 60, 0

//Start the GPS for a player with a set destination and the closest point as the starting point.
void startGPS (Player player, String destination ) ;

//Start the GPS for a player with a starting and destination point. (The starting point will change if another point is closer)
void startGPS (Player player, String start, String destination ) ;

//Previous two but with a custom start message.
void startGPS ( String customStartMessage, Player player, String destination ) ;
void startGPS ( String customStartMessage, Player player, String start, String destination ) ;

//Start the Compass for a player with a set destination.
void startCompass (Player player, String destination ) ;

//Start the Compass for a player with a set location as the destination.
void startCompass (Player player, Location location ) ;

//Previous two but with a custom start message.
void startCompass ( String customStartMessage, Player player, String destination ) ;
void startCompass ( String customStartMessage, Player player, Location location ) ;

//Stop the GPS for a player.
void stopGPS (Player player ) ;

//Check whether or not the GPS is active for a specific player.
boolean gpsIsActive (Player player ) ;

//Add a custom point. Make sure the name is unique. E.g. add your plugin name as the first part of the name.
void addPoint ( String name, Location location ) ;

//Remove a point you personally added.
void removePoint ( String name ) ;

//Remove all points you added.
void removeAllPoints ( ) ;

//Connect point1 to point2. If the 'both[I]'[/I] parameter is true; point2 is also connected to point1.
void connect ( String point1, String point2, boolean both ) ;

//See connect.
void disconnect ( String point1, String point2, boolean both ) ;

//Return the remaining GPS distance. E.g: 145,32 or 1.593,23.
String getDistanceToTarget (Player player ) ;

//Return the remaining GPS distance rounded. E.g: 145 or 1.593.
String getDistanceToTargetRounded (Player player ) ;

//Return the cardinal direction a player has to go. (N, NE, E, SE, S, SW, W, NW)
String getCardinalDirection (Player player ) ;

//Get all of the locally configured points from the points.yml file.
List <Point > getConfigurationPoints ( ) ;

//Get all local points including externally added points from plugins using the API on the server.
List <Point > getAllPoints ( ) ;

//Get all points added by the plugin with the given name.
List <Point > getPluginPoints ( String pluginName ) ;

//Get the closest point to a given location selected from the list of locally configured points.
void getClosestConfigurationPoint (Location location, Consumer <Point > consumer ) ;

//Get the closest point to a given players location selected from the list of locally configured points.
void getClosestConfigurationPoint (Player player, Consumer <Point > consumer ) ;

//Get the closest point to a given location selected from the list of locally and externally configured points.
void getClosestGlobalPoint (Location location, Consumer <Point > consumer ) ;

//Get the closest point to a given players location selected from the list of locally and externally configured points.
void getClosestGlobalPoint (Player player, Consumer <Point > consumer ) ;

@EventHandler
public void onGPSStart (GPSStartEvent e ) {
    //Get the player the GPS is being started for.
    e. getPlayer ( ) ;

    //Get the destination point. This Object contains the Location as well.
    e. getDestinationPoint ( ) ;

    //Get the StartSource / what started the GPS.
    //Enums: PLAYER_SELF, PLAYER_OTHER, CONSOLE, OTHER_PLUGIN
    e. getStartSource ( ) ;

    //The navigation type is of type compass (true) or GPS (false)
    e. isCompass ( ) ;

    //Check if the event is cancelled.
    e. isCancelled ( ) ;

    //Cancel the event based on your checks.
    e. setCancelled ( boolean cancel ) ;
}

@EventHandler
public void onGPSStop (GPSStopEvent e ) {
    //Get the player the GPS is being started for.
    e. getPlayer ( ) ;
 
    //Get the StopSource / what caused the GPS to stop.
    //Enums: PLAYER_SELF, PLAYER_OTHER, CONSOLE, PLUGIN, OTHER_PLUGIN, DESTINATION_REACHED
    e. getStopSource ( ) ;

    //The navigation type is of type compass (true) or GPS (false)
    e. isCompass ( ) ;

    //Send a custom stop message when the GPS/compass is stopped.
    e. setCustomStopMessage ( String customStopMessage ) ;

    //Check if the event is cancelled.
    e. isCancelled ( ) ;

    //Cancel the event based on your checks. StopSource DESTINATION_REACHED and PLUGIN is not cancellable.
    e. setCancelled ( boolean cancel ) ;
}