Kerbal Space Program
1.12.4
|
Public Member Functions | |
bool | BlockPlayMission (bool showDialog=false) |
Check for any issues that prevent the start of a mission More... | |
uint | CurrentVesselID (MENode node, uint vesselID) |
Will check for mapped vessel ID entries for the passed in vesselID and return the current vesselID vessel persistentId. More... | |
bool | Export (string exportFileName, bool overwrite=false) |
Export a mission to the Exports folder More... | |
ActionCreateAsteroid | GetActionCreateAsteroid (MENode node) |
Returns the first ActionCreateAsteroid attached to the passed in MENode. More... | |
ActionCreateComet | GetActionCreateComet (MENode node) |
Returns the first ActionCreateComet attached to the passed in MENode. More... | |
ActionCreateFlag | GetActionCreateFlag (MENode node) |
Returns the first ActionCreateFlag attached to the passed in MENode. More... | |
ActionCreateFlag | GetActionCreateFlagByPersistentID (uint persistentId) |
Searches the Nodes in the mission for an entry that matches the passed in flag persistentId. More... | |
ActionCreateKerbal | GetActionCreateKerbal (MENode node) |
Returns the first ActionCreateKerbal attached to the passed in MENode. More... | |
ActionCreateVessel | GetActionCreateVessel (MENode node) |
Returns the first ActionCreateVessel attached to the passed in MENode. More... | |
List< T > | GetAllActionModules< T > () |
Retrieve a List of all the action modules of a certain type from the mission nodes. More... | |
List< T > | GetAllTestModules< T > () |
Retrieve a List of all the test modules of a certain type from the mission nodes. More... | |
List< VesselSituation > | GetAllVesselSituations () |
Retrieve a List of all VesselSituations from the mission nodes. More... | |
DictionaryValueList < VesselSituation, Guid > | GetAllVesselSituationsGuid () |
Returns all VesselSituations from the Mission in a DictionaryValueList More... | |
Asteroid | GetAsteroidByPersistentID (uint persistentId) |
Searches the Nodes in the mission for an entry that matches the passed in asteroid persistentId. More... | |
MEBannerEntry | GetBanner (MEBannerType bannerType) |
Returns the banner filename inside the Banners folder of the mission for the specified type. More... | |
Comet | GetCometByPersistentID (uint PersistentId) |
Searches the Nodes in the mission for an entry that matches the passed in asteroid persistentId. More... | |
MissionCraft | GetCraftBySituationsVesselID (uint persistentId) |
Search the VesselSituationList for and entry that matches the vessels PersistentId More... | |
int | GetCraftFileIndexByPart (uint persistentId) |
Search the craftFileList that contains the provided part persistent id More... | |
MissionCraft | GetMissionCraftByFileName (string craftFileName) |
Search the CraftFileList for a entry that matches the passed in vesselName. More... | |
MissionCraft | GetMissionCraftByName (string vesselName) |
Search the CraftFileList for a entry that matches the passed in vesselName. More... | |
VesselSituation | GetMissionSituationByCraftFileName (string craftFileName) |
Search the Missions VesselSituation list for a Situation that matches the passed in craftFile name. More... | |
MENode | GetNodeById (Guid guid) |
Returns the mission node by Guid Id More... | |
Guid | GetNodeGuidByVesselID (uint persistentId) |
Searches the VesselSituationList for an entry that matches the passed in vessel persistentId. More... | |
Guid | GetNodeGuidByVesselID (uint persistentId, bool processMappedVessels) |
Searches the VesselSituationList for an entry that matches the passed in vessel persistentId. More... | |
int | GetSituationsIndexByPart (uint persistentId) |
Search the vessel situations list that contains the provided part persistent id More... | |
int | GetSituationsIndexByVessel (uint persistentId) |
Search the vessel situations list that contains the provided vessel persistent id More... | |
VesselSituation | GetVesselSituationByVesselID (uint persistentId) |
Searches the Nodes in the mission for an entry that matches the passed in vessel persistentId. More... | |
VesselSituation | GetVesselSituationByVesselID (uint persistentId, bool processMappedVessels) |
Searches the Nodes in the mission for an entry that matches the passed in vessel persistentId. More... | |
void | InitMission () |
bool | IsNextObjective (MENode node) |
Returns true if the node passed in is one of the miccions current Next Objectives More... | |
void | Load (ConfigNode node) |
void | Load (ConfigNode node, bool simple=false) |
bool | MissionHasLaunchSite (string name) |
Check if the Mission has a Launchsite with a passed in name More... | |
bool | PendingVesselLaunch (MENode node) |
Checks if the passed in MENode is an ActionCreateVessel and if so, does it have any vessel not launched. More... | |
string | PrintObjectives (bool onlyPrintActivatedNodes, bool startWithActiveNode) |
Lists out all the objectives of the mission to a string for display and returns it. More... | |
string | PrintScoreObjectives (bool onlyPrintActivatedNodes, bool startWithActiveNode, bool onlyAwardedScores) |
List out all the score descriptions summary of the mission to a string for display More... | |
void | RebuildCraftFileList () |
Rebuilds the CraftFileList of mission Ship craft files from the Mission Ship Folder Path More... | |
void | ResumeMission () |
Resume the mission after a scenario module load triggered by a scene change And ensure all the nodes and orphan nodes get initalized correctly More... | |
void | Save (ConfigNode node) |
void | SetBanner (MEBannerEntry newBanner, MEBannerType bannerType) |
Sets the name of the banner that will be looked for in the mission Banners folder. More... | |
void | SetLockedCamera (MissionCameraModeOptions newCameraMode, MissionCameraLockOptions newCameraLock) |
Changes the camera mode/locks More... | |
void | SetStartNode (MENode newStart) |
void | StartMission () |
Set the Mission to Started. This is set immediately on play if the mission has no player created vessels to be built at the start of the mission. OR, it will be started once all player created vessels at the start of the mission have been built and launched. More... | |
void | SwitchActiveVessel (Vessel vessel, bool saveRevertOnSwitch=false, bool switchImmediately=false) |
Notify the Mission you want to switch the Active Vessel. The mission will switch to the vessel in Flight at the appropriate time. It will only do this if you are in Flight Scene. More... | |
void | UpdateMission () |
Static Public Member Functions | |
static Mission | Spawn () |
Spawns a Mission GameObject and returns the Mission component. More... | |
static Mission | Spawn (MissionFileInfo missionInfo) |
Spawns a Mission GameObject and returns the Mission component. More... | |
static Mission | SpawnAndLoad (MissionFileInfo missionInfo, ConfigNode missionNode) |
Spawn and load mission More... | |
Public Attributes | |
string | author = "" |
The author's name or nickname More... | |
MissionAwards | awards |
Awards applied at the end of the mission More... | |
string | briefing = "" |
The briefing text for the mission More... | |
bool | briefingNodeActive = false |
Is set to true if a Mission Briefing Dialog Node is active on the screen at the start of a mission. Will stop the mission from progressing. More... | |
MissionCameraModeOptions | cameraLockMode = MissionCameraModeOptions.Flight |
camera type options. More... | |
MissionCameraLockOptions | cameraLockOptions = MissionCameraLockOptions.Unlock |
Camera lock options. More... | |
DictionaryValueList< string, MissionCraft > | craftFileList |
List of available Ship craft files for this mission - key is the CraftFileName More... | |
float | currentScore |
The Mission Score More... | |
MissionDifficulty | difficulty = MissionDifficulty.Intermediate |
Difficulty of the mission as rated by the Creator More... | |
string | expansionVersion = "" |
Version of the Making History expansion that was used to create this mission More... | |
string | exportName = "" |
Save name for the file that we're going to export the mission in. More... | |
string | flagURL = "" |
The flag for this mission More... | |
MissionFlow | flow |
The Flow information for the mission, used to display the flow details in the UI for the mission. More... | |
MissionScore | globalScore |
Global score applied at the end of the mission More... | |
bool | hardIcon = false |
Is this mission indicated as Hard in the dialogs More... | |
Guid | historyId |
Current history id of this mission More... | |
bool | isScoreEnabled = true |
boolean flag that sets if the score system is enabled for the mission More... | |
List< MissionMappedVessel > | mappedVessels = null |
A dictionary of Parts that have VesselNaming entries (rename vessel entries) stored within them. It maps the key (Part.persistentId) to current (actual current craft/vessel situation persistentId) and a fake/mapped persistentId that can be set against mission nodes. More... | |
float | maxScore = 0 |
Creator defined value that set the max score a player can achive on the mission More... | |
string | modsBriefing = "" |
The mods briefing text for the mission More... | |
DictionaryValueList< Guid, MENode > | nodes |
The Nodes that make up this mission More... | |
int | order |
The order of this mission when displayed in the lists More... | |
string | packName |
The mission pack this mission is a part of More... | |
MissionSituation | situation |
The details of the missions situation. Start details and other components More... | |
double | startedUT |
UT time when the mission started More... | |
ulong | steamPublishedFileId = 0 |
This is the steam published FileId for this mission if it has been published to steam. More... | |
List< string > | tags |
A list of mission tags More... | |
Static Public Attributes | |
static string | lastCompatibleVersion = "1.0.0" |
Oldest version of the Making History expansion save files that are compatible with this version. More... | |
Properties | |
MENode | activeNode [get, set] |
The activeNode in the Mission More... | |
string | ActiveNodeName [get] |
The Title of the active node. More... | |
string | BannersPath [get] |
The path to the banners folder in the mission More... | |
bool | HasBeenValidated [get] |
Is true if the mission has been validated. More... | |
Guid | id [get, set] |
Unique ID for this Mission More... | |
List< MENode > | InactiveEventNodes [get] |
List of nodes that are events and have not yet been activated - this list is set by the mission load and the activation method More... | |
bool | isEnded [get, set] |
bool | isInitialized [get, set] |
bool | isStarted [get, set] |
bool | isSuccesful [get, set] |
bool | IsTutorialMission [get] |
Gets if Mission is a TutorialMission More... | |
MissionFileInfo | MissionInfo [get, set] |
The reference to the MissionFile that relates to this mission More... | |
bool | MissionLoadedFromSFS [get] |
A flag to tell us if the mission was loaded from an SFS or from a mission file More... | |
string | PersistentSaveName [get] |
The name of the persistent save folder of this mission More... | |
string | ShipsPath [get] |
MENode | startNode [get, set] |
The startNode in the Mission More... | |
string | title [get, set] |
The display name for this More... | |
List< MissionValidationTestResult > | ValidationResults [get] |
Returns a list of the validation results for this mission. More... | |
|
inline |
Check for any issues that prevent the start of a mission
showDialog |
|
inline |
Will check for mapped vessel ID entries for the passed in vesselID and return the current vesselID vessel persistentId.
node | The node that is calling the method. |
vesselID | the vesselID we want checked for a mapped vesselID |
|
inline |
Export a mission to the Exports folder
exportFileName | File name for the export - including extension |
overwrite | Overwrite the zip if it exists already. |
|
inline |
Returns the first ActionCreateAsteroid attached to the passed in MENode.
node | The node to search |
|
inline |
Returns the first ActionCreateComet attached to the passed in MENode.
node | The node to search |
|
inline |
Returns the first ActionCreateFlag attached to the passed in MENode.
node | The node to search |
|
inline |
Searches the Nodes in the mission for an entry that matches the passed in flag persistentId.
persistentId | Flag PersistentId |
|
inline |
Returns the first ActionCreateKerbal attached to the passed in MENode.
node | The node to search |
|
inline |
Returns the first ActionCreateVessel attached to the passed in MENode.
node | The node to search |
|
inline |
Retrieve a List of all the action modules of a certain type from the mission nodes.
T | : | ActionModule |
|
inline |
Retrieve a List of all the test modules of a certain type from the mission nodes.
T | : | TestModule |
|
inline |
Retrieve a List of all VesselSituations from the mission nodes.
|
inline |
Returns all VesselSituations from the Mission in a DictionaryValueList
|
inline |
|
inline |
Returns the banner filename inside the Banners folder of the mission for the specified type.
|
inline |
|
inline |
Search the VesselSituationList for and entry that matches the vessels PersistentId
persistentId | The vessel PersistentId |
|
inline |
Search the craftFileList that contains the provided part persistent id
persistentId | Part persistent id |
|
inline |
Search the CraftFileList for a entry that matches the passed in vesselName.
craftFileName | craft name of the craft file. |
|
inline |
Search the CraftFileList for a entry that matches the passed in vesselName.
vesselName | The Ship name inside the craft file. |
|
inline |
Search the Missions VesselSituation list for a Situation that matches the passed in craftFile name.
craftFileName | craft name of the craft file. |
|
inline |
|
inline |
Searches the VesselSituationList for an entry that matches the passed in vessel persistentId.
persistentId |
|
inline |
Searches the VesselSituationList for an entry that matches the passed in vessel persistentId.
persistentId | |
processMappedVessels | set true will check mappedVessels and substitute persistentId if a match is found. |
|
inline |
Search the vessel situations list that contains the provided part persistent id
persistentId | Part persistent id |
|
inline |
Search the vessel situations list that contains the provided vessel persistent id
persistentId | Vessel persistent id |
|
inline |
Searches the Nodes in the mission for an entry that matches the passed in vessel persistentId.
persistentId | vessel PersistentId |
|
inline |
Searches the Nodes in the mission for an entry that matches the passed in vessel persistentId.
persistentId | vessel PersistentId |
processMappedVessels | set true will check mappedVessels and substitute persistentId if a match is found. |
|
inline |
|
inline |
Returns true if the node passed in is one of the miccions current Next Objectives
node | the node to test |
|
inline |
Implements IConfigNode.
|
inline |
|
inline |
Check if the Mission has a Launchsite with a passed in name
name | The LaunchSite object name (not the display name) |
|
inline |
Checks if the passed in MENode is an ActionCreateVessel and if so, does it have any vessel not launched.
node | The node to check. |
|
inline |
Lists out all the objectives of the mission to a string for display and returns it.
onlyPrintActivatedNodes | Only print activated nodes. Useful for when you've just completed a mission and want to show what happened. |
startWithActiveNode | Starts recursion from the active node if true, if falise starts recursion from the start node. Good for printing out the remaining objectives in a mission. |
|
inline |
List out all the score descriptions summary of the mission to a string for display
onlyPrintActivatedNodes | |
startWithActiveNode | |
onlyAwardedScores | Only print scores that you have earned during play |
|
inline |
Rebuilds the CraftFileList of mission Ship craft files from the Mission Ship Folder Path
|
inline |
Resume the mission after a scenario module load triggered by a scene change And ensure all the nodes and orphan nodes get initalized correctly
|
inline |
Implements IConfigNode.
|
inline |
Sets the name of the banner that will be looked for in the mission Banners folder.
|
inline |
Changes the camera mode/locks
newCameraMode | Mode to change to |
newCameraLock | Locs to apply |
|
inline |
|
inlinestatic |
|
inlinestatic |
Spawns a Mission GameObject and returns the Mission component.
missionInfo | the MissionFileInfo for the mission. |
|
inlinestatic |
Spawn and load mission
missionInfo | |
missionNode |
|
inline |
Set the Mission to Started. This is set immediately on play if the mission has no player created vessels to be built at the start of the mission. OR, it will be started once all player created vessels at the start of the mission have been built and launched.
|
inline |
|
inline |
string Expansions.Missions.Mission.author = "" |
The author's name or nickname
MissionAwards Expansions.Missions.Mission.awards |
Awards applied at the end of the mission
string Expansions.Missions.Mission.briefing = "" |
The briefing text for the mission
bool Expansions.Missions.Mission.briefingNodeActive = false |
Is set to true if a Mission Briefing Dialog Node is active on the screen at the start of a mission. Will stop the mission from progressing.
MissionCameraModeOptions Expansions.Missions.Mission.cameraLockMode = MissionCameraModeOptions.Flight |
camera type options.
MissionCameraLockOptions Expansions.Missions.Mission.cameraLockOptions = MissionCameraLockOptions.Unlock |
Camera lock options.
DictionaryValueList<string,MissionCraft> Expansions.Missions.Mission.craftFileList |
List of available Ship craft files for this mission - key is the CraftFileName
float Expansions.Missions.Mission.currentScore |
The Mission Score
MissionDifficulty Expansions.Missions.Mission.difficulty = MissionDifficulty.Intermediate |
Difficulty of the mission as rated by the Creator
string Expansions.Missions.Mission.expansionVersion = "" |
Version of the Making History expansion that was used to create this mission
string Expansions.Missions.Mission.exportName = "" |
Save name for the file that we're going to export the mission in.
string Expansions.Missions.Mission.flagURL = "" |
The flag for this mission
MissionFlow Expansions.Missions.Mission.flow |
The Flow information for the mission, used to display the flow details in the UI for the mission.
MissionScore Expansions.Missions.Mission.globalScore |
Global score applied at the end of the mission
bool Expansions.Missions.Mission.hardIcon = false |
Is this mission indicated as Hard in the dialogs
Guid Expansions.Missions.Mission.historyId |
Current history id of this mission
bool Expansions.Missions.Mission.isScoreEnabled = true |
boolean flag that sets if the score system is enabled for the mission
|
static |
Oldest version of the Making History expansion save files that are compatible with this version.
List<MissionMappedVessel> Expansions.Missions.Mission.mappedVessels = null |
A dictionary of Parts that have VesselNaming entries (rename vessel entries) stored within them. It maps the key (Part.persistentId) to current (actual current craft/vessel situation persistentId) and a fake/mapped persistentId that can be set against mission nodes.
float Expansions.Missions.Mission.maxScore = 0 |
Creator defined value that set the max score a player can achive on the mission
string Expansions.Missions.Mission.modsBriefing = "" |
The mods briefing text for the mission
DictionaryValueList<Guid, MENode> Expansions.Missions.Mission.nodes |
The Nodes that make up this mission
int Expansions.Missions.Mission.order |
The order of this mission when displayed in the lists
string Expansions.Missions.Mission.packName |
The mission pack this mission is a part of
MissionSituation Expansions.Missions.Mission.situation |
The details of the missions situation. Start details and other components
double Expansions.Missions.Mission.startedUT |
UT time when the mission started
ulong Expansions.Missions.Mission.steamPublishedFileId = 0 |
This is the steam published FileId for this mission if it has been published to steam.
List<string> Expansions.Missions.Mission.tags |
A list of mission tags
|
get |
The Title of the active node.
|
get |
The path to the banners folder in the mission
|
get |
Is true if the mission has been validated.
|
getset |
Unique ID for this Mission
|
get |
List of nodes that are events and have not yet been activated - this list is set by the mission load and the activation method
|
getset |
|
getset |
|
getset |
|
getset |
|
get |
Gets if Mission is a TutorialMission
|
getset |
The reference to the MissionFile that relates to this mission
|
get |
A flag to tell us if the mission was loaded from an SFS or from a mission file
|
get |
The name of the persistent save folder of this mission
|
get |
|
getset |
The display name for this
|
get |
Returns a list of the validation results for this mission.