ScriptEngine

Undocumented in source.
class ScriptEngine {}

Destructor

~this
~this()
Undocumented in source.

Members

Functions

addRef
int addRef()

Adds reference

beginConfigGroup
void beginConfigGroup(string groupName)

Starts a new dynamic configuration group

clearMessageCallback
void clearMessageCallback()

Clears the message callback

createContext
ScriptContext createContext()

Creates a new script context

discardModule
void discardModule(string name)

Discards a module by name Note: Any class instances of the module in question will be rendered invalid.

endConfigGroup
void endConfigGroup()

Ends the configuration group

getDefaultArrayTypeId
int getDefaultArrayTypeId()

Gets the type id of the default array type

getDefaultNamespace
string getDefaultNamespace()

Gets the current default namespace

getEnumByindex
Type getEnumByindex(asUINT index)

Gets the type of an enum by its index

getEnumCount
asUINT getEnumCount()

Gets the amount of enums registered

getFuncdefByIndex
Type getFuncdefByIndex(asUINT index)

Gets the type of a fundef by its index

getFuncdefConut
asUINT getFuncdefConut()

Gets the amount of enums registered

getFunctionById
Function getFunctionById(int funcId)

Get a function by its ID in the engine

getGlobalFunctionByDecl
Function getGlobalFunctionByDecl(string decl)

Gets a global function by its declaration

getGlobalFunctionByIndex
Function getGlobalFunctionByIndex(uint index)

Gets a global function by its index

getGlobalFunctionCount
asUINT getGlobalFunctionCount()

Gets the amount of global functions

getGlobalPropertyByIndex
void getGlobalPropertyByIndex(uint index, string name, string namespace, int typeId, bool isConst, string configGroup, void* ptr, asDWORD accessMask)

Gets a global property by its index

getGlobalPropertyCount
asUINT getGlobalPropertyCount()

Gets the count of global properties

getGlobalPropertyIndexByDecl
int getGlobalPropertyIndexByDecl(string decl)

Gets the index of a global property by its declaration

getGlobalPropertyIndexByName
int getGlobalPropertyIndexByName(string name)

Gets the index of a global property by its name

getModule
Module getModule(string name, ModuleCreateFlags flags)

Gets a module in the engine by name

getModule
Module getModule(asUINT index)

Gets a module in the engine by index

getModuleCount
asUINT getModuleCount()

Gets the count of modules

getObjectTypeByIndex
Type getObjectTypeByIndex(asUINT index)

Gets the type info of an object by its index

getObjectTypeCount
asUINT getObjectTypeCount()

Gets the count of the objects in the engine

getProperty
asPWORD getProperty(asEEngineProp property)

Gets an engine property

getStringFactoryReturnTypeId
asUINT getStringFactoryReturnTypeId(asDWORD* flags)

Gets the return type id of the string type the factory returns

registerDefaultArrayType
void registerDefaultArrayType(string type)

Registers the default array type

registerEnum
void registerEnum()

Registers a D enum in Angelscript

registerEnum
void registerEnum(string type)

Registers an enum

registerEnumValue
void registerEnumValue(string type, string name, int value)

Registers a value for the enum

registerFuncDef
void registerFuncDef(string decl)
Undocumented in source. Be warned that the author may not have intended to support it.
registerGlobalFunction
void registerGlobalFunction(string declaration, T func, void* aux)

Register a global function

registerGlobalProperty
void registerGlobalProperty(string declaration, T pointer)

Registers a global property

registerInterface
void registerInterface(string name)

Registers a new interface

registerInterfaceMethod
void registerInterfaceMethod(string intf, string decl)

Registers an interface method

registerObjectBehaviour
void registerObjectBehaviour(string obj, asEBehaviours behaviour, string decl, T func, asDWORD callConv, void* aux)

Registers a behaviour for an object

registerObjectMethod
void registerObjectMethod(string obj, string decl, T func, asDWORD callConv, void* aux)

Registers a method for an object

registerObjectProperty
void registerObjectProperty(string obj, string decl, int byteOffset)

Registers a property for an object

registerObjectType
void registerObjectType(string name, int byteSize, asDWORD flags)

Registers an object type

registerStringFactory
void registerStringFactory(string type, asGETSTRINGCONSTFUNC_t getStr, asRELEASESTRINGCONSTFUNC_t releaseStr, asGETRAWSTRINGDATAFUNC_t getRawStr)

Registers a string factory type with the specified creation functions

release
int release()

Releases reference

removeConfigGroup
void removeConfigGroup(string groupName)

Removes a configuration group

setDefaultAccessMask
asDWORD setDefaultAccessMask(asDWORD defaultMask)

Sets the access mask that should be used for subsequent registered entities

setDefaultNamespace
void setDefaultNamespace(string nameSpace)

Sets the default namespace

setMessageCallback
void setMessageCallback(MessageCallback callback)

Sets the message callback

setProperty
void setProperty(asEEngineProp property, asPWORD value)

Sets an engine property

shutDownAndRelease
int shutDownAndRelease()

Shuts down the scripting engine and releases it

writeMessage
void writeMessage(string section, int row, int col, MessageType type, string message)

Writes a message

Static functions

create
ScriptEngine create(asDWORD version_)

Creates a new script engine

Meta