Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
NavWaypoint Class Reference
Inheritance diagram for NavWaypoint:

Public Member Functions

void Activate ()
 Turn on the indicator. (Does not apply to IVA.) More...
 
void Awake ()
 
void Clear ()
 Sets navigation to nonsensical, impossible values. Useful when you do NOT want to match anything. More...
 
void Deactivate ()
 Turn off the indicator. (Does not apply to IVA.) More...
 
bool IsUsing (double latitude, double longitude, double altitude)
 If navigation is currently set to a specific set of coordinates. More...
 
bool IsUsing (Waypoint waypoint)
 If navigation is currently set to a waypoint. More...
 
bool IsVisible (bool condition=true)
 If the indicator should even be enabled right now. More...
 
void LateUpdate ()
 
void Setup (CelestialBody body, double latitude, double longitude, double altitude, string texture, Color color)
 Set navigation to a specific set of coordinates, using a specific texture and color. More...
 
void Setup (Waypoint waypoint)
 Set navigation to a waypoint, using the waypoint meta data to supply texture and color for the indicator. More...
 

Static Public Member Functions

static void DeactivateIfWaypoint (Waypoint waypoint)
 Deactivates the indicator if it is using the specified waypoint. More...
 

Public Attributes

bool showGhosted
 Should the navpoint show ghosted on the navball when its behind the vessel More...
 

Properties

double Altitude [get, set]
 
CelestialBody Body [get, set]
 
Color Color [get, set]
 
static NavWaypoint fetch [get]
 
double Height [get, set]
 
bool IsActive [get, set]
 
bool IsBlinking [get, set]
 
double Latitude [get, set]
 
double Longitude [get, set]
 
Vector3 NavigationVector [get]
 The direction the active vessel must go to reach the waypoint. More...
 
string TextureID [get, set]
 
GameObject Visual [get, set]
 

Member Function Documentation

void NavWaypoint.Activate ( )
inline

Turn on the indicator. (Does not apply to IVA.)

void NavWaypoint.Awake ( )
inline

< Recursively search for a waypoint to copy initial mesh and shader information from.

< We want a duplicate, but separate material, to copy over the shaders and such.

< waypoints be slightly smaller than nav indicators

void NavWaypoint.Clear ( )
inline

Sets navigation to nonsensical, impossible values. Useful when you do NOT want to match anything.

void NavWaypoint.Deactivate ( )
inline

Turn off the indicator. (Does not apply to IVA.)

static void NavWaypoint.DeactivateIfWaypoint ( Waypoint  waypoint)
inlinestatic

Deactivates the indicator if it is using the specified waypoint.

Parameters
waypointThe specified waypoint.
bool NavWaypoint.IsUsing ( double  latitude,
double  longitude,
double  altitude 
)
inline

If navigation is currently set to a specific set of coordinates.

bool NavWaypoint.IsUsing ( Waypoint  waypoint)
inline

If navigation is currently set to a waypoint.

bool NavWaypoint.IsVisible ( bool  condition = true)
inline

If the indicator should even be enabled right now.

void NavWaypoint.LateUpdate ( )
inline
void NavWaypoint.Setup ( CelestialBody  body,
double  latitude,
double  longitude,
double  altitude,
string  texture,
Color  color 
)
inline

Set navigation to a specific set of coordinates, using a specific texture and color.

void NavWaypoint.Setup ( Waypoint  waypoint)
inline

Set navigation to a waypoint, using the waypoint meta data to supply texture and color for the indicator.

Member Data Documentation

bool NavWaypoint.showGhosted

Should the navpoint show ghosted on the navball when its behind the vessel

Property Documentation

double NavWaypoint.Altitude
getset
CelestialBody NavWaypoint.Body
getset
Color NavWaypoint.Color
getset
NavWaypoint NavWaypoint.fetch
staticget
double NavWaypoint.Height
getset
bool NavWaypoint.IsActive
getset
bool NavWaypoint.IsBlinking
getset
double NavWaypoint.Latitude
getset
double NavWaypoint.Longitude
getset
Vector3 NavWaypoint.NavigationVector
get

The direction the active vessel must go to reach the waypoint.

string NavWaypoint.TextureID
getset
GameObject NavWaypoint.Visual
getset

The documentation for this class was generated from the following file: