The interface to the script modules. More...

Public Member Functions
Miscellaneous
virtual asIScriptEngine *	GetEngine () const =0
	Returns a pointer to the engine. More...

virtual void	SetName (const char *name)=0
	Sets the name of the module. More...

virtual const char *	GetName () const =0
	Gets the name of the module. More...

virtual void	Discard ()=0
	Discards the module. More...

Compilation
virtual int	AddScriptSection (const char name, const char code, size_t codeLength=0, int lineOffset=0)=0
	Add a script section for the next build. More...

virtual int	Build ()=0
	Build the previously added script sections. More...

virtual int	CompileFunction (const char sectionName, const char code, int lineOffset, asDWORD compileFlags, asIScriptFunction **outFunc)=0
	Compile a single function. More...

virtual int	CompileGlobalVar (const char sectionName, const char code, int lineOffset)=0
	Compile a single global variable and add it to the scope of the module. More...

virtual asDWORD	SetAccessMask (asDWORD accessMask)=0
	Sets the access mask that should be used during the compilation. More...

virtual int	SetDefaultNamespace (const char *nameSpace)=0
	Sets the default namespace that should be used in the following calls. More...

virtual const char *	GetDefaultNamespace () const =0
	Returns the current default namespace. More...

Functions
virtual asUINT	GetFunctionCount () const =0
	Returns the number of global functions in the module. More...

virtual asIScriptFunction *	GetFunctionByIndex (asUINT index) const =0
	Returns the function by index. More...

virtual asIScriptFunction *	GetFunctionByDecl (const char *decl) const =0
	Returns the function by its declaration. More...

virtual asIScriptFunction *	GetFunctionByName (const char *name) const =0
	Returns the function by its name. More...

virtual int	RemoveFunction (asIScriptFunction *func)=0
	Remove a single function from the scope of the module. More...

Global variables
virtual int	ResetGlobalVars (asIScriptContext *ctx=0)=0
	Reset the global variables of the module. More...

virtual asUINT	GetGlobalVarCount () const =0
	Returns the number of global variables in the module. More...

virtual int	GetGlobalVarIndexByName (const char *name) const =0
	Returns the global variable index by name. More...

virtual int	GetGlobalVarIndexByDecl (const char *decl) const =0
	Returns the global variable index by declaration. More...

virtual const char *	GetGlobalVarDeclaration (asUINT index, bool includeNamespace=false) const =0
	Returns the global variable declaration. More...

virtual int	GetGlobalVar (asUINT index, const char name, const char nameSpace=0, int typeId=0, bool isConst=0) const =0
	Returns the global variable properties. More...

virtual void *	GetAddressOfGlobalVar (asUINT index)=0
	Returns the pointer to the global variable. More...

virtual int	RemoveGlobalVar (asUINT index)=0
	Remove the global variable from the scope of the module. More...

Type identification
virtual asUINT	GetObjectTypeCount () const =0
	Returns the number of object types. More...

virtual asITypeInfo *	GetObjectTypeByIndex (asUINT index) const =0
	Returns the object type interface by index. More...

virtual int	GetTypeIdByDecl (const char *decl) const =0
	Returns a type id by declaration. More...

virtual asITypeInfo *	GetTypeInfoByName (const char *name) const =0
	Returns the type interface by name. More...

virtual asITypeInfo *	GetTypeInfoByDecl (const char *decl) const =0
	Returns a type by declaration. More...

Enums
virtual asUINT	GetEnumCount () const =0
	Returns the number of enum types declared in the module. More...

virtual asITypeInfo *	GetEnumByIndex (asUINT index) const =0
	Returns the enum type. More...

Typedefs
virtual asUINT	GetTypedefCount () const =0
	Returns the number of typedefs in the module. More...

virtual asITypeInfo *	GetTypedefByIndex (asUINT index) const =0
	Returns the typedef. More...

Dynamic binding between modules
virtual asUINT	GetImportedFunctionCount () const =0
	Returns the number of functions declared for import. More...

virtual int	GetImportedFunctionIndexByDecl (const char *decl) const =0
	Returns the imported function index by declaration. More...

virtual const char *	GetImportedFunctionDeclaration (asUINT importIndex) const =0
	Returns the imported function declaration. More...

virtual const char *	GetImportedFunctionSourceModule (asUINT importIndex) const =0
	Returns the declared imported function source module. More...

virtual int	BindImportedFunction (asUINT importIndex, asIScriptFunction *func)=0
	Binds an imported function to the function from another module. More...

virtual int	UnbindImportedFunction (asUINT importIndex)=0
	Unbinds an imported function. More...

virtual int	BindAllImportedFunctions ()=0
	Binds all imported functions in a module, by searching their equivalents in the declared source modules. More...

virtual int	UnbindAllImportedFunctions ()=0
	Unbinds all imported functions. More...

Byte code saving and loading
virtual int	SaveByteCode (asIBinaryStream *out, bool stripDebugInfo=false) const =0
	Save compiled byte code to a binary stream. More...

virtual int	LoadByteCode (asIBinaryStream in, bool wasDebugInfoStripped=0)=0
	Load pre-compiled byte code from a binary stream. More...

User data
virtual void *	SetUserData (void *data, asPWORD type=0)=0
	Register the memory address of some user data. More...

virtual void *	GetUserData (asPWORD type=0) const =0
	Returns the address of the previously registered user data. More...

Detailed Description

A script module can be thought of a library of script functions, classes, and global variables.

A pointer to the module interface is obtained by calling asIScriptEngine::GetModule. The module can then be built from a single or multiple script files, also known as script sections. Alternatively pre-built bytecode can be loaded, if it has been saved from a previous build.

See also: Script modules

Member Function Documentation

◆ AddScriptSection()

virtual int asIScriptModule::AddScriptSection	(	const char *	name,
		const char *	code,
		size_t	codeLength = `0`,
		int	lineOffset = `0`
	)

pure virtual

Parameters

[in]	name	The name of the script section
[in]	code	The script code buffer
[in]	codeLength	The length of the script code
[in]	lineOffset	An offset that will be added to compiler message line numbers

Returns: A negative value on error.

Return values

asINVALID_ARG	The code argument is null.
asNOT_SUPPORTED	Compiler support is disabled in the engine.
asOUT_OF_MEMORY	The necessary memory to hold the script code couldn't be allocated.

This adds a script section to the module. The script section isn't processed with this call. Only when Build is called will the script be parsed and compiled into executable byte code.

Error messages from the compiler will refer to the name of the script section and the position within it. Normally each section is the content of a source file, so it is recommended to name the script sections as the name of the source file.

The code added is copied by the engine, so there is no need to keep the original buffer after the call. Note that this can be changed by setting the engine property asEP_COPY_SCRIPT_SECTIONS with asIScriptEngine::SetEngineProperty.

◆ BindAllImportedFunctions()

virtual int asIScriptModule::BindAllImportedFunctions ( )

pure virtual

Returns: A negative value on error.

Return values

asERROR	An error occurred.
asCANT_BIND_ALL_FUNCTIONS	Not all functions where bound.

This functions tries to bind all imported functions in the module by searching for matching functions in the suggested modules. If a function cannot be bound the function will give an error asCANT_BIND_ALL_FUNCTIONS, but it will continue binding the rest of the functions.

◆ BindImportedFunction()

virtual int asIScriptModule::BindImportedFunction	(	asUINT	importIndex,
		asIScriptFunction *	func
	)

pure virtual

Parameters

[in]	importIndex	The index of the imported function.
[in]	func	The true function that will be bound to the imported function.

Returns: A negative value on error.

Return values

asNO_FUNCTION	importIndex or func is incorrect.
asINVALID_INTERFACE	The signature of function doesn't match the import statement.

The imported function is only bound if the functions have the exact same signature, i.e the same return type, and parameters.

◆ Build()

virtual int asIScriptModule::Build ( )

pure virtual

Returns: A negative value on error

Return values

asINVALID_CONFIGURATION	The engine configuration is invalid.
asERROR	The script failed to build.
asBUILD_IN_PROGRESS	Another thread is currently building.
asINIT_GLOBAL_VARS_FAILED	It was not possible to initialize at least one of the global variables.
asNOT_SUPPORTED	Compiler support is disabled in the engine.
asMODULE_IS_IN_USE	The code in the module is still being used and and cannot be removed.

Builds the script based on the previously added sections, registered types and functions. After the build is complete the script sections are removed to free memory.

Before starting the build the Build method removes any previously compiled script content, including the dynamically added content from CompileFunction and CompileGlobalVar. If the script module needs to be rebuilt all of the script sections needs to be added again.

Compiler messages are sent to the message callback function set with asIScriptEngine::SetMessageCallback. If there are no errors or warnings, no messages will be sent to the callback function.

Any global variables found in the script will be initialized by the compiler if the engine property asEP_INIT_GLOBAL_VARS_AFTER_BUILD is set. If you get the error asINIT_GLOBAL_VARS_FAILED, then it is probable that one of the global variables during the initialization is trying to access another global variable before it has been initialized.

See also: Compiling scripts

◆ CompileFunction()

virtual int asIScriptModule::CompileFunction	(	const char *	sectionName,
		const char *	code,
		int	lineOffset,
		asDWORD	compileFlags,
		asIScriptFunction **	outFunc
	)

pure virtual

Parameters

[in]	sectionName	The name of the script section
[in]	code	The script code buffer
[in]	lineOffset	An offset that will be added to compiler message line numbers
[in]	compileFlags	One of asECompileFlags values
[out]	outFunc	Optional parameter to receive the compiled function descriptor

Returns: A negative value on error

Return values

asINVALID_ARG	One or more arguments have invalid values.
asINVALID_CONFIGURATION	The engine configuration is invalid.
asBUILD_IN_PROGRESS	Another build is in progress.
asERROR	The compilation failed.
asNOT_SUPPORTED	Compiler support is disabled in the engine.

Use this to compile a single function. Any existing compiled code in the module can be used by the function.

The newly compiled function can be optionally added to the scope of the module where it can later be referred to by the application or used in subsequent compilations. If not added to the module the function can still be returned in the output parameter, which will allow the application to execute it and then discard it when it is no longer needed.

If the output function parameter is set, remember to release the function object when you're done with it.

◆ CompileGlobalVar()

virtual int asIScriptModule::CompileGlobalVar	(	const char *	sectionName,
		const char *	code,
		int	lineOffset
	)

pure virtual

Parameters

[in]	sectionName	The name of the script section
[in]	code	The script code buffer
[in]	lineOffset	An offset that will be added to compiler message line numbers

Returns: A negative value on error

Return values

asINVALID_ARG	One or more arguments have invalid values.
asINVALID_CONFIGURATION	The engine configuration is invalid.
asBUILD_IN_PROGRESS	Another build is in progress.
asERROR	The compilation failed.
asNOT_SUPPORTED	Compiler support is disabled in the engine.

Use this to add a single global variable to the scope of a module. The variable can then be referred to by the application and subsequent compilations.

The script code may contain an initialization expression, which will be executed by the compiler if the engine property asEP_INIT_GLOBAL_VARS_AFTER_BUILD is set.

Any existing compiled code in the module can be used in the initialization expression.

◆ Discard()

virtual void asIScriptModule::Discard ( )

pure virtual

This method is used to discard the module and any compiled bytecode it has. After calling this method the module pointer is no longer valid and shouldn't be used by the application.

◆ GetAddressOfGlobalVar()

virtual void* asIScriptModule::GetAddressOfGlobalVar ( asUINT index )

pure virtual

Parameters

[in] index The index of the global variable.

Returns: A pointer to the global variable, or null if not found.

This method should be used to retrieve the pointer of a variable that you wish to access.

◆ GetDefaultNamespace()

virtual const char* asIScriptModule::GetDefaultNamespace ( ) const

pure virtual

Returns: The current default namespace

◆ GetEngine()

virtual asIScriptEngine* asIScriptModule::GetEngine ( ) const

pure virtual

Returns: A pointer to the engine.

◆ GetEnumByIndex()

virtual asITypeInfo* asIScriptModule::GetEnumByIndex ( asUINT index ) const

pure virtual

Parameters

[in] index The index of the enum type.

Returns: The type info of the enum type, or null on error.

◆ GetEnumCount()

virtual asUINT asIScriptModule::GetEnumCount ( ) const

pure virtual

Returns: The number of enum types in the module.

◆ GetFunctionByDecl()

virtual asIScriptFunction* asIScriptModule::GetFunctionByDecl ( const char * decl ) const

pure virtual

Parameters

[in] decl The function declaration.

Returns: The function or null in case of error.

◆ GetFunctionByIndex()

virtual asIScriptFunction* asIScriptModule::GetFunctionByIndex ( asUINT index ) const

pure virtual

Parameters

[in] index The index of the function

Returns: The function or null in case of error.

◆ GetFunctionByName()

virtual asIScriptFunction* asIScriptModule::GetFunctionByName ( const char * name ) const

pure virtual

Parameters

[in] name The function name

Returns: The function or null if not found or there are multiple matches.

The search for functions will be performed in the default namespace as given by SetDefaultNamespace unless the name is prefixed with a scope, using the scoping operator ::. If the scope starts with :: it will be used as the absolute scope, otherwise it will be relative to the default namespace.

◆ GetFunctionCount()

virtual asUINT asIScriptModule::GetFunctionCount ( ) const

pure virtual

Returns: The number of global functions in this module.

This method retrieves the number of compiled script functions.

◆ GetGlobalVar()

virtual int asIScriptModule::GetGlobalVar	(	asUINT	index,
		const char **	name,
		const char **	nameSpace = `0`,
		int *	typeId = `0`,
		bool *	isConst = `0`
	)		const

pure virtual

Parameters

[in]	index	The index of the global variable.
[out]	name	The name of the variable.
[out]	nameSpace	The namespace of the variable.
[out]	typeId	The type of the variable.
[out]	isConst	Whether or not the variable is const.

Returns: A negative value on error.

Return values

asINVALID_ARG The index is out of range.

◆ GetGlobalVarCount()

virtual asUINT asIScriptModule::GetGlobalVarCount ( ) const

pure virtual

Returns: The number of global variables in the module.

◆ GetGlobalVarDeclaration()

virtual const char* asIScriptModule::GetGlobalVarDeclaration	(	asUINT	index,
		bool	includeNamespace = `false`
	)		const

pure virtual

Parameters

[in]	index	The index of the global variable.
[in]	includeNamespace	Set to true if the namespace should be included in the declaration.

Returns: A null terminated string with the variable declaration, or null if not found.

This method can be used to retrieve the variable declaration of the script variables that the host application will access. Verifying the declaration is important because, even though the script may compile correctly the user may not have used the variable types as intended.

◆ GetGlobalVarIndexByDecl()

virtual int asIScriptModule::GetGlobalVarIndexByDecl ( const char * decl ) const

pure virtual

Parameters

[in] decl The global variable declaration.

Returns: A negative value on error, or the global variable index.

Return values

asERROR	The module was not built successfully.
asNO_GLOBAL_VAR	No matching global variable was found.
asINVALID_DECLARATION	The given declaration is invalid.

This method should be used to retrieve the index of the script variable that you wish to access.

The method will find the script variable with the exact same declaration.

If the variable is declared in a namespace first call SetDefaultNamespace to set the namespace that should be searched first for the variable.

◆ GetGlobalVarIndexByName()

virtual int asIScriptModule::GetGlobalVarIndexByName ( const char * name ) const

pure virtual

Parameters

[in] name The name of the global variable.

Returns: A negative value on error, or the global variable index.

Return values

asINVALID_ARG	The name and scope for search cannot be determined
asNO_GLOBAL_VAR	The matching global variable was found.

This method should be used to retrieve the index of the script variable that you wish to access.

The search for global variables will be performed in the default namespace as given by SetDefaultNamespace unless the name is prefixed with a scope, using the scoping operator ::. If the scope starts with :: it will be used as the absolute scope, otherwise it will be relative to the default namespace.

◆ GetImportedFunctionCount()

virtual asUINT asIScriptModule::GetImportedFunctionCount ( ) const

pure virtual

Returns: The number of imported functions.

This function returns the number of functions that are imported in a module. These functions need to be bound before they can be used, or a script exception will be thrown.

◆ GetImportedFunctionDeclaration()

virtual const char* asIScriptModule::GetImportedFunctionDeclaration ( asUINT importIndex ) const

pure virtual

Parameters

[in] importIndex The index of the imported function.

Returns: A null terminated string with the function declaration, or null if not found.

Use this function to get the declaration of the imported function. The returned declaration can be used to find a matching function in another module that can be bound to the imported function.

◆ GetImportedFunctionIndexByDecl()

virtual int asIScriptModule::GetImportedFunctionIndexByDecl ( const char * decl ) const

pure virtual

Parameters

[in] decl The function declaration of the imported function.

Returns: A negative value on error, or the index of the imported function.

Return values

asERROR	The module was not built successfully.
asMULTIPLE_FUNCTIONS	Found multiple matching functions.
asNO_FUNCTION	Didn't find any matching function.

This function is used to find a specific imported function by its declaration.

◆ GetImportedFunctionSourceModule()

virtual const char* asIScriptModule::GetImportedFunctionSourceModule ( asUINT importIndex ) const

pure virtual

Parameters

[in] importIndex The index of the imported function.

Returns: A null terminated string with the name of the source module, or null if not found.

Use this function to get the name of the suggested module to import the function from.

◆ GetName()

virtual const char* asIScriptModule::GetName ( ) const

pure virtual

Returns: The name of the module.

◆ GetObjectTypeByIndex()

virtual asITypeInfo* asIScriptModule::GetObjectTypeByIndex ( asUINT index ) const

pure virtual

Parameters

[in] index The index of the type.

Returns: The object type interface for the type, or null if not found.

This does not increase the reference count of the returned object.

◆ GetObjectTypeCount()

virtual asUINT asIScriptModule::GetObjectTypeCount ( ) const

pure virtual

Returns: The number of object types declared in the module.

◆ GetTypedefByIndex()

virtual asITypeInfo* asIScriptModule::GetTypedefByIndex ( asUINT index ) const

pure virtual

Parameters

[in] index The index of the typedef.

Returns: The type info of the typedef, or null on error.

◆ GetTypedefCount()

virtual asUINT asIScriptModule::GetTypedefCount ( ) const

pure virtual

Returns: The number of typedefs in the module.

◆ GetTypeIdByDecl()

virtual int asIScriptModule::GetTypeIdByDecl ( const char * decl ) const

pure virtual

Parameters

[in] decl The declaration of the type.

Returns: A negative value on error, or the type id of the type.

Return values

asINVALID_TYPE decl is not a valid type.

Translates a type declaration into a type id. The returned type id is valid for as long as the type is valid, so you can safely store it for later use to avoid potential overhead from calling this function each time. Just remember to update the type id, any time the type is changed within the engine, e.g. when recompiling script declared classes, or changing the engine configuration.

The type id is based on a sequence number and depends on the order in which the type ids are queried, thus is not guaranteed to always be the same for each execution of the application. The asETypeIdFlags can be used to obtain some information about the type directly from the id.

A base type yields the same type id whether the declaration is const or not, however if the const is for the subtype then the type id is different, e.g. string@ isn't the same as const string@ but string is the same as const string.

◆ GetTypeInfoByDecl()

virtual asITypeInfo* asIScriptModule::GetTypeInfoByDecl ( const char * decl ) const

pure virtual

Parameters

[in] decl The declaration of the type.

Returns: The type or null on error.

Translates a type declaration into the type info. The returned type is valid for as long as the type is valid, so you can safely store it for later use to avoid potential overhead from calling this function each time. Just remember to update the type info pointer any time the type is changed within the engine, e.g. when recompiling script declared classes, or changing the engine configuration.

◆ GetTypeInfoByName()

virtual asITypeInfo* asIScriptModule::GetTypeInfoByName ( const char * name ) const

pure virtual

Parameters

[in] name The name of the type.

Returns: The type interface for the type, or null if not found.

The search for types will be performed in the default namespace as given by SetDefaultNamespace unless the name is prefixed with a scope, using the scoping operator ::. If the scope starts with :: it will be used as the absolute scope, otherwise it will be relative to the default namespace.

◆ GetUserData()

virtual void* asIScriptModule::GetUserData ( asPWORD type = 0 ) const

pure virtual

Parameters

[in] type An identifier specifying the user data to set.

Returns: The pointer to the user data.

◆ LoadByteCode()

virtual int asIScriptModule::LoadByteCode	(	asIBinaryStream *	in,
		bool *	wasDebugInfoStripped = `0`
	)

pure virtual

Parameters

[in]	in	The input stream.
[out]	wasDebugInfoStripped	Set to true if the byte code was saved without debug information.

Returns: A negative value on error.

Return values

asINVALID_ARG	The stream object wasn't specified.
asBUILD_IN_PROGRESS	Another thread is currently building.
asOUT_OF_MEMORY	The engine ran out of memory while loading the byte code.
asMODULE_IS_IN_USE	The code in the module is still being used and and cannot be removed.
asERROR	It was not possible to load the byte code.

This method is used to load pre-compiled byte code from disk or memory. The application must implement an object that inherits from asIBinaryStream to provide the necessary stream operations.

It is expected that the application performs the necessary validations to make sure the pre-compiled byte code is from a trusted source. The application should also make sure the pre-compiled byte code is compatible with the current engine configuration, i.e. that the engine has been configured in the same way as when the byte code was first compiled.

If the method returns asERROR it is either because the byte code is incorrect, e.g. corrupted due to disk failure, or it has been compiled with a different engine configuration. If possible the engine provides information about the type of error that caused the failure while loading the byte code to the message stream.

See also: Pre-compiled byte code

◆ RemoveFunction()

virtual int asIScriptModule::RemoveFunction ( asIScriptFunction * func )

pure virtual

Parameters

[in] func The pointer to the function that should be removed.

Returns: A negative value on error.

Return values

asNO_FUNCTION The function is not part of the scope.

This method allows the application to remove a single function from the scope of the module. The function is not destroyed immediately though, only when no more references point to it.

◆ RemoveGlobalVar()

virtual int asIScriptModule::RemoveGlobalVar ( asUINT index )

pure virtual

Parameters

[in] index The index of the global variable.

Returns: A negative value on error.

Return values

asINVALID_ARG The index is out of range.

The global variable is removed from the scope of the module, but it is not destroyed until all functions that access it are freed.

◆ ResetGlobalVars()

virtual int asIScriptModule::ResetGlobalVars ( asIScriptContext * ctx = 0 )

pure virtual

Parameters

[in] ctx Optional script context.

Returns: A negative value on error.

Return values

asERROR	The module was not compiled successfully.
asINIT_GLOBAL_VARS_FAILED	The initialization of the global variables failed.

Resets the global variables declared in this module to their initial value. The context should be informed if the application needs to have extra control over how the initialization is done, for example for debugging, or for catching exceptions.

◆ SaveByteCode()

virtual int asIScriptModule::SaveByteCode	(	asIBinaryStream *	out,
		bool	stripDebugInfo = `false`
	)		const

pure virtual

Parameters

[in]	out	The output stream.
[in]	stripDebugInfo	Set to true to skip saving the debug information.

Returns: A negative value on error.

Return values

asINVALID_ARG	The stream object wasn't specified.
asNOT_SUPPORTED	Compiler support is disabled in the engine.
asERROR	Nothing has been compiled in the module.

This method is used to save pre-compiled byte code to disk or memory, for a later restoral. The application must implement an object that inherits from asIBinaryStream to provide the necessary stream operations.

See also: Pre-compiled byte code

◆ SetAccessMask()

virtual asDWORD asIScriptModule::SetAccessMask ( asDWORD accessMask )

pure virtual

Parameters

[in] accessMask The access bit mask

Returns: The previous access mask.

The module's access mask with be bitwise and-ed with the registered entity's access mask in order to determine if the module is allowed to access the entity. If the result is zero then the script in the module will not be able to use the entity.

This can be used to provide different interfaces to scripts that serve different purposes in the application.

See also: Access masks and exposing different interfaces

◆ SetDefaultNamespace()

virtual int asIScriptModule::SetDefaultNamespace ( const char * nameSpace )

pure virtual

Parameters

[in] nameSpace The namespace that should be used.

Returns: A negative value on error.

Return values

asINVALID_ARG	The namespace is null.
asINVALID_DECLARATION	The namespace is invalid.

Set the default namespace that should be used in the following calls for searching for declared entities, or when compiling new individual entities.

◆ SetName()

virtual void asIScriptModule::SetName ( const char * name )

pure virtual

Parameters

[in] name The new name.

Sets the name of the script module.

◆ SetUserData()

virtual void* asIScriptModule::SetUserData	(	void *	data,
		asPWORD	type = `0`
	)

pure virtual

Parameters

[in]	data	A pointer to the user data.
[in]	type	An identifier specifying the user data to set.

Returns: The previous pointer stored in the module

This method allows the application to associate a value, e.g. a pointer, with the module instance.

The type values 1000 through 1999 are reserved for use by the official add-ons.

Optionally, a callback function can be registered to clean up the user data when the module is destroyed.

◆ UnbindAllImportedFunctions()

virtual int asIScriptModule::UnbindAllImportedFunctions ( )

pure virtual

Returns: A negative value on error.

Unbinds all imported functions in the module.

◆ UnbindImportedFunction()

virtual int asIScriptModule::UnbindImportedFunction ( asUINT importIndex )

pure virtual

Parameters

[in] importIndex The index of the imported function.

Returns: A negative value on error.

Return values

asINVALID_ARG The index is not valid.

Unbinds the imported function.

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

angelscript.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddScriptSection()

◆ BindAllImportedFunctions()

◆ BindImportedFunction()

◆ Build()

◆ CompileFunction()

◆ CompileGlobalVar()

◆ Discard()

◆ GetAddressOfGlobalVar()

◆ GetDefaultNamespace()

◆ GetEngine()

◆ GetEnumByIndex()

◆ GetEnumCount()

◆ GetFunctionByDecl()

◆ GetFunctionByIndex()

◆ GetFunctionByName()

◆ GetFunctionCount()

◆ GetGlobalVar()

◆ GetGlobalVarCount()

◆ GetGlobalVarDeclaration()

◆ GetGlobalVarIndexByDecl()

◆ GetGlobalVarIndexByName()

◆ GetImportedFunctionCount()

◆ GetImportedFunctionDeclaration()

◆ GetImportedFunctionIndexByDecl()

◆ GetImportedFunctionSourceModule()

◆ GetName()

◆ GetObjectTypeByIndex()

◆ GetObjectTypeCount()

◆ GetTypedefByIndex()

◆ GetTypedefCount()

◆ GetTypeIdByDecl()

◆ GetTypeInfoByDecl()

◆ GetTypeInfoByName()

◆ GetUserData()

◆ LoadByteCode()

◆ RemoveFunction()

◆ RemoveGlobalVar()

◆ ResetGlobalVars()

◆ SaveByteCode()

◆ SetAccessMask()

◆ SetDefaultNamespace()

◆ SetName()

◆ SetUserData()

◆ UnbindAllImportedFunctions()

◆ UnbindImportedFunction()