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 | Public Attributes | List of all members
KSP.UI.Screens.SteamCraftInfo Class Reference

Public Member Functions

void ProcessMetaData (string metaData)
 Processes Steam MetaData string into instances fields. Expects the passed in string to be in KSP Steam Craft Item ConfigNode format. More...
 
 SteamCraftInfo (SteamUGCDetails_t itemDetails)
 
void UpdateSteamState ()
 Will update the Steam State for the item from Steam Workshop. More...
 

Static Public Member Functions

static string CreateMetaData (string modsBriefing, string vesselType, float mass, float cost, int partCount, int stageCount, int crewCapacity)
 Create Steam workshop mission item metadata string from passed in Details More...
 

Public Attributes

bool canBeUsed
 Indicates if the items steam state allows it to be used by the user or not. More...
 
float cost
 The craft cost from the Steam Workshop MetaData More...
 
int crewCapacity
 The craft crew capacity from the Steam Workshop MetaData More...
 
SteamUGCDetails_t itemDetails
 The Steam UGC Details for the Mission More...
 
string KSPversion
 The KSP version the craft was created in. More...
 
float mass
 The Vcraft mass from the Steam Workshop MetaData More...
 
ConfigNode metaData
 ConfigNode containing the Steam Workshop MetaData from this class. More...
 
string modsBriefing
 The Mods Briefing from the Steam Workshop MetaData More...
 
int partCount
 The craft part count from the Steam Workshop MetaData More...
 
string previewURL
 The Steam Workshop preview URL for the item More...
 
int stageCount
 The craft stage count from the Steam Workshop MetaData 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...
 
UInt64 totalFavorites
 The total number of Steam Favourites for the item More...
 
UInt64 totalFollowers
 The total number of Steam followers for the item More...
 
UInt64 totalSubscriptions
 The total number of Steam Subscriptions for the item More...
 
string vesselType
 The VesselType from the Steam Workshop MetaData More...
 

Constructor & Destructor Documentation

KSP.UI.Screens.SteamCraftInfo.SteamCraftInfo ( SteamUGCDetails_t  itemDetails)
inline

Member Function Documentation

static string KSP.UI.Screens.SteamCraftInfo.CreateMetaData ( string  modsBriefing,
string  vesselType,
float  mass,
float  cost,
int  partCount,
int  stageCount,
int  crewCapacity 
)
inlinestatic

Create Steam workshop mission item metadata string from passed in Details

Parameters
mission
Returns
void KSP.UI.Screens.SteamCraftInfo.ProcessMetaData ( string  metaData)
inline

Processes Steam MetaData string into instances fields. Expects the passed in string to be in KSP Steam Craft Item ConfigNode format.

Parameters
metaDatathe meta data string returned from Steam
void KSP.UI.Screens.SteamCraftInfo.UpdateSteamState ( )
inline

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

Member Data Documentation

bool KSP.UI.Screens.SteamCraftInfo.canBeUsed

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

float KSP.UI.Screens.SteamCraftInfo.cost

The craft cost from the Steam Workshop MetaData

int KSP.UI.Screens.SteamCraftInfo.crewCapacity

The craft crew capacity from the Steam Workshop MetaData

SteamUGCDetails_t KSP.UI.Screens.SteamCraftInfo.itemDetails

The Steam UGC Details for the Mission

string KSP.UI.Screens.SteamCraftInfo.KSPversion

The KSP version the craft was created in.

float KSP.UI.Screens.SteamCraftInfo.mass

The Vcraft mass from the Steam Workshop MetaData

ConfigNode KSP.UI.Screens.SteamCraftInfo.metaData

ConfigNode containing the Steam Workshop MetaData from this class.

string KSP.UI.Screens.SteamCraftInfo.modsBriefing

The Mods Briefing from the Steam Workshop MetaData

int KSP.UI.Screens.SteamCraftInfo.partCount

The craft part count from the Steam Workshop MetaData

string KSP.UI.Screens.SteamCraftInfo.previewURL

The Steam Workshop preview URL for the item

int KSP.UI.Screens.SteamCraftInfo.stageCount

The craft stage count from the Steam Workshop MetaData

int KSP.UI.Screens.SteamCraftInfo.steamState

The Steam State for the item.

string KSP.UI.Screens.SteamCraftInfo.steamStateText

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

bool KSP.UI.Screens.SteamCraftInfo.subscribed

The subscribed state of the item.

UInt64 KSP.UI.Screens.SteamCraftInfo.totalFavorites

The total number of Steam Favourites for the item

UInt64 KSP.UI.Screens.SteamCraftInfo.totalFollowers

The total number of Steam followers for the item

UInt64 KSP.UI.Screens.SteamCraftInfo.totalSubscriptions

The total number of Steam Subscriptions for the item

string KSP.UI.Screens.SteamCraftInfo.vesselType

The VesselType from the Steam Workshop MetaData


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