Inheritance diagram for OpenSim.Region.Framework.Interfaces.IScriptModule:

Collaboration diagram for OpenSim.Region.Framework.Interfaces.IScriptModule:

Public Member Functions
string	GetXMLState (UUID itemID)

bool	SetXMLState (UUID itemID, string xml)

bool	PostScriptEvent (UUID itemID, string name, Object[] args)
	Post a script event to a single script. More...

bool	PostObjectEvent (UUID itemID, string name, Object[] args)

void	SuspendScript (UUID itemID)
	Suspends a script. More...

void	ResumeScript (UUID itemID)
	Resumes a script. More...

ArrayList	GetScriptErrors (UUID itemID)

bool	HasScript (UUID itemID, out bool running)

bool	GetScriptState (UUID itemID)
	Returns true if a script is running. More...

void	SaveAllState ()

void	StartProcessing ()
	Starts the processing threads. More...

float	GetScriptExecutionTime (List< UUID > itemIDs)
	Get the execution times of all scripts in the given array if they are currently running. More...

Dictionary< uint, float >	GetObjectScriptsExecutionTimes ()
	Get the execution times of all scripts in each object. More...

Public Member Functions inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
void	Initialise (IConfigSource source)
	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	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. 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...

Properties
string	ScriptEngineName `[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
ScriptRemoved	OnScriptRemoved
	Triggered when a script is removed from the script module. More...

ObjectRemoved	OnObjectRemoved
	Triggered when an object is removed via the script module. More...

Detailed Description

Definition at line 38 of file IScriptModule.cs.

Member Function Documentation

Dictionary<uint, float> OpenSim.Region.Framework.Interfaces.IScriptModule.GetObjectScriptsExecutionTimes ( )

Get the execution times of all scripts in each object.

Returns: A dictionary where the key is the root object ID of a linkset and the value is a representative execution time in milliseconds of all scripts in that linkset.

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.

ArrayList OpenSim.Region.Framework.Interfaces.IScriptModule.GetScriptErrors ( UUID itemID )

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.

float OpenSim.Region.Framework.Interfaces.IScriptModule.GetScriptExecutionTime ( List< UUID > itemIDs )

Get the execution times of all scripts in the given array if they are currently running.

Returns: A float the value is a representative execution time in milliseconds of all scripts in that Array.

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.

bool OpenSim.Region.Framework.Interfaces.IScriptModule.GetScriptState ( UUID itemID )

Returns true if a script is running.

Parameters

itemID The item ID of the script.

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.

Here is the caller graph for this function:

string OpenSim.Region.Framework.Interfaces.IScriptModule.GetXMLState ( UUID itemID )

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.

bool OpenSim.Region.Framework.Interfaces.IScriptModule.HasScript	(	UUID	itemID,
		out bool	running
	)

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.

Here is the caller graph for this function:

bool OpenSim.Region.Framework.Interfaces.IScriptModule.PostObjectEvent	(	UUID	itemID,
		string	name,
		Object[]	args
	)

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine.

bool OpenSim.Region.Framework.Interfaces.IScriptModule.PostScriptEvent	(	UUID	itemID,
		string	name,
		Object[]	args
	)

Post a script event to a single script.

Returns: true if the post suceeded, false if it did not

Parameters

itemID	The item ID of the script.
name	The name of the event.
args	The arguments of the event. These are in the order in which they appear. e.g. for http_request this will be an object array of key request_id, string method, string body

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine.

void OpenSim.Region.Framework.Interfaces.IScriptModule.ResumeScript ( UUID itemID )

Resumes a script.

Parameters

itemID The item ID of the script.

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.

void OpenSim.Region.Framework.Interfaces.IScriptModule.SaveAllState ( )

Implemented in OpenSim.Region.ScriptEngine.XEngine.XEngine, and OpenSim.Tests.Common.MockScriptEngine.