Inheritance diagram for OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule:

Collaboration diagram for OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule:

Classes
class	ScriptInvocationData

Public Member Functions
void	Initialise (IConfigSource config)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	RaiseEvent (UUID script, string id, string module, string command, string k)

void	DispatchReply (UUID script, int code, string text, string k)
	Send a link_message event to an in-world script More...

void	RegisterScriptInvocation (object target, string meth)
	Register an instance method as a script call by method name More...

void	RegisterScriptInvocation (object target, string[] meth)
	Register one or more instance methods as script calls by method name More...

void	RegisterScriptInvocation (object target, MethodInfo mi)
	Register a static or instance method as a script call by method info More...

void	RegisterScriptInvocation (Type target, string[] methods)
	Register one or more static methods as script calls by method name More...

void	RegisterScriptInvocations (IRegionModuleBase target)
	Automatically register script invocations by checking for methods with ScriptInvocationAttribute. Should only check public methods. More...

Delegate[]	GetScriptInvocationList ()
	Returns an array of all registered script calls More...

string	LookupModInvocation (string fname)

Delegate	LookupScriptInvocation (string fname)

Type[]	LookupTypeSignature (string fname)

Type	LookupReturnType (string fname)

object	InvokeOperation (UUID hostid, UUID scriptid, string fname, params object[] parms)

void	RegisterConstant (string cname, object value)
	Operation to for a region module to register a constant to be used by the script engine More...

void	RegisterConstants (IRegionModuleBase target)
	Automatically register all constants on a region module by checking for fields with ScriptConstantAttribute. More...

object	LookupModConstant (string cname)
	Operation to check for a registered constant More...

Dictionary< string, object >	GetConstants ()
	Get all registered constants More...

Properties
string	Name `[get]`

Type	ReplaceableInterface `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Events
ScriptCommand	OnScriptCommand

Events inherited from OpenSim.Region.Framework.Interfaces.IScriptModuleComms
ScriptCommand	OnScriptCommand
	Modules can subscribe to this event to receive command invocations from in-world scripts More...

Detailed Description

Definition at line 44 of file ScriptModuleCommsModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 80 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 107 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.DispatchReply	(	UUID	scriptId,
		int	code,
		string	text,
		string	key
	)

inline

Send a link_message event to an in-world script

Parameters

scriptId
code
text
key

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 124 of file ScriptModuleCommsModule.cs.

Dictionary<string, object> OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.GetConstants ( )

inline

Get all registered constants

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 378 of file ScriptModuleCommsModule.cs.

Delegate [] OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.GetScriptInvocationList ( )

inline

Returns an array of all registered script calls

Returns

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 241 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.Initialise ( IConfigSource source )

inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 76 of file ScriptModuleCommsModule.cs.

object OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.InvokeOperation	(	UUID	hostid,
		UUID	scriptid,
		string	fname,
		params object[]	parms
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 320 of file ScriptModuleCommsModule.cs.

object OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.LookupModConstant ( string cname )

inline

Operation to check for a registered constant

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 361 of file ScriptModuleCommsModule.cs.

string OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.LookupModInvocation ( string fname )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 253 of file ScriptModuleCommsModule.cs.

Type OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.LookupReturnType ( string fname )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 308 of file ScriptModuleCommsModule.cs.

Delegate OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.LookupScriptInvocation ( string fname )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 284 of file ScriptModuleCommsModule.cs.

Type [] OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.LookupTypeSignature ( string fname )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 296 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RaiseEvent	(	UUID	script,
		string	id,
		string	module,
		string	command,
		string	k
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 114 of file ScriptModuleCommsModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 89 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegisterConstant	(	string	cname,
		object	value
	)

inline

Operation to for a region module to register a constant to be used by the script engine

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 335 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegisterConstants ( IRegionModuleBase target )

inline

Automatically register all constants on a region module by checking for fields with ScriptConstantAttribute.

Parameters

target

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 344 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegisterScriptInvocation	(	object	target,
		string	method
	)

inline

Register an instance method as a script call by method name

Parameters

target
method

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 147 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegisterScriptInvocation	(	object	target,
		string[]	methods
	)

inline

Register one or more instance methods as script calls by method name

Parameters

target
methods

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 159 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegisterScriptInvocation	(	object	target,
		MethodInfo	method
	)

inline

Register a static or instance method as a script call by method info

Parameters

target	If target is a Type object, will assume method is static.
method

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 165 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegisterScriptInvocation	(	Type	target,
		string[]	methods
	)

inline

Register one or more static methods as script calls by method name

Parameters

target
methods

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 212 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RegisterScriptInvocations ( IRegionModuleBase target )

inline

Automatically register script invocations by checking for methods with ScriptInvocationAttribute. Should only check public methods.

Parameters

target

Implements OpenSim.Region.Framework.Interfaces.IScriptModuleComms.

Definition at line 224 of file ScriptModuleCommsModule.cs.

void OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 85 of file ScriptModuleCommsModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.Name

get

Definition at line 98 of file ScriptModuleCommsModule.cs.

Type OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.ReplaceableInterface

get

Definition at line 103 of file ScriptModuleCommsModule.cs.

Event Documentation

ScriptCommand OpenSim.Region.CoreModules.Scripting.ScriptModuleComms.ScriptModuleCommsModule.OnScriptCommand

Definition at line 73 of file ScriptModuleCommsModule.cs.

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

Region/CoreModules/Scripting/ScriptModuleComms/ScriptModuleCommsModule.cs

Classes

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation