Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Types | Public Member Functions | Public Attributes | List of all members
Expansions.Missions.ParamChoices_CelestialBodySurface Class Reference

A class for letting the Creator choose a target location from Any, CB, Biome or Area targets More...

Inheritance diagram for Expansions.Missions.ParamChoices_CelestialBodySurface:
IConfigNode

Public Types

enum  Choices {
  Choices.anyData, Choices.bodyData, Choices.biomeData, Choices.areaData,
  Choices.launchSiteName
}
 

Public Member Functions

string GetExtraText ()
 Get extra text to be appended at the end of the node label caption. More...
 
Waypoint GetWaypoint ()
 Get the waypoint marker to show the location of the current object. More...
 
Vector3 GetWorldPosition ()
 Get location where the marker for the node should be displayed in world. More...
 
bool HasNodeLabel ()
 Should we create a node label for this object or not? More...
 
bool HasWaypoint ()
 Should we create a waypoint for this object or not? More...
 
bool HasWorldPosition ()
 Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will. More...
 
void Load (ConfigNode node)
 
string NodeBodyParameterString ()
 
void Save (ConfigNode node)
 

Public Attributes

SurfaceArea areaData
 
MissionBiome biomeData
 Biome where the flag should be placed, this value can be empty to test agains all biomes. More...
 
MissionCelestialBody bodyData
 Celestial body where the flag should be placed More...
 
string launchSiteName = "LaunchPad"
 
Choices locationChoice = Choices.bodyData
 An enum to choose from the fields below More...
 

Detailed Description

A class for letting the Creator choose a target location from Any, CB, Biome or Area targets

Member Enumeration Documentation

Enumerator
anyData 
bodyData 
biomeData 
areaData 
launchSiteName 

Member Function Documentation

string Expansions.Missions.ParamChoices_CelestialBodySurface.GetExtraText ( )
inline

Get extra text to be appended at the end of the node label caption.

Returns
Text to be appended at the end of the node label caption.
Waypoint Expansions.Missions.ParamChoices_CelestialBodySurface.GetWaypoint ( )
inline

Get the waypoint marker to show the location of the current object.

Returns
Waypoint marker representing the current location.
Vector3 Expansions.Missions.ParamChoices_CelestialBodySurface.GetWorldPosition ( )
inline

Get location where the marker for the node should be displayed in world.

Returns
Location of the node.
bool Expansions.Missions.ParamChoices_CelestialBodySurface.HasNodeLabel ( )
inline

Should we create a node label for this object or not?

Returns
True if we should create a node label, false otherwise.
bool Expansions.Missions.ParamChoices_CelestialBodySurface.HasWaypoint ( )
inline

Should we create a waypoint for this object or not?

Returns
True if we should create a waypoint, false otherwise.
bool Expansions.Missions.ParamChoices_CelestialBodySurface.HasWorldPosition ( )
inline

Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will.

Returns
True if the node has a world position, false otherwise.
void Expansions.Missions.ParamChoices_CelestialBodySurface.Load ( ConfigNode  node)
inline

Implements IConfigNode.

string Expansions.Missions.ParamChoices_CelestialBodySurface.NodeBodyParameterString ( )
inline
void Expansions.Missions.ParamChoices_CelestialBodySurface.Save ( ConfigNode  node)
inline

Implements IConfigNode.

Member Data Documentation

SurfaceArea Expansions.Missions.ParamChoices_CelestialBodySurface.areaData
MissionBiome Expansions.Missions.ParamChoices_CelestialBodySurface.biomeData

Biome where the flag should be placed, this value can be empty to test agains all biomes.

MissionCelestialBody Expansions.Missions.ParamChoices_CelestialBodySurface.bodyData

Celestial body where the flag should be placed

string Expansions.Missions.ParamChoices_CelestialBodySurface.launchSiteName = "LaunchPad"
Choices Expansions.Missions.ParamChoices_CelestialBodySurface.locationChoice = Choices.bodyData

An enum to choose from the fields below


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