Waypoints

public class WaypointManager

Waypoints are the location markers you can see on the map view showing you where contracts are targeted for. With this structure, you can obtain coordinate data for the locations of these waypoints. Obtained by calling getWaypointManager().

java.util.List<Waypoint> getWaypoints()

A list of all existing waypoints.

Game Scenes:All
Waypoint addWaypoint(double latitude, double longitude, CelestialBody body, String name)

Creates a waypoint at the given position at ground level, and returns a Waypoint object that can be used to modify it.

Parameters:
  • latitude (double) – Latitude of the waypoint.
  • longitude (double) – Longitude of the waypoint.
  • body (CelestialBody) – Celestial body the waypoint is attached to.
  • name (String) – Name of the waypoint.
Game Scenes:

All

Waypoint addWaypointAtAltitude(double latitude, double longitude, double altitude, CelestialBody body, String name)

Creates a waypoint at the given position and altitude, and returns a Waypoint object that can be used to modify it.

Parameters:
  • latitude (double) – Latitude of the waypoint.
  • longitude (double) – Longitude of the waypoint.
  • altitude (double) – Altitude (above sea level) of the waypoint.
  • body (CelestialBody) – Celestial body the waypoint is attached to.
  • name (String) – Name of the waypoint.
Game Scenes:

All

java.util.Map<String, Integer> getColors()

An example map of known color - seed pairs. Any other integers may be used as seed.

Game Scenes:All
java.util.List<String> getIcons()

Returns all available icons (from “GameData/Squad/Contracts/Icons/”).

Game Scenes:All
public class Waypoint

Represents a waypoint. Can be created using WaypointManager.addWaypoint(double, double, CelestialBody, String).

CelestialBody getBody()
void setBody(CelestialBody value)

The celestial body the waypoint is attached to.

Game Scenes:Flight
String getName()
void setName(String value)

The name of the waypoint as it appears on the map and the contract.

Game Scenes:Flight
int getColor()
void setColor(int value)

The seed of the icon color. See WaypointManager.getColors() for example colors.

Game Scenes:Flight
String getIcon()
void setIcon(String value)

The icon of the waypoint.

Game Scenes:Flight
double getLatitude()
void setLatitude(double value)

The latitude of the waypoint.

Game Scenes:Flight
double getLongitude()
void setLongitude(double value)

The longitude of the waypoint.

Game Scenes:Flight
double getMeanAltitude()
void setMeanAltitude(double value)

The altitude of the waypoint above sea level, in meters.

Game Scenes:Flight
double getSurfaceAltitude()
void setSurfaceAltitude(double value)

The altitude of the waypoint above the surface of the body or sea level, whichever is closer, in meters.

Game Scenes:Flight
double getBedrockAltitude()
void setBedrockAltitude(double value)

The altitude of the waypoint above the surface of the body, in meters. When over water, this is the altitude above the sea floor.

Game Scenes:Flight
boolean getNearSurface()

true if the waypoint is near to the surface of a body.

Game Scenes:Flight
boolean getGrounded()

true if the waypoint is attached to the ground.

Game Scenes:Flight
int getIndex()

The integer index of this waypoint within its cluster of sibling waypoints. In other words, when you have a cluster of waypoints called “Somewhere Alpha”, “Somewhere Beta” and “Somewhere Gamma”, the alpha site has index 0, the beta site has index 1 and the gamma site has index 2. When Waypoint.getClustered() is false, this is zero.

Game Scenes:Flight
boolean getClustered()

true if this waypoint is part of a set of clustered waypoints with greek letter names appended (Alpha, Beta, Gamma, etc). If true, there is a one-to-one correspondence with the greek letter name and the Waypoint.getIndex().

Game Scenes:Flight
boolean getHasContract()

Whether the waypoint belongs to a contract.

Game Scenes:Flight
Contract getContract()

The associated contract.

Game Scenes:Flight
void remove()

Removes the waypoint.

Game Scenes:Flight