space_ex v0.3.0 SpaceEx.SpaceCenter.Waypoint

Represents a waypoint.

Can be created using SpaceEx.SpaceCenter.WaypointManager.add_waypoint/6.

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

Link to this function bedrock_altitude(conn, this)

The altitude of the waypoint above the surface of the body, in meters.

When over water, this is the altitude above the sea floor.

Link to this function body(conn, this)

The celestial body the waypoint is attached to.

Link to this function clustered(conn, this)

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/2.

Link to this function color(conn, this)

The seed of the icon color.

See SpaceEx.SpaceCenter.WaypointManager.colors/2 for example colors.

Link to this function contract(conn, this)

The associated contract.

Link to this function grounded(conn, this)

true if the waypoint is attached to the ground.

Link to this function has_contract(conn, this)

Whether the waypoint belongs to a contract.

Link to this function icon(conn, this)

The icon of the waypoint.

Link to this function index(conn, this)

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/2 is false, this is zero.

Link to this function latitude(conn, this)

The latitude of the waypoint.

Link to this function longitude(conn, this)

The longitude of the waypoint.

Link to this function mean_altitude(conn, this)

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

Link to this function name(conn, this)

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

Link to this function near_surface(conn, this)

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

Link to this function remove(conn, this)

Removes the waypoint.

Link to this function set_bedrock_altitude(conn, this, 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.

Link to this function set_body(conn, this, value)

The celestial body the waypoint is attached to.

Link to this function set_color(conn, this, value)

The seed of the icon color.

See SpaceEx.SpaceCenter.WaypointManager.colors/2 for example colors.

Link to this function set_icon(conn, this, value)

The icon of the waypoint.

Link to this function set_latitude(conn, this, value)

The latitude of the waypoint.

Link to this function set_longitude(conn, this, value)

The longitude of the waypoint.

Link to this function set_mean_altitude(conn, this, value)

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

Link to this function set_name(conn, this, value)

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

Link to this function set_surface_altitude(conn, this, value)

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

Link to this function surface_altitude(conn, this)

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