OpenSim.Framework.IScene Interface Reference

Inheritance diagram for OpenSim.Framework.IScene:

Public Member Functions
ISceneAgent	AddNewAgent (IClientAPI client, PresenceType type)
	Add a new agent with an attached client. All agents except initial login clients will starts off as a child agent More...
bool	CloseAgent (UUID agentID, bool force)
	Tell a single agent to disconnect from the region. More...
void	Restart ()
string	GetSimulatorVersion ()
bool	TryGetScenePresence (UUID agentID, out object scenePresence)
void	RegisterModuleInterface< M > (M mod)
	Register an interface to a region module. This allows module methods to be called directly as well as via events. If there is already a module registered for this interface, it is not replaced (is this the best behaviour?) More...
void	StackModuleInterface< M > (M mod)
T	RequestModuleInterface< T > ()
	For the given interface, retrieve the region module which implements it. More...
T[]	RequestModuleInterfaces< T > ()
	For the given interface, retrieve an array of region modules that implement it. More...
ISceneObject	DeserializeObject (string representation)
bool	CheckClient (UUID agentID, System.Net.IPEndPoint ep)
void	Start ()
	Start the scene and associated scripts within it. More...

Properties
string	Name [get]
	The name of this scene. More...
RegionInfo	RegionInfo [get]
RegionStatus	RegionStatus [get, set]
IConfigSource	Config [get]
bool	LoginsEnabled [get, set]
	Are logins enabled on this simulator? More...
bool	Ready [get, set]
	Is this region ready for use? More...
float	TimeDilation [get]
bool	AllowScriptCrossings [get]

Events
restart	OnRestart

Detailed Description

Definition at line 57 of file IScene.cs.

Member Function Documentation

ISceneAgent OpenSim.Framework.IScene.AddNewAgent	(	IClientAPI	client,
		PresenceType	type
	)

Add a new agent with an attached client. All agents except initial login clients will starts off as a child agent

• the later agent crossing will promote it to a root agent.

Parameters

client
type	The type of agent to add.

Returns

The scene agent if the new client was added or if an agent that already existed.

Implemented in OpenSim.Region.Framework.Scenes.Scene, and OpenSim.Region.Framework.Scenes.SceneBase.

bool OpenSim.Framework.IScene.CheckClient	(	UUID	agentID,
		System.Net.IPEndPoint	ep
	)

Implemented in OpenSim.Region.Framework.Scenes.Scene, and OpenSim.Region.Framework.Scenes.SceneBase.

bool OpenSim.Framework.IScene.CloseAgent	(	UUID	agentID,
		bool	force
	)

Tell a single agent to disconnect from the region.

Parameters

agentID
force	Force the agent to close even if it might be in the middle of some other operation. You do not want to force unless you are absolutely sure that the agent is dead and a normal close is not working.

Implemented in OpenSim.Region.Framework.Scenes.Scene, and OpenSim.Region.Framework.Scenes.SceneBase.

ISceneObject OpenSim.Framework.IScene.DeserializeObject

(

string

representation

)

Implemented in OpenSim.Region.Framework.Scenes.Scene, and OpenSim.Region.Framework.Scenes.SceneBase.

string OpenSim.Framework.IScene.GetSimulatorVersion

(

)

Implemented in OpenSim.Region.Framework.Scenes.Scene, and OpenSim.Region.Framework.Scenes.SceneBase.

void OpenSim.Framework.IScene.RegisterModuleInterface< M >

(

M

mod

)

Register an interface to a region module. This allows module methods to be called directly as well as via events. If there is already a module registered for this interface, it is not replaced (is this the best behaviour?)

Parameters

mod

Implemented in OpenSim.Region.Framework.Scenes.SceneBase.

T OpenSim.Framework.IScene.RequestModuleInterface< T >

(

)

For the given interface, retrieve the region module which implements it.

Returns

null if there is no registered module implementing that interface

Implemented in OpenSim.Region.Framework.Scenes.SceneBase.

T [] OpenSim.Framework.IScene.RequestModuleInterfaces< T >

(

)

For the given interface, retrieve an array of region modules that implement it.

Returns

an empty array if there are no registered modules implementing that interface

Implemented in OpenSim.Region.Framework.Scenes.SceneBase.

void OpenSim.Framework.IScene.Restart

(

)

Implemented in OpenSim.Region.Framework.Scenes.SceneBase.

void OpenSim.Framework.IScene.StackModuleInterface< M >

(

M

mod

)

Implemented in OpenSim.Region.Framework.Scenes.SceneBase.

void OpenSim.Framework.IScene.Start

(

)

Start the scene and associated scripts within it.

Implemented in OpenSim.Region.Framework.Scenes.Scene, and OpenSim.Region.Framework.Scenes.SceneBase.

bool OpenSim.Framework.IScene.TryGetScenePresence	(	UUID	agentID,
		out object	scenePresence
	)

Implemented in OpenSim.Region.Framework.Scenes.SceneBase.

Here is the caller graph for this function:

Property Documentation

bool OpenSim.Framework.IScene.AllowScriptCrossings

get

Definition at line 84 of file IScene.cs.

IConfigSource OpenSim.Framework.IScene.Config

get

Definition at line 67 of file IScene.cs.

bool OpenSim.Framework.IScene.LoginsEnabled

getset

Are logins enabled on this simulator?

Definition at line 72 of file IScene.cs.

string OpenSim.Framework.IScene.Name

get

The name of this scene.

Definition at line 62 of file IScene.cs.

bool OpenSim.Framework.IScene.Ready

getset

Is this region ready for use?

This does not mean that logins are enabled, merely that they can be.

Definition at line 80 of file IScene.cs.

RegionInfo OpenSim.Framework.IScene.RegionInfo

get

Definition at line 64 of file IScene.cs.

RegionStatus OpenSim.Framework.IScene.RegionStatus

getset

Definition at line 65 of file IScene.cs.

float OpenSim.Framework.IScene.TimeDilation

get

Definition at line 82 of file IScene.cs.

Event Documentation

restart OpenSim.Framework.IScene.OnRestart

Definition at line 86 of file IScene.cs.

---

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

• Framework/IScene.cs