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
PSystemSetup Class Reference
Inheritance diagram for PSystemSetup:

Classes

class  SpaceCenterFacility
 

Public Member Functions

bool AddLaunchSite (LaunchSite launchsite)
 Add a LaunchSite to the stored list More...
 
GameObject FindPQS (string pqsName)
 Find the PQS GameObject that matches the passed in name. More...
 
LaunchSite GetLaunchSite (string name)
 Get the Launchsite with the name provided More...
 
CelestialBody GetLaunchSiteBody (string name)
 Will return the CelestialBody that a SpaceCenterFacility or LaunchSite is located on. More...
 
string GetLaunchSiteBodyName (string name)
 Will return the name of the CelestialBody that a SpaceCenterFacility or LaunchSite is located on. More...
 
string GetLaunchSiteDisplayName (string name)
 Will Return the LaunchSite display name. More...
 
SpaceCenterFacility GetSpaceCenterFacility (string name)
 
bool IsFacility (string inputName, out string displayName)
 Check if the name passed in is a SpaceCenterFacility. More...
 
bool IsFacilityOrLaunchSite (string inputName, out bool isFacility, out string displayName)
 Check if the name passed in is a SpaceCenterFacility or Stock LaunchSite More...
 
bool IsLaunchSite (string inputName, out string displayName)
 Check if the name passed in is a LaunchSite More...
 
bool IsStockLaunchSite (string name)
 Check if LaunchSite name is a stock launchsite or not. Missions Expansion must be installed. Otherwise will return false in all cases. More...
 
void LoadTestScene (GameScenes sceneBase)
 Call this method to override the next scene transition and invoke the setup for a given scene type (useful for test scenes) More...
 
bool RemoveLaunchSite (string name)
 Remove a LaunchSite from the stored list. Will destroy the PQSCity or PQSCity2 object as well. More...
 
void RemoveNonStockLaunchSites ()
 Will remove all Non Stock LaunchSites from the system. This includes deleting the PQSCity and PQSCity2 game objects. More...
 
void SetPQSActive (PQS pqs)
 
void SetPQSActive ()
 
void SetPQSDisabled ()
 
void SetPQSInactive (bool keepActiveInFlight=false)
 

Public Attributes

GameScenes nextScene = GameScenes.MAINMENU
 
string pqsToActivate = "Kerbin"
 
string pqsTransformToCache = "KSC"
 

Properties

static PSystemSetup Instance [get, set]
 
List< LaunchSiteLaunchSites [get]
 A list of all the LaunchSites in the game. More...
 
LaunchSite[] NonStockLaunchSites [get]
 Returns an Array of all Non-Stock Launch Sites (this includes mission launch sites). More...
 
Transform SCTransform [get]
 
SpaceCenterFacility[] SpaceCenterFacilities [get, set]
 
List< SpaceCenterFacilitySpaceCenterFacilityLaunchSites [get]
 
LaunchSite[] StockLaunchSites [get]
 Array of the stock launch sites (not removable) in the game. More...
 

Member Function Documentation

bool PSystemSetup.AddLaunchSite ( LaunchSite  launchsite)
inline

Add a LaunchSite to the stored list

Parameters
launchsiteLaunchSite
Returns
True if the launchsite could be added. returns false on failure or if the MissionsExpansion is not installed
GameObject PSystemSetup.FindPQS ( string  pqsName)
inline

Find the PQS GameObject that matches the passed in name.

Parameters
pqsNameThe nameof the PQS to find.
Returns
the GameObject for the PQS that matches the pqsName or Null if not found.
LaunchSite PSystemSetup.GetLaunchSite ( string  name)
inline

Get the Launchsite with the name provided

Parameters
nameLaunchSite Name
Returns
A Launch site or null if the site is not found. Also returns null if the MissionsExpansion is not installed
CelestialBody PSystemSetup.GetLaunchSiteBody ( string  name)
inline

Will return the CelestialBody that a SpaceCenterFacility or LaunchSite is located on.

Parameters
nameSpaceCenterFacility name or LaunchSite name
Returns
The CelestialBody or null
string PSystemSetup.GetLaunchSiteBodyName ( string  name)
inline

Will return the name of the CelestialBody that a SpaceCenterFacility or LaunchSite is located on.

Parameters
name
Returns
String containing the name of the CelestialBody or null
string PSystemSetup.GetLaunchSiteDisplayName ( string  name)
inline

Will Return the LaunchSite display name.

Parameters
nameLaunchSite name.
Returns
The display name or the passed in string if not found.
SpaceCenterFacility PSystemSetup.GetSpaceCenterFacility ( string  name)
inline
bool PSystemSetup.IsFacility ( string  inputName,
out string  displayName 
)
inline

Check if the name passed in is a SpaceCenterFacility.

Parameters
inputNamename of the facility/launchsite
displayNameReturns the displayName for the facility or launchsite if found.
Returns
true if it is. Otherwise false.
bool PSystemSetup.IsFacilityOrLaunchSite ( string  inputName,
out bool  isFacility,
out string  displayName 
)
inline

Check if the name passed in is a SpaceCenterFacility or Stock LaunchSite

Parameters
inputNamename of the facility/launchsite
isFacilityReturns True if the passed in name is a SpaceCenterFacility; otherwise returns false.
displayNameReturns the displayName for the facility or launchsite if found.
Returns
true if it is. Otherwise false.
bool PSystemSetup.IsLaunchSite ( string  inputName,
out string  displayName 
)
inline

Check if the name passed in is a LaunchSite

Parameters
inputNamename of the facility/launchsite
displayNameReturns the displayName for the facility or launchsite if found.
Returns
true if it is. Otherwise false.
bool PSystemSetup.IsStockLaunchSite ( string  name)
inline

Check if LaunchSite name is a stock launchsite or not. Missions Expansion must be installed. Otherwise will return false in all cases.

Parameters
namename of the launchsite
Returns
true if it is. Otherwise false.
void PSystemSetup.LoadTestScene ( GameScenes  sceneBase)
inline

Call this method to override the next scene transition and invoke the setup for a given scene type (useful for test scenes)

Parameters
scene
bool PSystemSetup.RemoveLaunchSite ( string  name)
inline

Remove a LaunchSite from the stored list. Will destroy the PQSCity or PQSCity2 object as well.

Parameters
nameLaunchSite name
Returns
True if the launchsite could be removed. returns false on failure or if the MissionsExpansion is not installed
void PSystemSetup.RemoveNonStockLaunchSites ( )
inline

Will remove all Non Stock LaunchSites from the system. This includes deleting the PQSCity and PQSCity2 game objects.

void PSystemSetup.SetPQSActive ( PQS  pqs)
inline
void PSystemSetup.SetPQSActive ( )
inline
void PSystemSetup.SetPQSDisabled ( )
inline
void PSystemSetup.SetPQSInactive ( bool  keepActiveInFlight = false)
inline

Member Data Documentation

GameScenes PSystemSetup.nextScene = GameScenes.MAINMENU
string PSystemSetup.pqsToActivate = "Kerbin"
string PSystemSetup.pqsTransformToCache = "KSC"

Property Documentation

PSystemSetup PSystemSetup.Instance
staticgetset
List<LaunchSite> PSystemSetup.LaunchSites
get

A list of all the LaunchSites in the game.

LaunchSite [] PSystemSetup.NonStockLaunchSites
get

Returns an Array of all Non-Stock Launch Sites (this includes mission launch sites).

Transform PSystemSetup.SCTransform
get
SpaceCenterFacility [] PSystemSetup.SpaceCenterFacilities
getset
List<SpaceCenterFacility> PSystemSetup.SpaceCenterFacilityLaunchSites
get
LaunchSite [] PSystemSetup.StockLaunchSites
get

Array of the stock launch sites (not removable) in the game.


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