Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | List of all members
Expansions.Missions.VesselSituation Class Reference

Contains the Start Situation for a vessel in a mission More...

Inheritance diagram for Expansions.Missions.VesselSituation:
IConfigNode

Public Member Functions

void ClearEditorEvents ()
 
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 
void SetCrewAvailable (KerbalRoster crewRoster)
 Will set the Roster Status in the passed in crewRoster to available for all crew for this vessel. Used for when Switching vessels in the Editor scene and when remaining in the editor scene when all player built vessels are completed. More...
 
void SetVesselCrew (KerbalRoster crewRoster, VesselCrewManifest newCrew)
 Takes a VesselCrewManifest, Updates the vesselCrew list with the crew information. Also upates the KerbalRoster to set the crew in the VCM to assigned status. More...
 
void StartEditorEvents ()
 
void UpdateAutoGenerateCrewSettings (bool newValue)
 Update the auto generate crew settings from the global flag More...
 
void UpdateRequiredPartsDisplayedParts ()
 Update the parts displayed in the required parts parameter. We use this to update the parts list because an undo has caused the parameter controlling the excluded parts to update and we need to update those grey boxes! More...
 
 VesselSituation ()
 
 VesselSituation (Mission mission, MENode node)
 

Public Attributes

bool autoGenerateCrew = false
 Specifies if should autogenerate a crew list for the vessels or not, if not you need to specify a crew list More...
 
string craftFile = ""
 filename of the craft file More...
 
bool focusonSpawn
 Change active vessel to this vessel when it spawns. Only valid for vessels not attached to the Mission Start Node. More...
 
VesselLocation location
 The Vessel's Location parameters More...
 
Mission mission
 The Mission this Situation belongs to. More...
 
MENode node
 The node this Situation belongs to. More...
 
MissionPartFilter partFilter
 Part filter applied to this vessel More...
 
uint persistentId = 0
 This is the vessel's perisistentId More...
 
bool playerCreated = true
 True if the vessel is to be Mission Player created. False if the vessel is Mission Creator created. More...
 
List< string > requiredParts
 List of parts required for this vessel More...
 
List< CrewvesselCrew
 This is a List of assigned crew per part in the vessel. More...
 
string vesselDescription = ""
 A description field that is shown in the missions app for player created vessels to give some context to the mission player. More...
 
string vesselName = "#autoLOC_8100086"
 The Vessel's Name More...
 
VesselRestrictionList vesselRestrictionList
 This is the Vessel Restrictions List for building player built vessels specified by the mission creator. More...
 

Detailed Description

Contains the Start Situation for a vessel in a mission

Constructor & Destructor Documentation

Expansions.Missions.VesselSituation.VesselSituation ( )
inline
Expansions.Missions.VesselSituation.VesselSituation ( Mission  mission,
MENode  node 
)
inline

Member Function Documentation

void Expansions.Missions.VesselSituation.ClearEditorEvents ( )
inline
void Expansions.Missions.VesselSituation.Load ( ConfigNode  node)
inline

Implements IConfigNode.

void Expansions.Missions.VesselSituation.Save ( ConfigNode  node)
inline

Implements IConfigNode.

void Expansions.Missions.VesselSituation.SetCrewAvailable ( KerbalRoster  crewRoster)
inline

Will set the Roster Status in the passed in crewRoster to available for all crew for this vessel. Used for when Switching vessels in the Editor scene and when remaining in the editor scene when all player built vessels are completed.

Parameters
crewRoster
void Expansions.Missions.VesselSituation.SetVesselCrew ( KerbalRoster  crewRoster,
VesselCrewManifest  newCrew 
)
inline

Takes a VesselCrewManifest, Updates the vesselCrew list with the crew information. Also upates the KerbalRoster to set the crew in the VCM to assigned status.

Parameters
crewRosterThe KerbalRoster to update.
newCrewThe new VesselCrewManifest of crew assignments
void Expansions.Missions.VesselSituation.StartEditorEvents ( )
inline
void Expansions.Missions.VesselSituation.UpdateAutoGenerateCrewSettings ( bool  newValue)
inline

Update the auto generate crew settings from the global flag

Parameters
newValue
void Expansions.Missions.VesselSituation.UpdateRequiredPartsDisplayedParts ( )
inline

Update the parts displayed in the required parts parameter. We use this to update the parts list because an undo has caused the parameter controlling the excluded parts to update and we need to update those grey boxes!

Member Data Documentation

bool Expansions.Missions.VesselSituation.autoGenerateCrew = false

Specifies if should autogenerate a crew list for the vessels or not, if not you need to specify a crew list

string Expansions.Missions.VesselSituation.craftFile = ""

filename of the craft file

we dont need the full path as we store a ref to the Mission object

bool Expansions.Missions.VesselSituation.focusonSpawn

Change active vessel to this vessel when it spawns. Only valid for vessels not attached to the Mission Start Node.

VesselLocation Expansions.Missions.VesselSituation.location

The Vessel's Location parameters

Mission Expansions.Missions.VesselSituation.mission

The Mission this Situation belongs to.

MENode Expansions.Missions.VesselSituation.node

The node this Situation belongs to.

MissionPartFilter Expansions.Missions.VesselSituation.partFilter

Part filter applied to this vessel

uint Expansions.Missions.VesselSituation.persistentId = 0

This is the vessel's perisistentId

bool Expansions.Missions.VesselSituation.playerCreated = true

True if the vessel is to be Mission Player created. False if the vessel is Mission Creator created.

List<string> Expansions.Missions.VesselSituation.requiredParts

List of parts required for this vessel

List<Crew> Expansions.Missions.VesselSituation.vesselCrew

This is a List of assigned crew per part in the vessel.

string Expansions.Missions.VesselSituation.vesselDescription = ""

A description field that is shown in the missions app for player created vessels to give some context to the mission player.

string Expansions.Missions.VesselSituation.vesselName = "#autoLOC_8100086"

The Vessel's Name

VesselRestrictionList Expansions.Missions.VesselSituation.vesselRestrictionList

This is the Vessel Restrictions List for building player built vessels specified by the mission creator.


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