Kerbal Space Program  1.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
TutorialScenario Class Reference
Inheritance diagram for TutorialScenario:
ScenarioModule IConfigNode METutorialScenario MissionScreenTutorial ScenarioNewGameIntro TutorialAscent TutorialAsteroid1 TutorialAsteroid2 TutorialDemo TutorialDocking TutorialDuna TutorialEditor TutorialEditorAdvanced TutorialEditorMid TutorialFlightBasics TutorialFlightSuborbital TutorialFromMun TutorialMunDescent TutorialMunFlight1 TutorialOrbit101 TutorialScience

Classes

class  TutorialFSM
 
class  TutorialPage
 

Public Attributes

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
 

Protected Member Functions

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 OnAssetSetup ()
 This is called before the tutorial assets are set up. Use this to change the asset settings on subclasses More...
 
virtual void OnCloseButtonClick ()
 
virtual void OnContinueButtonClick ()
 
virtual void OnDoneButtonClick ()
 
virtual void OnNextButtonClick ()
 
virtual void OnOkButtonClick ()
 
virtual void OnOnDestroy ()
 
virtual void OnTutorialSetup ()
 
void SetDialogRect (Rect r)
 

Static Protected Member Functions

static ConfigNode GetTutorialNode (string name)
 

Protected Attributes

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

- 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)
 
- Properties inherited from ScenarioModule
int ClassID [get]
 
string ClassName [get]
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 

Member Function Documentation

void TutorialScenario.CloseTutorialWindow ( bool  destroySelf = true)
inlineprotected

< can't set the old one to Started = false, so...

DialogGUIBase [] TutorialScenario.CreateDialog ( string  pageId,
string  textLoc,
DialogGUIButton  button 
)
inlineprotected
DialogGUIBase [] TutorialScenario.CreateDialog ( string  pageId,
string  textLoc,
DialogGUIButton[]  button 
)
inlineprotected
DialogGUIBase [] TutorialScenario.CreateDialog ( string  pageId,
string  textLoc 
)
inlineprotected
MultiOptionDialog TutorialScenario.CreateDoneDialog ( string  pageId,
string  textLoc 
)
inlineprotected
MultiOptionDialog TutorialScenario.CreateMultiButtonDialog ( string  pageId,
string  textLoc,
BasicTutorial.TutorialButtonType  buttons 
)
inlineprotected
MultiOptionDialog TutorialScenario.CreateNextDialog ( string  pageId,
string  textLoc 
)
inlineprotected
MultiOptionDialog TutorialScenario.CreateNoButtonDialog ( string  pageId,
string  textLoc 
)
inlineprotected
MultiOptionDialog TutorialScenario.CreateOkDialog ( string  pageId,
string  textLoc 
)
inlineprotected
TutorialPage TutorialScenario.CreateTutorialPage ( string  pageId,
string  titleLoc,
KFSMStateChange  onEnterCallback 
)
inlineprotected
string TutorialScenario.GetCurrentStateName ( )
inlineprotected
static ConfigNode TutorialScenario.GetTutorialNode ( string  name)
inlinestaticprotected
virtual void TutorialScenario.OnAssetSetup ( )
inlineprotectedvirtual
virtual void TutorialScenario.OnCloseButtonClick ( )
inlineprotectedvirtual
virtual void TutorialScenario.OnContinueButtonClick ( )
inlineprotectedvirtual

Reimplemented in BasicTutorial, and IntermediateTutorial.

virtual void TutorialScenario.OnDoneButtonClick ( )
inlineprotectedvirtual
virtual void TutorialScenario.OnNextButtonClick ( )
inlineprotectedvirtual
virtual void TutorialScenario.OnOkButtonClick ( )
inlineprotectedvirtual
virtual void TutorialScenario.OnOnDestroy ( )
inlineprotectedvirtual
virtual void TutorialScenario.OnTutorialSetup ( )
inlineprotectedvirtual
void TutorialScenario.SetDialogRect ( Rect  r)
inlineprotected

Member Data Documentation

Rect TutorialScenario.avatarRect
protected
TutorialPage TutorialScenario.currentPage
protected
PopupDialog TutorialScenario.dialogDisplay
protected
Rect TutorialScenario.dRect
protected
bool TutorialScenario.ExclusiveTutorial = true
string TutorialScenario.guiSkinName = "KSP window 1"
KerbalInstructor TutorialScenario.instructor
int TutorialScenario.instructorPortraitSize = 128
string TutorialScenario.instructorPrefabName = "Instructor_Wernher"
RenderTexture TutorialScenario.instructorTexture
GameObject TutorialScenario.mainlight
Rect TutorialScenario.rect = new Rect(100f, 80f, 400f, 180f)
protected
UISkinDef TutorialScenario.skin
protected
int TutorialScenario.textureBorderRadius = 124
TutorialFSM TutorialScenario.Tutorial
protected
string TutorialScenario.tutorialArrowPrefabName = "tutorialArrows"
string TutorialScenario.tutorialControlColorString = "#BADA55"
bool TutorialScenario.TutorialDialogEnabled = true
protected

If this is an "exclusive" tutorial, or if it is an advisory popup in a normal game.

string TutorialScenario.tutorialHighlightColorString = "orange"

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