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

Classes

class  SpawnPoint
 

Public Member Functions

string GetName ()
 ObjectName in Unity Hierarchy (_Node appended) More...
 
SpawnPoint GetSpawnPoint (string spawnPointName)
 Find and return a SpawnPoint by name. More...
 
Transform GetWorldPos ()
 Get the node spositiuon in world coords More...
 
double GreatCircleDistance (Vector3d fromSrfNrm)
 Get the GreatCircle Distance between the passed in vector3d and this Launchsite's position. More...
 
 LaunchSite (string name, string pqsName, string launchSiteName, SpawnPoint[] spawnPoints, string launchSiteTransformURL, EditorFacility editorFacility)
 Constructor More...
 
void SetSpawnPointsLatLonAlt ()
 Called on setup of the Facility PQSCity/2 to set the Latitude, Longitude, Altitude of each spawnpoint. More...
 
bool Setup (Object pqsCity, PQS[] PQSs)
 Setup the LaunchSite Instance. Will also Call all the Setup method for all SpawnPoints in the SpawnPoints Array. More...
 
void UpdateNodeCaption (MapNode mn, MapNode.CaptionData data)
 Method to update the mapnode contents More...
 

Public Attributes

EditorFacility editorFacility
 The Editor Facility this launchSite is linked to. More...
 
string launchSiteName
 The LaunchSite Name More...
 
PQS launchsitePQS
 Reference to the LaunchSite PQS More...
 
Transform launchSiteTransform
 The Transform for the LaunchSite. More...
 
string launchSiteTransformURL
 The launchSiteTransform URL More...
 
string name
 The LaunchSite Name More...
 
MapNode.SiteType nodeType
 The icon to use for mapnodes More...
 
string poiName = ""
 The POI Name that once visited unlocks the launchsite More...
 
PositionMobileLaunchPad positionMobileLaunchPad
 The PositionMobileLaunchPad component - if any. Set in Setup() More...
 
PQSCity pqsCity
 Reference to the PQSCity for the LaunchSite, can be null only if pqsCity2 is not null. A LaunchSite can be a PQSCity or a PQSCity2. More...
 
PQSCity2 pqsCity2
 Reference to the PQSCity2 for the LaunchSite, can be null only if pqsCity is not null. A LaunchSite can be a PQSCity or a PQSCity2. More...
 
string pqsName
 The PQS this Launchsite is a part of. More...
 
bool requiresPOIVisit = false
 True to hide this if a POI has to be visited to unlock the Launchsite More...
 
SpawnPoint[] spawnPoints
 An array of Spawn Points for the LaunchSite More...
 

Properties

CelestialBody Body [get]
 The CelestialBody of the LaunchSite. More...
 
bool isPQSCity [get]
 True if this LaunchSite is a PQSCity type. More...
 
bool isPQSCity2 [get]
 True if this LaunchSite is a PQSCity2 type. More...
 
bool IsSetup [get]
 True if the LaunchSite has been setup successfully. More...
 

Constructor & Destructor Documentation

LaunchSite.LaunchSite ( string  name,
string  pqsName,
string  launchSiteName,
SpawnPoint[]  spawnPoints,
string  launchSiteTransformURL,
EditorFacility  editorFacility 
)
inline

Constructor

Parameters
nameThe internal Name of the LaunchSite, should contain no special characters or spaces
pqsNameThe PQS Name the LaunchSite is on.
launchSiteNameThe Name of the LaunchSite (displayed name)
spawnPointsThe SpawnPoints array for the LaunchSite
launchSiteTransformURLThe URL for the launch Site transform from the PQS down it's children path
editorFacilityThe Editor Facility the launch site is associated with

Member Function Documentation

string LaunchSite.GetName ( )
inline

ObjectName in Unity Hierarchy (_Node appended)

Returns
The name

Implements ISiteNode.

SpawnPoint LaunchSite.GetSpawnPoint ( string  spawnPointName)
inline

Find and return a SpawnPoint by name.

Parameters
spawnPointName
Returns
Transform LaunchSite.GetWorldPos ( )
inline

Get the node spositiuon in world coords

Returns
Transform with World position values

Implements ISiteNode.

double LaunchSite.GreatCircleDistance ( Vector3d  fromSrfNrm)
inline

Get the GreatCircle Distance between the passed in vector3d and this Launchsite's position.

Parameters
fromSrfNrm
Returns
void LaunchSite.SetSpawnPointsLatLonAlt ( )
inline

Called on setup of the Facility PQSCity/2 to set the Latitude, Longitude, Altitude of each spawnpoint.

bool LaunchSite.Setup ( Object  pqsCity,
PQS[]  PQSs 
)
inline

Setup the LaunchSite Instance. Will also Call all the Setup method for all SpawnPoints in the SpawnPoints Array.

Parameters
pqsCityAn instance Object of a PQSCity or PQSCity2 defining the LaunchSite
void LaunchSite.UpdateNodeCaption ( MapNode  mn,
MapNode.CaptionData  data 
)
inline

Method to update the mapnode contents

Parameters
mnThe mapnode
datathe caption structure - edit this to update whats displayed

Implements ISiteNode.

Member Data Documentation

EditorFacility LaunchSite.editorFacility

The Editor Facility this launchSite is linked to.

string LaunchSite.launchSiteName

The LaunchSite Name

PQS LaunchSite.launchsitePQS

Reference to the LaunchSite PQS

Transform LaunchSite.launchSiteTransform

The Transform for the LaunchSite.

string LaunchSite.launchSiteTransformURL

The launchSiteTransform URL

string LaunchSite.name

The LaunchSite Name

MapNode.SiteType LaunchSite.nodeType

The icon to use for mapnodes

string LaunchSite.poiName = ""

The POI Name that once visited unlocks the launchsite

PositionMobileLaunchPad LaunchSite.positionMobileLaunchPad

The PositionMobileLaunchPad component - if any. Set in Setup()

PQSCity LaunchSite.pqsCity

Reference to the PQSCity for the LaunchSite, can be null only if pqsCity2 is not null. A LaunchSite can be a PQSCity or a PQSCity2.

PQSCity2 LaunchSite.pqsCity2

Reference to the PQSCity2 for the LaunchSite, can be null only if pqsCity is not null. A LaunchSite can be a PQSCity or a PQSCity2.

string LaunchSite.pqsName

The PQS this Launchsite is a part of.

bool LaunchSite.requiresPOIVisit = false

True to hide this if a POI has to be visited to unlock the Launchsite

SpawnPoint [] LaunchSite.spawnPoints

An array of Spawn Points for the LaunchSite

Property Documentation

CelestialBody LaunchSite.Body
get
bool LaunchSite.isPQSCity
get

True if this LaunchSite is a PQSCity type.

bool LaunchSite.isPQSCity2
get

True if this LaunchSite is a PQSCity2 type.

bool LaunchSite.IsSetup
get

True if the LaunchSite has been setup successfully.


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