Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::Scripting::iScriptCompilationManager Class Referenceabstract

What a scripting manager should look like. More...

#include <scriptingmanager.h>

+ Inheritance diagram for Mezzanine::Scripting::iScriptCompilationManager:
+ Collaboration diagram for Mezzanine::Scripting::iScriptCompilationManager:

Public Member Functions

virtual ~iScriptCompilationManager ()
 Overidable deconstructor.
 
virtual void Compile (CountedPtr< iScriptCompilable > &ScriptToCompile)=0
 Compile a script. More...
 
virtual CountedPtr< iScriptCompilableCompile (const String &SourceToCompile)=0
 Comvert a string into a Script that is compiled and ready for use. More...
 
- Public Member Functions inherited from Mezzanine::Scripting::iScriptingManager
 iScriptingManager ()
 Class constructor. More...
 
virtual ~iScriptingManager ()
 Class destructor.
 
virtual void Deinitialize ()
 Removes this manager from any necessary configuration so it can be safely disposed of. More...
 
virtual CountedPtr< iScriptExecute (const String &ScriptSource)=0
 Run a string containing script soure code. More...
 
virtual void Execute (CountedPtr< iScript > &ScriptToRun)=0
 Run the script. More...
 
virtual String GetImplementationTypeName () const =0
 This Allows any manager name to be sent to a stream. Primarily used for logging. More...
 
virtual ManagerType GetInterfaceType () const
 This returns the type of this manager. More...
 
virtual void Initialize ()
 Configures this manager for use prior to entering the main loop. More...
 
- Public Member Functions inherited from Mezzanine::EntresolManager
 EntresolManager ()
 Class constructor.
 
virtual ~EntresolManager ()
 Class destructor.
 
- Public Member Functions inherited from Mezzanine::ManagerBase
 ManagerBase ()
 Class constructor.
 
virtual ~ManagerBase ()
 Class destructor.
 
virtual String GetInterfaceTypeAsString () const
 Gets a string of the interface type of this manager. More...
 
Boole IsInitialized () const
 Gets whether or not this manager has been initialized. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::ManagerBase
enum  ManagerType {
  MT_Undefined = 0, MT_AudioManager = 1, MT_AnimationManager = 2, MT_CollisionShapeManager = 3,
  MT_CompositorManager = 4, MT_GraphicsManager = 5, MT_EventManager = 6, MT_InputManager = 7,
  MT_LogManager = 8, MT_MaterialManager = 9, MT_MeshManager = 10, MT_NetworkManager = 11,
  MT_ResourceManager = 12, MT_ScriptingManager = 13, MT_TextureManager = 14, MT_UIManager = 15,
  MT_ActorManager = 101, MT_AreaEffectManager = 102, MT_DebrisManager = 103, MT_PagingManager = 104,
  MT_PhysicsManager = 105, MT_SceneManager = 106, MT_SoundScapeManager = 107, MT_TerrainManager = 108,
  MT_VehicleManager = 109, MT_UserCreated = 512
}
 A listing of Manager Types. More...
 
- Static Public Member Functions inherited from Mezzanine::ManagerBase
static String GetTypeAsString (const ManagerType &ManagerType)
 Gets the string form of the type of manager. More...
 
static ManagerType GetTypeFromString (const String &ManagerName)
 Gets the type of manager requested from a string. More...
 
- Protected Attributes inherited from Mezzanine::ManagerBase
Boole Initialized
 Simple Boole indicating whether or not this manager has been initialized. More...
 
EntresolTheEntresol
 The actual pointer to the Entresol core class. More...
 

Detailed Description

What a scripting manager should look like.

This scripting manager implements no scripting language, but serves as model for what scripting managers

Definition at line 116 of file scriptingmanager.h.

Member Function Documentation

virtual void Mezzanine::Scripting::iScriptCompilationManager::Compile ( CountedPtr< iScriptCompilable > &  ScriptToCompile)
pure virtual

Compile a script.

Parameters
ScriptToCompileA script object to be compiled.

Implemented in Mezzanine::Scripting::Lua::Lua51ScriptingEngine.

virtual CountedPtr<iScriptCompilable> Mezzanine::Scripting::iScriptCompilationManager::Compile ( const String SourceToCompile)
pure virtual

Comvert a string into a Script that is compiled and ready for use.

Parameters
SourceToCompileA string containing source code in the target language.
Returns
The Script compiled and ready for use.

Implemented in Mezzanine::Scripting::Lua::Lua51ScriptingEngine.


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