MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Enumerations
Mezzanine::Scripting Namespace Reference

This namespace is for all the classes belonging to the Scripting Subsystem. More...

Classes

class  iScript
 The interface for a script. More...
 
class  iScriptArgument
 The interface for a script argument. More...
 
class  iScriptCompilable
 The interface for a script that can be compiled to bytecode. More...
 
class  iScriptCompilationManager
 What a scripting manager should look like. More...
 
class  iScriptingManager
 What a scripting manager should look like. More...
 
class  iScriptMultipleReturn
 This script can return simple group of values. More...
 
class  iScriptWorkUnit
 The interface for a container of script that can be executed each frame. More...
 
class  NullArgument
 A very simple type used to indicate to script argument templates that the argument represents. More...
 
class  ScriptArgumentGeneric
 A generic implementation of a ScriptArgument that is suitable for primitive types in most situations. More...
 
class  ScriptArgumentGeneric< Boolean >
 A Bool implementation of a ScriptArgument that is suitable for primitive types in most situations. More...
 
class  ScriptArgumentGeneric< Integer >
 A Integer implementation of a ScriptArgument that is suitable for primitive types in most situations. More...
 
class  ScriptArgumentGeneric< NullArgument >
 A Null implementation of a ScriptArgument that is suitable for primitive types in most situations. More...
 
class  ScriptArgumentGeneric< Real >
 A Real number implementation of a ScriptArgument that is suitable for primitive types in most situations. More...
 
class  ScriptArgumentGeneric< String >
 A String implementation of a ScriptArgument that is suitable for primitive types in most situations. More...
 
class  ScriptArgumentGeneric< Whole >
 A Whole number implementation of a ScriptArgument that is suitable for primitive types in most situations. More...
 

Typedefs

typedef std::vector
< CountedPtr< iScriptArgument > > 
ArgumentGroup
 A group of arguments that can be returned from some scripts. More...
 

Enumerations

enum  ScriptArgument {
  GenericUnknown = 0, GenericInteger = 1, GenericWhole = 2, GenericString = 3,
  GenericReal = 4, GenericBool = 5, GenericNull = 6, GenericMax = 6
}
 A listing of the Base types an iScriptArgument could represent. More...
 

Detailed Description

This namespace is for all the classes belonging to the Scripting Subsystem.

The system for integrating scripting languages into the engine.

In general each languages Interpretter/Engine/Compiler/VM is locating in its own subnamespace in the associated manager. Here is a list of Languages compiled in this build.

Typedef Documentation

A group of arguments that can be returned from some scripts.

A vector is used to preserve ordering of returns for languages that support multiple returns in order

Definition at line 295 of file script.h.

Enumeration Type Documentation

A listing of the Base types an iScriptArgument could represent.

Enumerator
GenericUnknown 

This is not readily available when instantiating ScriptArgumentGeneric<T> where T is unknown.

GenericInteger 

Returned from GetTypeData() const when a ScriptArgumentGeneric is specialized as an Integer.

GenericWhole 

Returned from GetTypeData() const when a ScriptArgumentGeneric is specialized as an Whole.

GenericString 

Returned from GetTypeData() const when a ScriptArgumentGeneric is specialized as an String.

GenericReal 

Returned from GetTypeData() const when a ScriptArgumentGeneric is specialized as an Real.

GenericBool 

Returned from GetTypeData() const when a ScriptArgumentGeneric is specialized as an Bool.

GenericNull 

Returned from GetTypeData() const when a ScriptArgumentGeneric is intended as NullPtr, SQL Null, Lua Nil, Ruby nil, etc...

GenericMax 

This is always equal to the maximum value in this enumeration so that other constant values can be based on this. For example Lua uses this +1 for its NilValue.

Definition at line 115 of file scriptargument.h.