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

Public Types

enum  NodeDefinition {
  NodeDefinition.None = -1, NodeDefinition.StartNode, NodeDefinition.CreateVessel, NodeDefinition.VesselLandedKerbin = 8,
  NodeDefinition.VesselLandedMun, NodeDefinition.VesselDestroyed, NodeDefinition.DialogMessage1, NodeDefinition.DialogMessage2,
  NodeDefinition.DialogMessage3
}
 
enum  TutorialStep {
  TutorialStep.none = -1, TutorialStep.welcome, TutorialStep.crewStep1_intro, TutorialStep.crewStep2_clickCreateVesselNode,
  TutorialStep.crewStep3a_clickAdd, TutorialStep.crewStep3b_clickAdd, TutorialStep.crewStep4a_crewEqual2, TutorialStep.crewStep4b_crewEqual2,
  TutorialStep.crewStep5_exit, TutorialStep.partStep1_intro, TutorialStep.partStep2a_clickRequiredPart, TutorialStep.partStep2b_clickRequiredPart,
  TutorialStep.partStep3a_selectMysteryGoo, TutorialStep.partStep3b_selectMysteryGoo, TutorialStep.vesselStep1_intro, TutorialStep.vesselStep2a_dragVesselNode,
  TutorialStep.vesselStep2b_dragVesselNode, TutorialStep.vesselStep3a_selectVesselName, TutorialStep.vesselStep3b_selectVesselName, TutorialStep.vesselStep4a_dragDialogMessage,
  TutorialStep.vesselStep4b_dragDialogMessage, TutorialStep.vesselStep5a_writeMessage, TutorialStep.vesselStep5b_writeMessage, TutorialStep.vesselStep6a_linkVesselDestroyed,
  TutorialStep.vesselStep6b_linkVesselDestroyed, TutorialStep.vesselStep7a_drag2DialogMessage, TutorialStep.vesselStep7b_drag2DialogMessage, TutorialStep.vesselStep8a_linkDialogMessage,
  TutorialStep.vesselStep8b_linkDialogMessage, TutorialStep.vesselStep9a_writeMessage, TutorialStep.vesselStep9b_writeMessage, TutorialStep.validationStep1_intro,
  TutorialStep.validationStep2_misisonError, TutorialStep.validationStep3a_clickRedDot, TutorialStep.validationStep3b_clickRedDot, TutorialStep.validationStep4_markEndNode,
  TutorialStep.validationStep5a_setAsEndNode, TutorialStep.validationStep5b_setAsEndNode, TutorialStep.exportingStep1_intro, TutorialStep.exportingStep2a_clickExport,
  TutorialStep.exportingStep2b_clickExport, TutorialStep.exportingStep3_award, TutorialStep.exportingStep4_mods, TutorialStep.exportingStep5_banners,
  TutorialStep.conclusion_exit
}
 
- Public Types inherited from METutorialScenario
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...
 

Protected Member Functions

override void CreateTutorialPages ()
 
override void OnDoneButtonClick ()
 
override void OnTutorialSetup ()
 
- Protected Member Functions inherited from METutorialScenario
TutorialPage AddTutorialPage (string pageId, string pageTitleLocId, string dialogLocId, KFSMStateChange onEnterCallback, BasicTutorial.TutorialButtonType pageType=BasicTutorial.TutorialButtonType.Next)
 
List< TutorialPageAddTutorialPage (TutorialPageConfig config)
 
MultiOptionDialog CreateDialog (BasicTutorial.TutorialButtonType pageType, string pageId, string loc)
 
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 OnNextButtonClick ()
 
virtual void OnOkButtonClick ()
 
void SetDialogRect (Rect r)
 

Additional Inherited Members

- Public Member Functions inherited from METutorialScenario
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< MEGUINodeGetMEGUINodes (string templateName)
 
MENode GetMENode (int nodeIndex)
 
List< MENodeGetMENodeByTemplateName (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 inherited from METutorialScenario
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< GameScenestargetScenes
 
- Static Protected Member Functions inherited from METutorialScenario
static void ShowMissionPlayDialog ()
 
- Static Protected Member Functions inherited from TutorialScenario
static ConfigNode GetTutorialNode (string name)
 
- Protected Attributes inherited from METutorialScenario
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< TutorialPagetutorialPages
 
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...
 
- Properties inherited from ScenarioModule
int ClassID [get]
 
string ClassName [get]
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 

Member Enumeration Documentation

Enumerator
None 
StartNode 
CreateVessel 
VesselLandedKerbin 
VesselLandedMun 
VesselDestroyed 
DialogMessage1 
DialogMessage2 
DialogMessage3 
Enumerator
none 
welcome 
crewStep1_intro 
crewStep2_clickCreateVesselNode 
crewStep3a_clickAdd 
crewStep3b_clickAdd 
crewStep4a_crewEqual2 
crewStep4b_crewEqual2 
crewStep5_exit 
partStep1_intro 
partStep2a_clickRequiredPart 
partStep2b_clickRequiredPart 
partStep3a_selectMysteryGoo 
partStep3b_selectMysteryGoo 
vesselStep1_intro 
vesselStep2a_dragVesselNode 
vesselStep2b_dragVesselNode 
vesselStep3a_selectVesselName 
vesselStep3b_selectVesselName 
vesselStep4a_dragDialogMessage 
vesselStep4b_dragDialogMessage 
vesselStep5a_writeMessage 
vesselStep5b_writeMessage 
vesselStep6a_linkVesselDestroyed 
vesselStep6b_linkVesselDestroyed 
vesselStep7a_drag2DialogMessage 
vesselStep7b_drag2DialogMessage 
vesselStep8a_linkDialogMessage 
vesselStep8b_linkDialogMessage 
vesselStep9a_writeMessage 
vesselStep9b_writeMessage 
validationStep1_intro 
validationStep2_misisonError 
validationStep3a_clickRedDot 
validationStep3b_clickRedDot 
validationStep4_markEndNode 
validationStep5a_setAsEndNode 
validationStep5b_setAsEndNode 
exportingStep1_intro 
exportingStep2a_clickExport 
exportingStep2b_clickExport 
exportingStep3_award 
exportingStep4_mods 
exportingStep5_banners 
conclusion_exit 

Member Function Documentation

override void AdvancedTutorial.CreateTutorialPages ( )
inlineprotectedvirtual

Reimplemented from METutorialScenario.

override void AdvancedTutorial.OnDoneButtonClick ( )
inlineprotectedvirtual

Reimplemented from TutorialScenario.

override void AdvancedTutorial.OnTutorialSetup ( )
inlineprotectedvirtual

Reimplemented from TutorialScenario.


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