OpenSim.Region.ScriptEngine.XEngine.XEngine Class Reference

Inheritance diagram for OpenSim.Region.ScriptEngine.XEngine.XEngine:

Collaboration diagram for OpenSim.Region.ScriptEngine.XEngine.XEngine:

Public Member Functions
void	Initialise (IConfigSource configSource)
	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...
string	GetStatusReport ()
void	HandleShowScripts (string module, string[] cmdparams)
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	StartProcessing ()
	Starts the processing threads. More...
void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
object	DoBackup (object o)
void	SaveAllState ()
object	DoMaintenance (object p)
void	OnRezScript (uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource)
Object	DoOnRezScriptQueue (Object dummy)
void	OnRemoveScript (uint localID, UUID itemID)
void	OnScriptReset (uint localID, UUID itemID)
void	OnStartScript (uint localID, UUID itemID)
void	OnStopScript (uint localID, UUID itemID)
IScriptWorkItem	QueueEventHandler (object parms)
	Queue an event for execution More...
bool	PostObjectEvent (uint localID, EventParams p)
	Post event to an entire prim More...
bool	PostScriptEvent (UUID itemID, EventParams p)
	Post an event to a single script More...
bool	PostScriptEvent (UUID itemID, string name, Object[] p)
	Post a script event to a single script. More...
bool	PostObjectEvent (UUID itemID, string name, Object[] p)
Assembly	OnAssemblyResolve (object sender, ResolveEventArgs args)
void	SetScriptState (UUID itemID, bool running)
bool	GetScriptState (UUID itemID)
	Returns true if a script is running. More...
void	ApiResetScript (UUID itemID)
void	ResetScript (UUID itemID)
void	StartScript (UUID itemID)
void	StopScript (UUID itemID)
DetectParams	GetDetectParams (UUID itemID, int idx)
void	SetMinEventDelay (UUID itemID, double delay)
UUID	GetDetectID (UUID itemID, int idx)
void	SetState (UUID itemID, string newState)
int	GetStartParameter (UUID itemID)
void	OnShutdown ()
IScriptApi	GetApi (UUID itemID, string name)
void	OnGetScriptRunning (IClientAPI controllingClient, UUID objectID, UUID itemID)
string	GetXMLState (UUID itemID)
bool	SetXMLState (UUID itemID, string xml)
ArrayList	GetScriptErrors (UUID itemID)
Dictionary< uint, float >	GetObjectScriptsExecutionTimes ()
	Get the execution times of all scripts in each object. More...
float	GetScriptExecutionTime (List< UUID > itemIDs)
	Get the execution times of all scripts in the given array if they are currently running. More...
void	SuspendScript (UUID itemID)
	Suspends a script. More...
void	ResumeScript (UUID itemID)
	Resumes a script. More...
bool	HasScript (UUID itemID, out bool running)
void	SleepScript (UUID itemID, int delay)

Properties
int	DebugLevel [get, set]
	Control the printing of certain debug messages. More...
bool	HaveNotifiedLogOfScriptStopMistmatch [get, set]
	A parameter to allow us to notify the log if at least one script has a compilation that is not compatible with ScriptStopStrategy. More...
string	ScriptEngineName [get]
string	ScriptClassName [get, set]
string	ScriptBaseClassName [get, set]
ParameterInfo[]	ScriptBaseClassParameters [get, set]
string[]	ScriptReferencedAssemblies [get, set]
Scene	World [get]
static List< XEngine >	ScriptEngines [get]
IScriptModule	ScriptModule [get]
IConfig	Config [get]
string	ScriptEnginePath [get]
IConfigSource	ConfigSource [get]
Type	ReplaceableInterface [get]
string	Name [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...
Properties inherited from OpenSim.Region.Framework.Interfaces.IScriptModule
string	ScriptEngineName [get]
Properties inherited from OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine
Scene	World [get]
IScriptModule	ScriptModule [get]
IConfig	Config [get]
IConfigSource	ConfigSource [get]
string	ScriptEngineName [get]
string	ScriptEnginePath [get]
string	ScriptClassName [get]
	Return the name of the class that will be used for all running scripts. More...
string	ScriptBaseClassName [get]
	Return the name of the base class that will be used for all running scripts. More...
string[]	ScriptReferencedAssemblies [get]
	Assemblies that need to be referenced when compiling scripts. More...
ParameterInfo[]	ScriptBaseClassParameters [get]
	Parameters for the generated script's constructor. More...

Events
ScriptRemoved	OnScriptRemoved
	Event fired after the script engine has finished removing a script. More...
ObjectRemoved	OnObjectRemoved
	Event fired after the script engine has finished removing a script from an object. More...
Events inherited from OpenSim.Region.Framework.Interfaces.IScriptModule
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 65 of file XEngine.cs.

Member Function Documentation

void OpenSim.Region.ScriptEngine.XEngine.XEngine.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 277 of file XEngine.cs.

Here is the call graph for this function:

void OpenSim.Region.ScriptEngine.XEngine.XEngine.ApiResetScript ( UUID  itemID )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1872 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.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 814 of file XEngine.cs.

object OpenSim.Region.ScriptEngine.XEngine.XEngine.DoBackup ( object  o )

inline

Definition at line 826 of file XEngine.cs.

object OpenSim.Region.ScriptEngine.XEngine.XEngine.DoMaintenance ( object  p )

inline

Definition at line 881 of file XEngine.cs.

Here is the call graph for this function:

Object OpenSim.Region.ScriptEngine.XEngine.XEngine.DoOnRezScriptQueue ( Object  dummy )

inline

Definition at line 1043 of file XEngine.cs.

IScriptApi OpenSim.Region.ScriptEngine.XEngine.XEngine.GetApi ( UUID  itemID, string  name  )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1998 of file XEngine.cs.

UUID OpenSim.Region.ScriptEngine.XEngine.XEngine.GetDetectID ( UUID  itemID, int  idx  )

inline

Definition at line 1950 of file XEngine.cs.

DetectParams OpenSim.Region.ScriptEngine.XEngine.XEngine.GetDetectParams ( UUID  itemID, int  idx  )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1937 of file XEngine.cs.

Dictionary<uint, float> OpenSim.Region.ScriptEngine.XEngine.XEngine.GetObjectScriptsExecutionTimes ( )

inline

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.

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2349 of file XEngine.cs.

ArrayList OpenSim.Region.ScriptEngine.XEngine.XEngine.GetScriptErrors ( UUID  itemID )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2333 of file XEngine.cs.

float OpenSim.Region.ScriptEngine.XEngine.XEngine.GetScriptExecutionTime ( List< UUID >  itemIDs )

inline

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.

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2367 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.GetScriptState ( UUID  itemID )

inline

Returns true if a script is running.

Parameters

itemID

The item ID of the script.

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 1866 of file XEngine.cs.

int OpenSim.Region.ScriptEngine.XEngine.XEngine.GetStartParameter ( UUID  itemID )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1964 of file XEngine.cs.

string OpenSim.Region.ScriptEngine.XEngine.XEngine.GetStatusReport ( )

inline

Definition at line 561 of file XEngine.cs.

string OpenSim.Region.ScriptEngine.XEngine.XEngine.GetXMLState ( UUID  itemID )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2022 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.HandleShowScripts ( string  module, string[]  cmdparams  )

inline

Definition at line 605 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.HasScript ( UUID  itemID, out bool  running  )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2427 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.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 248 of file XEngine.cs.

Assembly OpenSim.Region.ScriptEngine.XEngine.XEngine.OnAssemblyResolve ( object  sender, ResolveEventArgs  args  )

inline

Definition at line 1814 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.OnGetScriptRunning ( IClientAPI  controllingClient, UUID  objectID, UUID  itemID  )

inline

Definition at line 2004 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.OnRemoveScript ( uint  localID, UUID  itemID  )

inline

Definition at line 1531 of file XEngine.cs.

Here is the call graph for this function:

void OpenSim.Region.ScriptEngine.XEngine.XEngine.OnRezScript ( uint  localID, UUID  itemID, string  script, int  startParam, bool  postOnRez, string  engine, int  stateSource  )

inline

Definition at line 914 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.OnScriptReset ( uint  localID, UUID  itemID  )

inline

Definition at line 1590 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.OnShutdown ( )

inline

Definition at line 1970 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.OnStartScript ( uint  localID, UUID  itemID  )

inline

Definition at line 1595 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.OnStopScript ( uint  localID, UUID  itemID  )

inline

Definition at line 1600 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.PostObjectEvent ( uint  localID, EventParams  p  )

inline

Post event to an entire prim

Parameters

localID
p

Returns

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1715 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.PostObjectEvent ( UUID  itemID, string  name, Object[]  p  )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 1788 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.PostScriptEvent ( UUID  itemID, EventParams  p  )

inline

Post an event to a single script

Parameters

itemID
p

Returns

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1754 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.PostScriptEvent ( UUID  itemID, string  name, Object[]  args  )

inline

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

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 1766 of file XEngine.cs.

IScriptWorkItem OpenSim.Region.ScriptEngine.XEngine.XEngine.QueueEventHandler ( object  parms )

inline

Queue an event for execution

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1686 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.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 776 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.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 713 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.ResetScript ( UUID  itemID )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1885 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.ResumeScript ( UUID  itemID )

inline

Resumes a script.

Parameters

itemID

The item ID of the script.

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2410 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.SaveAllState ( )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 876 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.SetMinEventDelay ( UUID  itemID, double  delay  )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1943 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.SetScriptState ( UUID  itemID, bool  running  )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1854 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.SetState ( UUID  itemID, string  newState  )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 1956 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.SetXMLState ( UUID  itemID, string  xml  )

inline

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2182 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.SleepScript ( UUID  itemID, int  delay  )

inline

Implements OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.

Definition at line 2439 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.StartProcessing ( )

inline

Starts the processing threads.

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 809 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.StartScript ( UUID  itemID )

inline

Definition at line 1898 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.StopScript ( UUID  itemID )

inline

Definition at line 1913 of file XEngine.cs.

void OpenSim.Region.ScriptEngine.XEngine.XEngine.SuspendScript ( UUID  itemID )

inline

Suspends a script.

Parameters

itemID

The item ID of the script.

Implements OpenSim.Region.Framework.Interfaces.IScriptModule.

Definition at line 2393 of file XEngine.cs.

Property Documentation

IConfig OpenSim.Region.ScriptEngine.XEngine.XEngine.Config

get

Definition at line 224 of file XEngine.cs.

IConfigSource OpenSim.Region.ScriptEngine.XEngine.XEngine.ConfigSource

get

Definition at line 234 of file XEngine.cs.

int OpenSim.Region.ScriptEngine.XEngine.XEngine.DebugLevel

getset

Control the printing of certain debug messages.

If DebugLevel >= 1, then we log every time that a script is started.

Definition at line 75 of file XEngine.cs.

bool OpenSim.Region.ScriptEngine.XEngine.XEngine.HaveNotifiedLogOfScriptStopMistmatch

getset

A parameter to allow us to notify the log if at least one script has a compilation that is not compatible with ScriptStopStrategy.

Definition at line 81 of file XEngine.cs.

string OpenSim.Region.ScriptEngine.XEngine.XEngine.Name

get

Definition at line 910 of file XEngine.cs.

Type OpenSim.Region.ScriptEngine.XEngine.XEngine.ReplaceableInterface

get

Definition at line 905 of file XEngine.cs.

string OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptBaseClassName

getset

Definition at line 195 of file XEngine.cs.

ParameterInfo [] OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptBaseClassParameters

getset

Definition at line 197 of file XEngine.cs.

string OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptClassName

getset

Definition at line 193 of file XEngine.cs.

string OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptEngineName

get

Definition at line 189 of file XEngine.cs.

string OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptEnginePath

get

Definition at line 229 of file XEngine.cs.

List<XEngine> OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptEngines

staticget

Definition at line 207 of file XEngine.cs.

IScriptModule OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptModule

get

Definition at line 212 of file XEngine.cs.

string [] OpenSim.Region.ScriptEngine.XEngine.XEngine.ScriptReferencedAssemblies

getset

Definition at line 199 of file XEngine.cs.

Scene OpenSim.Region.ScriptEngine.XEngine.XEngine.World

get

Definition at line 202 of file XEngine.cs.

Event Documentation

ObjectRemoved OpenSim.Region.ScriptEngine.XEngine.XEngine.OnObjectRemoved

Event fired after the script engine has finished removing a script from an object.

Definition at line 246 of file XEngine.cs.

ScriptRemoved OpenSim.Region.ScriptEngine.XEngine.XEngine.OnScriptRemoved

Event fired after the script engine has finished removing a script.

Definition at line 241 of file XEngine.cs.

---

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

• Region/ScriptEngine/XEngine/XEngine.cs