space_ex v0.8.0 SpaceEx.SpaceCenter.Waypoint
Represents a waypoint.
Can be created using SpaceEx.SpaceCenter.WaypointManager.add_waypoint/5.
Link to this section Summary
Functions
The altitude of the waypoint above the surface of the body, in meters
The celestial body the waypoint is attached to
true if this waypoint is part of a set of clustered waypoints with greek letter
names appended (Alpha, Beta, Gamma, etc)
The seed of the icon color
The associated contract
true if the waypoint is attached to the ground
Whether the waypoint belongs to a contract
The icon of the waypoint
The integer index of this waypoint within its cluster of sibling waypoints
The latitude of the waypoint
The longitude of the waypoint
The altitude of the waypoint above sea level, in meters
The name of the waypoint as it appears on the map and the contract
true if the waypoint is near to the surface of a body
Removes the waypoint
The altitude of the waypoint above the surface of the body, in meters
The celestial body the waypoint is attached to
The seed of the icon color
The icon of the waypoint
The latitude of the waypoint
The longitude of the waypoint
The altitude of the waypoint above sea level, in meters
The name of the waypoint as it appears on the map and the contract
The altitude of the waypoint above the surface of the body or sea level, whichever is closer, in meters
The altitude of the waypoint above the surface of the body or sea level, whichever is closer, in meters
Link to this section Functions
The altitude of the waypoint above the surface of the body, in meters.
When over water, this is the altitude above the sea floor.
Returns: a high precision decimal
The celestial body the waypoint is attached to.
Returns: a reference to a SpaceEx.SpaceCenter.CelestialBody object
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 SpaceEx.SpaceCenter.Waypoint.index/1.
Returns: true or false
The seed of the icon color.
See SpaceEx.SpaceCenter.WaypointManager.colors/1 for example colors.
Returns: an integer
The associated contract.
Returns: a reference to a SpaceEx.SpaceCenter.Contract object
true if the waypoint is attached to the ground.
Returns: true or false
Whether the waypoint belongs to a contract.
Returns: true or false
The icon of the waypoint.
Returns: a string
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 SpaceEx.SpaceCenter.Waypoint.clustered/1 is false, this is zero.
Returns: an integer
The latitude of the waypoint.
Returns: a high precision decimal
The longitude of the waypoint.
Returns: a high precision decimal
The altitude of the waypoint above sea level, in meters.
Returns: a high precision decimal
The name of the waypoint as it appears on the map and the contract.
Returns: a string
true if the waypoint is near to the surface of a body.
Returns: true or false
Removes the waypoint.
Returns: :ok
The altitude of the waypoint above the surface of the body, in meters.
When over water, this is the altitude above the sea floor.
Returns: :ok
The celestial body the waypoint is attached to.
Returns: :ok
The seed of the icon color.
See SpaceEx.SpaceCenter.WaypointManager.colors/1 for example colors.
Returns: :ok
The icon of the waypoint.
Returns: :ok
The latitude of the waypoint.
Returns: :ok
The longitude of the waypoint.
Returns: :ok
The altitude of the waypoint above sea level, in meters.
Returns: :ok
The name of the waypoint as it appears on the map and the contract.
Returns: :ok
The altitude of the waypoint above the surface of the body or sea level, whichever is closer, in meters.
Returns: :ok
The altitude of the waypoint above the surface of the body or sea level, whichever is closer, in meters.
Returns: a high precision decimal