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 | Static Public Attributes | Properties | List of all members
Expansions.Missions.Runtime.MissionSystem Class Reference
Inheritance diagram for Expansions.Missions.Runtime.MissionSystem:
ScenarioModule IConfigNode

Public Member Functions

bool AddMission (MissionFileInfo missionInfo)
 
override void OnAwake ()
 
override void OnLoad (ConfigNode node)
 
override void OnSave (ConfigNode node)
 
IEnumerator SetupMissionGame (MissionFileInfo missionInfo, bool playMission, bool testMode, Callback onSuccess=null, Callback onFail=null, string overrideSaveFile=null, bool trackingStation=false)
 Handles the start setup of a mission More...
 
- Public Member Functions inherited from ScenarioModule
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 

Static Public Member Functions

static void CreateCheckpoint (MENode node, bool addUTStamp=false)
 Create a mission test checkpoint, this can only be done in test mode More...
 
static void DisplayMissionEndMessage ()
 
static void DisplayMissionEndMessage (Mission finishedMission)
 
static bool HasFinishedMission ()
 
static
MissionPlayDialog.MissionProfileInfo 
LoadMetaMission (MissionFileInfo missionInfo)
 Build the meta data from a mission file. More...
 
static Mission LoadMission (MissionFileInfo missionInfo, bool loadSavedMission=false, bool initMission=false, bool simple=false)
 Load and returns a Mission object from the passed in MissionFileInfo. Will Load from the mission FilePath (.mission) file or from the SavePath (.sfs) file based on the passed in bool value. More...
 
static void SetLockedCamera (Mission mission, MissionCameraModeOptions newCameraMode, MissionCameraLockOptions newCameraLock)
 Set the Camera Mode and Locks for the system More...
 

Static Public Attributes

static Awards awardDefinitions
 List of the award definitions More...
 
static List< Missionmissions
 This is the list of currently loaded missions. More...
 
static MissionScoreInfo missionScoreInfo
 Score information for the missions More...
 

Properties

MissionCameraModeOptions CameraLockMode [get]
 Camera type options. More...
 
MissionCameraLockOptions CameraLockOptions [get]
 Camera lock options. More...
 
static bool HasMissions [get]
 Indicates if there is at least 1 mission. More...
 
static MissionSystem Instance [get, set]
 The singleton instance of the MissionSystem More...
 
static bool IsActive [get, set]
 True if the MissionSystem is active. More...
 
static bool IsTestMode [get, set]
 True if the MissionSystem is in test mode More...
 
- Properties inherited from ScenarioModule
int ClassID [get]
 
string ClassName [get]
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 

Additional Inherited Members

- Public Attributes inherited from ScenarioModule
ScenarioRunner runner
 
ProtoScenarioModule snapshot
 
List< GameScenestargetScenes
 

Member Function Documentation

bool Expansions.Missions.Runtime.MissionSystem.AddMission ( MissionFileInfo  missionInfo)
inline
static void Expansions.Missions.Runtime.MissionSystem.CreateCheckpoint ( MENode  node,
bool  addUTStamp = false 
)
inlinestatic

Create a mission test checkpoint, this can only be done in test mode

Parameters
node

< allow saving in all states except ladder and moving over srf.

static void Expansions.Missions.Runtime.MissionSystem.DisplayMissionEndMessage ( )
inlinestatic
static void Expansions.Missions.Runtime.MissionSystem.DisplayMissionEndMessage ( Mission  finishedMission)
inlinestatic
static bool Expansions.Missions.Runtime.MissionSystem.HasFinishedMission ( )
inlinestatic
static MissionPlayDialog.MissionProfileInfo Expansions.Missions.Runtime.MissionSystem.LoadMetaMission ( MissionFileInfo  missionInfo)
inlinestatic

Build the meta data from a mission file.

Parameters
missionInfoInformation about the mission file.
Returns
Meta data for the mission file.
static Mission Expansions.Missions.Runtime.MissionSystem.LoadMission ( MissionFileInfo  missionInfo,
bool  loadSavedMission = false,
bool  initMission = false,
bool  simple = false 
)
inlinestatic

Load and returns a Mission object from the passed in MissionFileInfo. Will Load from the mission FilePath (.mission) file or from the SavePath (.sfs) file based on the passed in bool value.

Parameters
missionInfoThe MissionFileInfo for the Mission we want to load
loadSavedMissionTrue to load from the SavePath(.sfs) or False to load from the FilePath(.mission). Default = false
initMissionSet to True to run Mission.InitMission
Returns
A loaded Mission object
override void Expansions.Missions.Runtime.MissionSystem.OnAwake ( )
inlinevirtual

Reimplemented from ScenarioModule.

override void Expansions.Missions.Runtime.MissionSystem.OnLoad ( ConfigNode  node)
inlinevirtual

Reimplemented from ScenarioModule.

override void Expansions.Missions.Runtime.MissionSystem.OnSave ( ConfigNode  node)
inlinevirtual

Reimplemented from ScenarioModule.

static void Expansions.Missions.Runtime.MissionSystem.SetLockedCamera ( Mission  mission,
MissionCameraModeOptions  newCameraMode,
MissionCameraLockOptions  newCameraLock 
)
inlinestatic

Set the Camera Mode and Locks for the system

Parameters
missionThe mission making the request
newCameraModeMode to change to
newCameraLockLocs to apply
IEnumerator Expansions.Missions.Runtime.MissionSystem.SetupMissionGame ( MissionFileInfo  missionInfo,
bool  playMission,
bool  testMode,
Callback  onSuccess = null,
Callback  onFail = null,
string  overrideSaveFile = null,
bool  trackingStation = false 
)
inline

Handles the start setup of a mission

Parameters
missionInfoThe MissionFileInfo for the mission
playMissiontrue if we are setting up to Play the mission, false if not (eg. returning from Editor during Mission Building)
testModeif true will run the mission in test mode
onSuccessCallback to call when Setup of Mission Game is successful.
onFailCallback to call when Setup of Mission Game is unsuccessful.
overrideSaveFileIf not null this will override the name of the saved mission we want to load
trackingStationTrue if we are building the game for the Tracking Station scene from the mission builder. (Default is false). Use for any other reason at own risk!
Returns

Member Data Documentation

Awards Expansions.Missions.Runtime.MissionSystem.awardDefinitions
static

List of the award definitions

List<Mission> Expansions.Missions.Runtime.MissionSystem.missions
static

This is the list of currently loaded missions.

MissionScoreInfo Expansions.Missions.Runtime.MissionSystem.missionScoreInfo
static

Score information for the missions

Property Documentation

MissionCameraModeOptions Expansions.Missions.Runtime.MissionSystem.CameraLockMode
get

Camera type options.

MissionCameraLockOptions Expansions.Missions.Runtime.MissionSystem.CameraLockOptions
get

Camera lock options.

bool Expansions.Missions.Runtime.MissionSystem.HasMissions
staticget

Indicates if there is at least 1 mission.

MissionSystem Expansions.Missions.Runtime.MissionSystem.Instance
staticgetset

The singleton instance of the MissionSystem

bool Expansions.Missions.Runtime.MissionSystem.IsActive
staticgetset

True if the MissionSystem is active.

bool Expansions.Missions.Runtime.MissionSystem.IsTestMode
staticgetset

True if the MissionSystem is in test mode


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