Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
METutorialScenario Class Reference
Inheritance diagram for METutorialScenario:
TutorialScenario ScenarioModule IConfigNode AdvancedTutorial BasicTutorial IntermediateTutorial

Classes

class  NodeTemplateName
 used to access node with template name based on : MENode.basicNodeSource More...
 

Public Types

enum  NodeDefinition {
  NodeDefinition.None = -1, NodeDefinition.StartNode = 0, NodeDefinition.CreateVessel = 1, NodeDefinition.Orbit = 2,
  NodeDefinition.VesselLanded = 3, NodeDefinition.ScienceExperiment = 4, NodeDefinition.DialogMessage = 5, NodeDefinition.DialogMessage2 = 6,
  NodeDefinition.VesselLanded2 = 7, NodeDefinition.TimeSinceNode = 8, NodeDefinition.ApplyScore = 9, NodeDefinition.Count
}
 used to access node with index based on : MissionEditorLogic.Instance.GetDisplayedNodes[(int)NodeDefinition] More...
 
enum  TutorialButtonType {
  TutorialButtonType.NoButton = 0x00, TutorialButtonType.Next = 0x01, TutorialButtonType.Ok = 0x02, TutorialButtonType.Done = 0x04,
  TutorialButtonType.Continue = 0x08
}
 bitwise expression More...
 

Public Member Functions

bool CanSkipCurrentTutorialOnNodeDragEnd (int countBeforeDrag)
 
void ClearFilter ()
 
void DragNodeHelper (Func< MEGUINodeIcon, bool > filterCriteria, string categoryName="")
 
void EnableAllTutorialPageButtons (bool enable)
 
void FilterNodes (bool add)
 
void FilterNodes (bool add, Func< MEGUINodeIcon, bool > criteria)
 
MEGUIParameter GetApplyScoreScoreParam ()
 
MEGUIParameter GetDialogMessageParam ()
 
MEGUIParameter GetFacilityParam ()
 
MEGUINode GetMEGUINode (int nodeIndex)
 
int GetMEGUINodeIndex (MEGUINode guiNode)
 
List< MEGUINode > GetMEGUINodes (string templateName)
 
MENode GetMENode (int nodeIndex)
 
List< MENode > GetMENodeByTemplateName (string nodeDefinition)
 
MEGUIParameter GetOrbitCelestialBody ()
 
MEGUIParameter GetScienceCelestialBodyParam ()
 
MEGUIParameter GetScienceExperimentParam ()
 
MEGUIParameter GetScienceIsEventNodeParam ()
 
MEGUIParameter GetScienceSituationParam ()
 
MEGUINode GetSelectedMEGUINode ()
 
MENode GetSelectedMENode ()
 
int GetSelectedNodeIndex ()
 
string GetSelectedNodeTemplateName ()
 
MEGUIParameter GetSituationParam ()
 
MEGUIParameter GetTimeNodeOperator ()
 
MEGUIParameter GetTimeNodeStartNode ()
 
MEGUIParameter GetTimeNodeTime ()
 
MEGUIParameter GetVesselDestroyedVesselParam ()
 
MEGUIParameter GetVesselLandedBiomes ()
 
MEGUIParameter GetVesselLandedCelestialBody ()
 
MEGUIParameter GetVesselLandedLocationType ()
 
MEGUIParameter GetVesselLandedSettings ()
 
MEGUIParameter GetVesselSettings ()
 
void HideAllTutorialSelectors ()
 
void HideTutorialSelection (MEGUIParameter parameter)
 
void HighlightNodeFiltered (bool highLight)
 
void LockCanvas (bool locked)
 
void LockNodeFilter (bool locked)
 
void LockNodeList (bool locked)
 
void LockNodeSettings (bool locked)
 
void LockSapParameters (NodeDefinition nodedefinition, params string[] excluded)
 
void RemoveDragHelper ()
 
void RemoveOnClickOnSearchListener ()
 Remove the searchFieldClickHandler.onPointerClick event More...
 
void ResetHighLightLink ()
 
void ResetNodeFilterMask ()
 
void ResetNodeListMask ()
 
void ResetNodeSettingsMask ()
 
void RestoreOnClickOnSearchListener ()
 Restore the searchFieldClickHandler.onPointerClick event More...
 
void SaveOnClickOnSearchListener ()
 Save the searchFieldClickHandler.onPointerClick event More...
 
void SetEditorLock ()
 
void ShowTutorialSelection (MEGUIParameter parameter)
 
- Public Member Functions inherited from ScenarioModule
void Load (ConfigNode node)
 
virtual void OnAwake ()
 
virtual void OnLoad (ConfigNode node)
 
virtual void OnSave (ConfigNode node)
 
void Save (ConfigNode node)
 

Public Attributes

bool complete
 
const string dialogMessageParam = "Expansions.Missions.Actions.ActionDialogMessage.message"
 
string lockId = "tutorial"
 
string stateName = "welcome"
 
- Public Attributes inherited from TutorialScenario
bool ExclusiveTutorial = true
 
string guiSkinName = "KSP window 1"
 
KerbalInstructor instructor
 
int instructorPortraitSize = 128
 
string instructorPrefabName = "Instructor_Wernher"
 
RenderTexture instructorTexture
 
GameObject mainlight
 
int textureBorderRadius = 124
 
string tutorialArrowPrefabName = "tutorialArrows"
 
string tutorialControlColorString = "#BADA55"
 
string tutorialHighlightColorString = "orange"
 
- Public Attributes inherited from ScenarioModule
ScenarioRunner runner
 
ProtoScenarioModule snapshot
 
List< GameScenes > targetScenes
 

Protected Member Functions

TutorialPage AddTutorialPage (string pageId, string pageTitleLocId, string dialogLocId, KFSMStateChange onEnterCallback, BasicTutorial.TutorialButtonType pageType=BasicTutorial.TutorialButtonType.Next)
 
List< TutorialPage > AddTutorialPage (TutorialPageConfig config)
 
MultiOptionDialog CreateDialog (BasicTutorial.TutorialButtonType pageType, string pageId, string loc)
 
virtual void CreateTutorialPages ()
 
void DestroyTutorialPage (TutorialPage page)
 
void EnableTutorialPageButton (bool enable, int index)
 
DialogGUIButton[] FindButtons (ref DialogGUIBase[] buttons)
 
MEGUIParameter GetLaunchSiteParam ()
 
virtual string GetNextTutorialName ()
 
MEGUIParameter GetParameter (string fieldid)
 
MEGUIParameter GetPartPickerParam ()
 
MEGUIParameter GetSubParameter (List< string > fieldsId)
 
virtual void GoToNextTutorial ()
 
void HighlightNode (int nodeIndex, bool active)
 
bool IsTutorialParameterSelected (MEGUIParameter parameter)
 
override void OnAssetSetup ()
 This is called before the tutorial assets are set up. Use this to change the asset settings on subclasses More...
 
void OnEnterEmpty (KFSMState state)
 
override void OnOnDestroy ()
 
override void OnTutorialSetup ()
 
- Protected Member Functions inherited from TutorialScenario
void CloseTutorialWindow (bool destroySelf=true)
 
DialogGUIBase[] CreateDialog (string pageId, string textLoc, DialogGUIButton button)
 
DialogGUIBase[] CreateDialog (string pageId, string textLoc, DialogGUIButton[] button)
 
DialogGUIBase[] CreateDialog (string pageId, string textLoc)
 
MultiOptionDialog CreateDoneDialog (string pageId, string textLoc)
 
MultiOptionDialog CreateMultiButtonDialog (string pageId, string textLoc, BasicTutorial.TutorialButtonType buttons)
 
MultiOptionDialog CreateNextDialog (string pageId, string textLoc)
 
MultiOptionDialog CreateNoButtonDialog (string pageId, string textLoc)
 
MultiOptionDialog CreateOkDialog (string pageId, string textLoc)
 
TutorialPage CreateTutorialPage (string pageId, string titleLoc, KFSMStateChange onEnterCallback)
 
string GetCurrentStateName ()
 
virtual void OnCloseButtonClick ()
 
virtual void OnContinueButtonClick ()
 
virtual void OnDoneButtonClick ()
 
virtual void OnNextButtonClick ()
 
virtual void OnOkButtonClick ()
 
void SetDialogRect (Rect r)
 

Static Protected Member Functions

static void ShowMissionPlayDialog ()
 
- Static Protected Member Functions inherited from TutorialScenario
static ConfigNode GetTutorialNode (string name)
 

Protected Attributes

const string applyScoreScoreParam = "Expansions.Missions.Actions.ActionMissionScore.score"
 
const string createVesselFacilityParam = "facility"
 
const string createVesselLaunchSiteParam = "launchSite"
 
const string createVesselLocationSettings = "location"
 
const string createVesselPartPicker = "requiredParts"
 
const string createVesselSettings = "Expansions.Missions.Actions.ActionCreateVessel.vesselSituation"
 
const string createVesselSituationParam = "situation"
 
const string orbitCelestialBodyParam = "Expansions.Missions.Tests.TestOrbit.missionOrbit"
 
const string scienceCelestialBody = "Expansions.Missions.Tests.TestScienceExperiment.biomeData"
 
const string scienceExperimentIsEventNode = "Expansions.Missions.MENode.isEvent"
 
const string scienceExperimentParam = "Expansions.Missions.Tests.TestScienceExperiment.experimentID"
 
const string scienceSituationParam = "Expansions.Missions.Tests.TestScienceExperiment.experimentSituation"
 
const string timeNodeNodeParam = "Expansions.Missions.Tests.TestTimeSinceNode.nodeID"
 
const string timeNodeOperatorParam = "Expansions.Missions.Tests.TestTimeSinceNode.comparisonOperator"
 
const string timeNodeTimeParam = "Expansions.Missions.Tests.TestTimeSinceNode.time"
 
MEBasicNodeListFilter
< MEGUINodeIcon > 		tutorialFilter_none = new MEBasicNodeListFilter<MEGUINodeIcon>("tutorial_None", a => false)
 
List< TutorialPage > tutorialPages
 
const string vesselDestroyedVesselParam = "Expansions.Missions.Tests.TestVessel.vesselID"
 
const string vesselLandedCelestialBiomeParam = "biomeData"
 
const string vesselLandedCelestialBodyParam = "bodyData"
 
const string vesselLandedLocationTypeParam = "locationChoice"
 
const string vesselLandedSettings = "Expansions.Missions.Tests.TestVesselSituationLanded.locationSituation"
 
- Protected Attributes inherited from TutorialScenario
Rect avatarRect
 
TutorialPage currentPage
 
PopupDialog dialogDisplay
 
Rect dRect
 
Rect rect = new Rect(100f, 80f, 400f, 180f)
 
UISkinDef skin
 
TutorialFSM Tutorial
 
bool TutorialDialogEnabled = true
 If this is an "exclusive" tutorial, or if it is an advisory popup in a normal game. More...
 

Additional Inherited Members

- Properties inherited from ScenarioModule
int ClassID [get]
 
string ClassName [get]
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 

Member Enumeration Documentation

enum METutorialScenario.NodeDefinition

used to access node with index based on : MissionEditorLogic.Instance.GetDisplayedNodes[(int)NodeDefinition]

Enumerator
None 
StartNode 
CreateVessel 
Orbit 
VesselLanded 
ScienceExperiment 
DialogMessage 
DialogMessage2 
VesselLanded2 
TimeSinceNode 
ApplyScore 
Count 
enum METutorialScenario.TutorialButtonType

bitwise expression

Enumerator
NoButton 
Next 
Ok 
Done 
Continue 

Member Function Documentation

TutorialPage METutorialScenario.AddTutorialPage ( string  pageId,
string  pageTitleLocId,
string  dialogLocId,
KFSMStateChange  onEnterCallback,
BasicTutorial.TutorialButtonType  pageType = BasicTutorial.TutorialButtonType.Next 
)
inlineprotected
List<TutorialPage> METutorialScenario.AddTutorialPage ( TutorialPageConfig  config)
inlineprotected
bool METutorialScenario.CanSkipCurrentTutorialOnNodeDragEnd ( int  countBeforeDrag)
inline
void METutorialScenario.ClearFilter ( )
inline
MultiOptionDialog METutorialScenario.CreateDialog ( BasicTutorial.TutorialButtonType  pageType,
string  pageId,
string  loc 
)
inlineprotected
virtual void METutorialScenario.CreateTutorialPages ( )
inlineprotectedvirtual

Reimplemented in AdvancedTutorial, BasicTutorial, and IntermediateTutorial.

void METutorialScenario.DestroyTutorialPage ( TutorialPage  page)
inlineprotected
void METutorialScenario.DragNodeHelper ( Func< MEGUINodeIcon, bool >  filterCriteria,
string  categoryName = "" 
)
inline
void METutorialScenario.EnableAllTutorialPageButtons ( bool  enable)
inline
void METutorialScenario.EnableTutorialPageButton ( bool  enable,
int  index 
)
inlineprotected
void METutorialScenario.FilterNodes ( bool  add)
inline
void METutorialScenario.FilterNodes ( bool  add,
Func< MEGUINodeIcon, bool >  criteria 
)
inline
DialogGUIButton [] METutorialScenario.FindButtons ( ref DialogGUIBase[]  buttons)
inlineprotected
MEGUIParameter METutorialScenario.GetApplyScoreScoreParam ( )
inline
MEGUIParameter METutorialScenario.GetDialogMessageParam ( )
inline
MEGUIParameter METutorialScenario.GetFacilityParam ( )
inline
MEGUIParameter METutorialScenario.GetLaunchSiteParam ( )
inlineprotected
MEGUINode METutorialScenario.GetMEGUINode ( int  nodeIndex)
inline
int METutorialScenario.GetMEGUINodeIndex ( MEGUINode  guiNode)
inline
List<MEGUINode> METutorialScenario.GetMEGUINodes ( string  templateName)
inline
MENode METutorialScenario.GetMENode ( int  nodeIndex)
inline
List<MENode> METutorialScenario.GetMENodeByTemplateName ( string  nodeDefinition)
inline
virtual string METutorialScenario.GetNextTutorialName ( )
inlineprotectedvirtual

Reimplemented in BasicTutorial, and IntermediateTutorial.

MEGUIParameter METutorialScenario.GetOrbitCelestialBody ( )
inline
MEGUIParameter METutorialScenario.GetParameter ( string  fieldid)
inlineprotected
MEGUIParameter METutorialScenario.GetPartPickerParam ( )
inlineprotected
MEGUIParameter METutorialScenario.GetScienceCelestialBodyParam ( )
inline
MEGUIParameter METutorialScenario.GetScienceExperimentParam ( )
inline
MEGUIParameter METutorialScenario.GetScienceIsEventNodeParam ( )
inline
MEGUIParameter METutorialScenario.GetScienceSituationParam ( )
inline
MEGUINode METutorialScenario.GetSelectedMEGUINode ( )
inline
MENode METutorialScenario.GetSelectedMENode ( )
inline
int METutorialScenario.GetSelectedNodeIndex ( )
inline
string METutorialScenario.GetSelectedNodeTemplateName ( )
inline
MEGUIParameter METutorialScenario.GetSituationParam ( )
inline
MEGUIParameter METutorialScenario.GetSubParameter ( List< string >  fieldsId)
inlineprotected
MEGUIParameter METutorialScenario.GetTimeNodeOperator ( )
inline
MEGUIParameter METutorialScenario.GetTimeNodeStartNode ( )
inline
MEGUIParameter METutorialScenario.GetTimeNodeTime ( )
inline
MEGUIParameter METutorialScenario.GetVesselDestroyedVesselParam ( )
inline
MEGUIParameter METutorialScenario.GetVesselLandedBiomes ( )
inline
MEGUIParameter METutorialScenario.GetVesselLandedCelestialBody ( )
inline
MEGUIParameter METutorialScenario.GetVesselLandedLocationType ( )
inline
MEGUIParameter METutorialScenario.GetVesselLandedSettings ( )
inline
MEGUIParameter METutorialScenario.GetVesselSettings ( )
inline
virtual void METutorialScenario.GoToNextTutorial ( )
inlineprotectedvirtual
void METutorialScenario.HideAllTutorialSelectors ( )
inline
void METutorialScenario.HideTutorialSelection ( MEGUIParameter  parameter)
inline
void METutorialScenario.HighlightNode ( int  nodeIndex,
bool  active 
)
inlineprotected
void METutorialScenario.HighlightNodeFiltered ( bool  highLight)
inline
bool METutorialScenario.IsTutorialParameterSelected ( MEGUIParameter  parameter)
inlineprotected
void METutorialScenario.LockCanvas ( bool  locked)
inline
void METutorialScenario.LockNodeFilter ( bool  locked)
inline
void METutorialScenario.LockNodeList ( bool  locked)
inline
void METutorialScenario.LockNodeSettings ( bool  locked)
inline
void METutorialScenario.LockSapParameters ( NodeDefinition  nodedefinition,
params string[]  excluded 
)
inline
override void METutorialScenario.OnAssetSetup ( )
inlineprotectedvirtual

This is called before the tutorial assets are set up. Use this to change the asset settings on subclasses

Reimplemented from TutorialScenario.

void METutorialScenario.OnEnterEmpty ( KFSMState  state)
inlineprotected
override void METutorialScenario.OnOnDestroy ( )
inlineprotectedvirtual

Reimplemented from TutorialScenario.

override void METutorialScenario.OnTutorialSetup ( )
inlineprotectedvirtual

Reimplemented from TutorialScenario.

void METutorialScenario.RemoveDragHelper ( )
inline
void METutorialScenario.RemoveOnClickOnSearchListener ( )
inline

Remove the searchFieldClickHandler.onPointerClick event

void METutorialScenario.ResetHighLightLink ( )
inline
void METutorialScenario.ResetNodeFilterMask ( )
inline
void METutorialScenario.ResetNodeListMask ( )
inline
void METutorialScenario.ResetNodeSettingsMask ( )
inline
void METutorialScenario.RestoreOnClickOnSearchListener ( )
inline

Restore the searchFieldClickHandler.onPointerClick event

void METutorialScenario.SaveOnClickOnSearchListener ( )
inline

Save the searchFieldClickHandler.onPointerClick event

void METutorialScenario.SetEditorLock ( )
inline
static void METutorialScenario.ShowMissionPlayDialog ( )
inlinestaticprotected
void METutorialScenario.ShowTutorialSelection ( MEGUIParameter  parameter)
inline

Member Data Documentation

const string METutorialScenario.applyScoreScoreParam = "Expansions.Missions.Actions.ActionMissionScore.score"
protected
bool METutorialScenario.complete
const string METutorialScenario.createVesselFacilityParam = "facility"
protected
const string METutorialScenario.createVesselLaunchSiteParam = "launchSite"
protected
const string METutorialScenario.createVesselLocationSettings = "location"
protected
const string METutorialScenario.createVesselPartPicker = "requiredParts"
protected
const string METutorialScenario.createVesselSettings = "Expansions.Missions.Actions.ActionCreateVessel.vesselSituation"
protected
const string METutorialScenario.createVesselSituationParam = "situation"
protected
const string METutorialScenario.dialogMessageParam = "Expansions.Missions.Actions.ActionDialogMessage.message"
string METutorialScenario.lockId = "tutorial"
const string METutorialScenario.orbitCelestialBodyParam = "Expansions.Missions.Tests.TestOrbit.missionOrbit"
protected
const string METutorialScenario.scienceCelestialBody = "Expansions.Missions.Tests.TestScienceExperiment.biomeData"
protected
const string METutorialScenario.scienceExperimentIsEventNode = "Expansions.Missions.MENode.isEvent"
protected
const string METutorialScenario.scienceExperimentParam = "Expansions.Missions.Tests.TestScienceExperiment.experimentID"
protected
const string METutorialScenario.scienceSituationParam = "Expansions.Missions.Tests.TestScienceExperiment.experimentSituation"
protected
string METutorialScenario.stateName = "welcome"
const string METutorialScenario.timeNodeNodeParam = "Expansions.Missions.Tests.TestTimeSinceNode.nodeID"
protected
const string METutorialScenario.timeNodeOperatorParam = "Expansions.Missions.Tests.TestTimeSinceNode.comparisonOperator"
protected
const string METutorialScenario.timeNodeTimeParam = "Expansions.Missions.Tests.TestTimeSinceNode.time"
protected
MEBasicNodeListFilter<MEGUINodeIcon> METutorialScenario.tutorialFilter_none = new MEBasicNodeListFilter<MEGUINodeIcon>("tutorial_None", a => false)
protected
List<TutorialPage> METutorialScenario.tutorialPages
protected
const string METutorialScenario.vesselDestroyedVesselParam = "Expansions.Missions.Tests.TestVessel.vesselID"
protected
const string METutorialScenario.vesselLandedCelestialBiomeParam = "biomeData"
protected
const string METutorialScenario.vesselLandedCelestialBodyParam = "bodyData"
protected
const string METutorialScenario.vesselLandedLocationTypeParam = "locationChoice"
protected
const string METutorialScenario.vesselLandedSettings = "Expansions.Missions.Tests.TestVesselSituationLanded.locationSituation"
protected
The documentation for this class was generated from the following file:
API Download: HTML | XML
Generated on Tue Nov 1 2022 18:36:06 for Kerbal Space Program by   doxygen 1.8.7