Expansions.Missions.MissionFileInfo Class Reference

A class to hold details of a mission file and some helper properties so we can pass this around as an object More...

Public Member Functions
ulong	GetSteamFileId ()
	Returns the steam fileId for this MissionFileInfo. Calling method should cater for Zero return value (not found). More...
bool	IsCompatible ()
	Check to see if mission is compatible with the current version of KSP. More...
bool	IsCraftCompatible (ref string errorString, ref HashSet< string > incompatibleCraftHashSet, bool checkSaveIfAvailable)
	Checks if Craft files are compatible with current version of KSP. More...
	MissionFileInfo (string folderName, MissionTypes missionType)
void	UpdateSteamState ()
	Will update the Steam State for the item from Steam Workshop. More...

Static Public Member Functions
static MissionFileInfo	CreateFromPath (string fullPath)

Public Attributes
string	author
	The author's name or nickname More...
string	briefing
	The briefing of the mission from inside the file More...
bool	canBeUsed
	Indicates if the items steam state allows it to be used by the user or not. More...
MissionDifficulty	difficulty = MissionDifficulty.Intermediate
	Difficulty of the mission as rated by the Creator More...
string	folderName
	The name of the mission folder with NO extension More...
bool	hardIcon
	Show a hardIcon in the dialogs More...
MissionTypes	missionType
	Is this a stock mission or a user created one More...
string	modsBriefing
	The mods briefing of the mission More...
int	order
	The order of this mission when displayed in the lists More...
string	packName
	The name of the mission folder with NO extension More...
int	steamState
	The Steam State for the item. More...
string	steamStateText
	Contains a status string of the steam state for this item. More...
bool	subscribed
	The subscribed state of the item. More...
List< string >	tags
	The tags of the mission from inside the file More...
string	title
	The title of the mission from inside the file More...

Properties
string	BannerPath [get]
	Path to Banners folder within the mission More...
FileInfo	FileInfoObject [get]
	FI object of the persistent.mission file More...
string	FilePath [get]
	The path of the persistent.mission file More...
string	FolderPath [get]
	The path to the folder the persistent.mission file is stored in More...
bool	HasSave [get]
	Does the persistent.sfs file exist More...
bool	IsTutorialMission [get]
	Gets if Mission is a TutorialMission More...
MissionPlayDialog.MissionProfileInfo	MetaMission [get]
	Return the meta mission object for this File (.loadmeta) More...
Mission	savedMission [get]
	Return the Mission object for this file (.sfs) If there is no .sfs Saved Mission Object will return Null. More...
string	SaveFolderPath [get]
	Path to the Save folder that will be used for this mission eg. saves/Missions More...
string	SavePath [get]
	Path to the persistent.sfs Save file that will be used for this mission More...
string	SaveShipFolderPath [get]
	The path to the folder the .craft files for the saved mission are stored in More...
string	ShipFolderPath [get]
	The path to the folder the .craft files for the mission are stored in More...
Mission	SimpleMission [get]
	Return the Mission object for this File (.mission) WITHOUT craft files More...

Detailed Description

A class to hold details of a mission file and some helper properties so we can pass this around as an object

Constructor & Destructor Documentation

Expansions.Missions.MissionFileInfo.MissionFileInfo ( string  folderName, MissionTypes  missionType  )

inline

Member Function Documentation

static MissionFileInfo Expansions.Missions.MissionFileInfo.CreateFromPath ( string  fullPath )

inlinestatic

ulong Expansions.Missions.MissionFileInfo.GetSteamFileId ( )

inline

Returns the steam fileId for this MissionFileInfo. Calling method should cater for Zero return value (not found).

Returns

Returns the file Id or Zero if not found.

bool Expansions.Missions.MissionFileInfo.IsCompatible ( )

inline

Check to see if mission is compatible with the current version of KSP.

Returns

True if compatible, false otherwise.

bool Expansions.Missions.MissionFileInfo.IsCraftCompatible ( ref string  errorString, ref HashSet< string >  incompatibleCraftHashSet, bool  checkSaveIfAvailable  )

inline

Checks if Craft files are compatible with current version of KSP.

Parameters

errorString	Fills in a string with a description of the errors found in the vessels.
incompatibleCraftHashSet	Fills in a hash set with the names of the craft files where there are errors.
checkSaveIfAvailable	Should we check the craft for the saved mission if one exists? This takes precedence over checking the standard mission folder.

Returns

False if there are compatibility issues with the craft files, true otherwise.

void Expansions.Missions.MissionFileInfo.UpdateSteamState ( )

inline

Will update the Steam State for the item from Steam Workshop.

Member Data Documentation

string Expansions.Missions.MissionFileInfo.author

The author's name or nickname

string Expansions.Missions.MissionFileInfo.briefing

The briefing of the mission from inside the file

bool Expansions.Missions.MissionFileInfo.canBeUsed

Indicates if the items steam state allows it to be used by the user or not.

MissionDifficulty Expansions.Missions.MissionFileInfo.difficulty = MissionDifficulty.Intermediate

Difficulty of the mission as rated by the Creator

string Expansions.Missions.MissionFileInfo.folderName

The name of the mission folder with NO extension

bool Expansions.Missions.MissionFileInfo.hardIcon

Show a hardIcon in the dialogs

MissionTypes Expansions.Missions.MissionFileInfo.missionType

Is this a stock mission or a user created one

string Expansions.Missions.MissionFileInfo.modsBriefing

The mods briefing of the mission

int Expansions.Missions.MissionFileInfo.order

The order of this mission when displayed in the lists

string Expansions.Missions.MissionFileInfo.packName

The name of the mission folder with NO extension

int Expansions.Missions.MissionFileInfo.steamState

The Steam State for the item.

string Expansions.Missions.MissionFileInfo.steamStateText

Contains a status string of the steam state for this item.

bool Expansions.Missions.MissionFileInfo.subscribed

The subscribed state of the item.

List<string> Expansions.Missions.MissionFileInfo.tags

The tags of the mission from inside the file

string Expansions.Missions.MissionFileInfo.title

The title of the mission from inside the file

Property Documentation

string Expansions.Missions.MissionFileInfo.BannerPath

get

Path to Banners folder within the mission

FileInfo Expansions.Missions.MissionFileInfo.FileInfoObject

get

FI object of the persistent.mission file

string Expansions.Missions.MissionFileInfo.FilePath

get

The path of the persistent.mission file

string Expansions.Missions.MissionFileInfo.FolderPath

get

The path to the folder the persistent.mission file is stored in

bool Expansions.Missions.MissionFileInfo.HasSave

get

Does the persistent.sfs file exist

bool Expansions.Missions.MissionFileInfo.IsTutorialMission

get

Gets if Mission is a TutorialMission

MissionPlayDialog.MissionProfileInfo Expansions.Missions.MissionFileInfo.MetaMission

get

Return the meta mission object for this File (.loadmeta)

Mission Expansions.Missions.MissionFileInfo.savedMission

get

Return the Mission object for this file (.sfs) If there is no .sfs Saved Mission Object will return Null.

string Expansions.Missions.MissionFileInfo.SaveFolderPath

get

Path to the Save folder that will be used for this mission eg. saves/Missions

string Expansions.Missions.MissionFileInfo.SavePath

get

Path to the persistent.sfs Save file that will be used for this mission

string Expansions.Missions.MissionFileInfo.SaveShipFolderPath

get

The path to the folder the .craft files for the saved mission are stored in

string Expansions.Missions.MissionFileInfo.ShipFolderPath

get

The path to the folder the .craft files for the mission are stored in

Mission Expansions.Missions.MissionFileInfo.SimpleMission

get

Return the Mission object for this File (.mission) WITHOUT craft files

---

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

• KSP/Assets/Expansions/Missions/Scripts/MissionFileInfo.cs