MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Mezzanine::Scripting::iScriptingManager Class Referenceabstract

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

#include <scriptingmanager.h>

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

Public Member Functions

 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::ManagerBase
 ManagerBase ()
 Class constructor.
 
virtual ~ManagerBase ()
 Class destructor.
 
virtual String GetInterfaceTypeAsString () const
 Gets a string of the interface type of this manager. More...
 
bool IsInitialized () const
 Gets whether or not this manager has been initialized. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::ManagerBase
enum  ManagerType {
  MT_AudioManager = 1, MT_AnimationManager, MT_CollisionShapeManager, MT_CompositorManager,
  MT_GraphicsManager, MT_EventManager, MT_InputManager, MT_LogManager,
  MT_MaterialManager, MT_MeshManager, MT_NetworkManager, MT_ResourceManager,
  MT_ScriptingManager, MT_UIManager, MT_ActorManager = 100, MT_AreaEffectManager,
  MT_CameraManager, MT_DebrisManager, MT_PagingManager, MT_PhysicsManager,
  MT_SceneManager, MT_SoundScapeManager, MT_TerrainManager, MT_VehicleManager,
  MT_UserCreated = 512
}
 
- 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
bool Initialized
 Simple bool 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.

If a scripting language does not support compilation It should implement this

Definition at line 64 of file scriptingmanager.h.

Constructor & Destructor Documentation

Mezzanine::Scripting::iScriptingManager::iScriptingManager ( )

Class constructor.

Sets Priority as required by single threaaded main loop

Definition at line 52 of file scriptingmanager.cpp.

Member Function Documentation

void Mezzanine::Scripting::iScriptingManager::Deinitialize ( )
virtual

Removes this manager from any necessary configuration so it can be safely disposed of.

Implements Mezzanine::ManagerBase.

Definition at line 66 of file scriptingmanager.cpp.

virtual CountedPtr<iScript> Mezzanine::Scripting::iScriptingManager::Execute ( const String ScriptSource)
pure virtual

Run a string containing script soure code.

Parameters
ScriptSourceThe source code of the script.

In implementations it is expected that this will create a script object, execute it and return it.

Returns
A Shared pointer to the created Script.
virtual void Mezzanine::Scripting::iScriptingManager::Execute ( CountedPtr< iScript > &  ScriptToRun)
pure virtual

Run the script.

Parameters
ScriptToRunA shared ptr that points to a script to run.

In Scripting langauge implementations this is expected to run (compile if needed) a script.

virtual String Mezzanine::Scripting::iScriptingManager::GetImplementationTypeName ( ) const
pure virtual

This Allows any manager name to be sent to a stream. Primarily used for logging.

Returns
This returns a String that contains the name.

Implements Mezzanine::ManagerBase.

ManagerBase::ManagerType Mezzanine::Scripting::iScriptingManager::GetInterfaceType ( ) const
virtual

This returns the type of this manager.

This is intended to make using and casting from Manager base easier. With this is is possible to cast from ManagerBase to the correct Manager Type.

Returns
This returns a ManagerTypeName to identify what this can be safely cast to.

Implements Mezzanine::ManagerBase.

Definition at line 71 of file scriptingmanager.cpp.

void Mezzanine::Scripting::iScriptingManager::Initialize ( )
virtual

Configures this manager for use prior to entering the main loop.

Implements Mezzanine::ManagerBase.

Definition at line 61 of file scriptingmanager.cpp.


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