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 | Properties | List of all members
Expansions.Missions.Editor.MissionEditorValidator Class Reference
Inheritance diagram for Expansions.Missions.Editor.MissionEditorValidator:

Public Member Functions

void AddNodeFail (MENode node, string message)
 
void AddNodePass (MENode node, string message)
 Add a result for a node More...
 
void AddNodeResult (MENode node, ValidationStatus result, string message)
 Add a result for a node More...
 
void AddNodeWarn (MENode node, string message)
 
void AddResults (List< MissionValidationTestResult > results)
 Add a list of results More...
 

Static Public Member Functions

static Color GetStatusColor ()
 Get the color based on validation status More...
 
static Color GetValidationColor (ValidationStatus status)
 Get the Validation Color from the instance values More...
 
static ValidatorMode NextMode ()
 
static void ResetValidator ()
 Call this to reset the instance values More...
 
static void RunValidation (Mission mission)
 Parse the mission and find any issues More...
 
static void RunValidationOnParamChange ()
 This one is called by parameter level changes and then runs the validator if the Mode settings say its good to go More...
 

Public Attributes

bool highlightGUINodes = true
 Should we highlight the GUINodes with the colored bix on validation checks More...
 

Properties

static MissionEditorValidator Instance [get, set]
 Singleton for this object More...
 
bool IsValid [get]
 Returns true if there are no validation issues in the list More...
 
Mission Mission [get, set]
 The mission that was validated More...
 
static ValidatorMode Mode [get]
 
List< MissionValidationTestResultResults [get, set]
 The list of results from the validation More...
 
ValidationStatus Status [get]
 Return the Worst status for the validator as a combined value More...
 

Member Function Documentation

void Expansions.Missions.Editor.MissionEditorValidator.AddNodeFail ( MENode  node,
string  message 
)
inline
void Expansions.Missions.Editor.MissionEditorValidator.AddNodePass ( MENode  node,
string  message 
)
inline

Add a result for a node

Helper function to save some typing

Parameters
nodeNode for the test
resultstatus of the message
messagemessage to store
void Expansions.Missions.Editor.MissionEditorValidator.AddNodeResult ( MENode  node,
ValidationStatus  result,
string  message 
)
inline

Add a result for a node

Helper function to save some typing

Parameters
nodeNode for the test
resulttrue is passed
messagemessage to store for a pass
void Expansions.Missions.Editor.MissionEditorValidator.AddNodeWarn ( MENode  node,
string  message 
)
inline
void Expansions.Missions.Editor.MissionEditorValidator.AddResults ( List< MissionValidationTestResult results)
inline

Add a list of results

Parameters
resultsthe list
static Color Expansions.Missions.Editor.MissionEditorValidator.GetStatusColor ( )
inlinestatic

Get the color based on validation status

Used for the validation report button

Returns
Color to tint button icon
static Color Expansions.Missions.Editor.MissionEditorValidator.GetValidationColor ( ValidationStatus  status)
inlinestatic

Get the Validation Color from the instance values

Parameters
statusstatus to get the color for
Returns
static ValidatorMode Expansions.Missions.Editor.MissionEditorValidator.NextMode ( )
inlinestatic
static void Expansions.Missions.Editor.MissionEditorValidator.ResetValidator ( )
inlinestatic

Call this to reset the instance values

static void Expansions.Missions.Editor.MissionEditorValidator.RunValidation ( Mission  mission)
inlinestatic

Parse the mission and find any issues

Parameters
highlightGUINodesTrue to turn on the validation gui elements in the mission
static void Expansions.Missions.Editor.MissionEditorValidator.RunValidationOnParamChange ( )
inlinestatic

This one is called by parameter level changes and then runs the validator if the Mode settings say its good to go

Member Data Documentation

bool Expansions.Missions.Editor.MissionEditorValidator.highlightGUINodes = true

Should we highlight the GUINodes with the colored bix on validation checks

Property Documentation

MissionEditorValidator Expansions.Missions.Editor.MissionEditorValidator.Instance
staticgetset

Singleton for this object

bool Expansions.Missions.Editor.MissionEditorValidator.IsValid
get

Returns true if there are no validation issues in the list

Mission Expansions.Missions.Editor.MissionEditorValidator.Mission
getset

The mission that was validated

ValidatorMode Expansions.Missions.Editor.MissionEditorValidator.Mode
staticget
List<MissionValidationTestResult> Expansions.Missions.Editor.MissionEditorValidator.Results
getset

The list of results from the validation

ValidationStatus Expansions.Missions.Editor.MissionEditorValidator.Status
get

Return the Worst status for the validator as a combined value


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