OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine Interface Reference

An interface for a script API module to communicate with the engine it's running under More...

Inheritance diagram for OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine:

Public Member Functions
IScriptWorkItem	QueueEventHandler (object parms)
	Queue an event for execution More...
bool	PostScriptEvent (UUID itemID, EventParams parms)
	Post an event to a single script More...
bool	PostObjectEvent (uint localID, EventParams parms)
	Post event to an entire prim More...
DetectParams	GetDetectParams (UUID item, int number)
void	SetMinEventDelay (UUID itemID, double delay)
int	GetStartParameter (UUID itemID)
void	SetScriptState (UUID itemID, bool state)
bool	GetScriptState (UUID itemID)
void	SetState (UUID itemID, string newState)
void	ApiResetScript (UUID itemID)
void	ResetScript (UUID itemID)
IScriptApi	GetApi (UUID itemID, string name)
void	SleepScript (UUID itemID, int delay)

Properties
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...

Detailed Description

An interface for a script API module to communicate with the engine it's running under

Definition at line 46 of file IScriptEngine.cs.

Member Function Documentation

void OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ApiResetScript

(

UUID

itemID

)

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

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

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

DetectParams OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.GetDetectParams	(	UUID	item,
		int	number
	)

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

bool OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.GetScriptState

(

UUID

itemID

)

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

int OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.GetStartParameter

(

UUID

itemID

)

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

bool OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.PostObjectEvent	(	uint	localID,
		EventParams	parms
	)

Post event to an entire prim

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

Here is the caller graph for this function:

bool OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.PostScriptEvent	(	UUID	itemID,
		EventParams	parms
	)

Post an event to a single script

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

Here is the caller graph for this function:

IScriptWorkItem OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.QueueEventHandler

(

object

parms

)

Queue an event for execution

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

void OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ResetScript

(

UUID

itemID

)

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

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

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

void OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.SetScriptState	(	UUID	itemID,
		bool	state
	)

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

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

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

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

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

Property Documentation

IConfig OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.Config

get

Definition at line 76 of file IScriptEngine.cs.

IConfigSource OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ConfigSource

get

Definition at line 77 of file IScriptEngine.cs.

string OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ScriptBaseClassName

get

Return the name of the base class that will be used for all running scripts.

Definition at line 92 of file IScriptEngine.cs.

ParameterInfo [] OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ScriptBaseClassParameters

get

Parameters for the generated script's constructor.

Can be null if there are no parameters

Definition at line 110 of file IScriptEngine.cs.

string OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ScriptClassName

get

Return the name of the class that will be used for all running scripts.

Each class goes in its own assembly so we don't need to otherwise distinguish the class name.

Definition at line 87 of file IScriptEngine.cs.

string OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ScriptEngineName

get

Definition at line 78 of file IScriptEngine.cs.

string OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ScriptEnginePath

get

Definition at line 79 of file IScriptEngine.cs.

IScriptModule OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ScriptModule

get

Definition at line 55 of file IScriptEngine.cs.

string [] OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.ScriptReferencedAssemblies

get

Assemblies that need to be referenced when compiling scripts.

These are currently additional to those always referenced by the compiler, BUT THIS MAY CHANGE IN THE FUTURE. This can be null if there are no additional assemblies.

Definition at line 102 of file IScriptEngine.cs.

Scene OpenSim.Region.ScriptEngine.Interfaces.IScriptEngine.World

get

Definition at line 53 of file IScriptEngine.cs.

---

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

• Region/ScriptEngine/Interfaces/IScriptEngine.cs