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 | Protected Member Functions | Protected Attributes | Properties | List of all members
ScenarioRunner Class Reference

Provides an entry point for scenario module management. More...

Inheritance diagram for ScenarioRunner:

Public Member Functions

ScenarioModule AddModule (string moduleName)
 
ScenarioModule AddModule (ConfigNode node)
 

Static Public Member Functions

static List< ScenarioModuleGetLoadedModules ()
 
static List< ProtoScenarioModuleGetUpdatedProtoModules ()
 
static void RemoveModule (ScenarioModule module)
 
static void SetProtoModules (List< ProtoScenarioModule > protoModules)
 
static void SetProtoModules (ProtoScenarioModule protoModule)
 

Protected Member Functions

virtual void Awake ()
 
virtual void ClearModules ()
 
virtual void LoadModules (ProtoScenarioModule protoModule)
 
virtual void LoadModules (List< ProtoScenarioModule > protoModules)
 
virtual void OnDestroy ()
 
virtual void OnGameSceneLoadRequested (GameScenes scene)
 
virtual void onLevelWasLoaded (GameScenes scene)
 If we are at MainMenu scene we will load all ScenarioModules that have MainMenu as a target scene. More...
 
virtual void UpdateModules ()
 

Protected Attributes

List< ScenarioModulemodules = new List<ScenarioModule>()
 
List< ProtoScenarioModuleprotoModules = new List<ProtoScenarioModule>()
 

Properties

static ScenarioRunner Instance [get, set]
 

Detailed Description

Provides an entry point for scenario module management.

Member Function Documentation

ScenarioModule ScenarioRunner.AddModule ( string  moduleName)
inline
ScenarioModule ScenarioRunner.AddModule ( ConfigNode  node)
inline
virtual void ScenarioRunner.Awake ( )
inlineprotectedvirtual
virtual void ScenarioRunner.ClearModules ( )
inlineprotectedvirtual
static List<ScenarioModule> ScenarioRunner.GetLoadedModules ( )
inlinestatic
static List<ProtoScenarioModule> ScenarioRunner.GetUpdatedProtoModules ( )
inlinestatic
virtual void ScenarioRunner.LoadModules ( ProtoScenarioModule  protoModule)
inlineprotectedvirtual
virtual void ScenarioRunner.LoadModules ( List< ProtoScenarioModule protoModules)
inlineprotectedvirtual
virtual void ScenarioRunner.OnDestroy ( )
inlineprotectedvirtual
virtual void ScenarioRunner.OnGameSceneLoadRequested ( GameScenes  scene)
inlineprotectedvirtual
virtual void ScenarioRunner.onLevelWasLoaded ( GameScenes  scene)
inlineprotectedvirtual

If we are at MainMenu scene we will load all ScenarioModules that have MainMenu as a target scene.

Parameters
scene
static void ScenarioRunner.RemoveModule ( ScenarioModule  module)
inlinestatic
static void ScenarioRunner.SetProtoModules ( List< ProtoScenarioModule protoModules)
inlinestatic
static void ScenarioRunner.SetProtoModules ( ProtoScenarioModule  protoModule)
inlinestatic
virtual void ScenarioRunner.UpdateModules ( )
inlineprotectedvirtual

Member Data Documentation

List<ScenarioModule> ScenarioRunner.modules = new List<ScenarioModule>()
protected
List<ProtoScenarioModule> ScenarioRunner.protoModules = new List<ProtoScenarioModule>()
protected

Property Documentation

ScenarioRunner ScenarioRunner.Instance
staticgetset

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