Inheritance diagram for OpenSim.Region.CoreModules.World.Estate.EstateManagementModule:

Collaboration diagram for OpenSim.Region.CoreModules.World.Estate.EstateManagementModule:

Public Member Functions
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	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...

uint	GetRegionFlags ()

bool	IsManager (UUID avatarID)

void	sendRegionHandshakeToAll ()
	Tell all clients about the current state of the region (terrain textures, water height, etc.). More...

void	TriggerEstateInfoChange ()

void	TriggerRegionInfoChange ()
	Fires the OnRegionInfoChange event. More...

void	setEstateTerrainBaseTexture (int level, UUID texture)

void	setEstateTerrainTextureHeights (int corner, float lowValue, float highValue)

bool	IsTerrainXfer (ulong xferID)
	Returns whether the transfer ID is being used for a terrain transfer. More...

string	SetEstateOwner (int estateID, UserAccount account)

string	SetEstateName (int estateID, string newName)

string	SetRegionEstate (RegionInfo regionInfo, int estateID)

string	CreateEstate (string estateName, UUID ownerID)

void	setEstateTerrainBaseTexture (IClientAPI remoteClient, int level, UUID texture)

void	setEstateTerrainTextureHeights (IClientAPI client, int corner, float lowValue, float highValue)

void	setRegionTerrainSettings (float WaterHeight, float TerrainRaiseLimit, float TerrainLowerLimit, bool UseEstateSun, bool UseFixedSun, float SunHour, bool UseGlobal, bool EstateFixedSun, float EstateSunHour)

void	HandleOnEstateManageTelehub (IClientAPI client, UUID invoice, UUID senderID, string cmd, uint param1)

void	sendRegionInfoPacketToAll ()

void	sendRegionHandshake (IClientAPI remoteClient)

void	handleEstateChangeInfo (IClientAPI remoteClient, UUID invoice, UUID senderID, UInt32 parms1, UInt32 parms2)

void	changeWaterHeight (float height)

uint	GetEstateFlags ()

void	TriggerEstateMessage (UUID fromID, string fromName, string message)

Public Attributes
TelehubManager	m_Telehub

Protected Member Functions
void	RaiseRegionInfoChange (object sender, ElapsedEventArgs e)

Protected Attributes
EstateManagementCommands	m_commands

Properties
Scene	Scene `[get, set]`

IUserManagement	UserManager `[get, set]`

bool	AllowRegionRestartFromClient `[get, set]`
	If false, region restart requests from the client are blocked even if they are otherwise legitimate. More...

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
ChangeDelegate	OnRegionInfoChange

ChangeDelegate	OnEstateInfoChange

MessageDelegate	OnEstateMessage

Events inherited from OpenSim.Region.Framework.Interfaces.IEstateModule
ChangeDelegate	OnRegionInfoChange

ChangeDelegate	OnEstateInfoChange

MessageDelegate	OnEstateMessage

Detailed Description

Definition at line 49 of file EstateManagementModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.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 89 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.changeWaterHeight ( float height )

inline

Definition at line 1462 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.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 117 of file EstateManagementModule.cs.

string OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.CreateEstate	(	string	estateName,
		UUID	ownerID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 371 of file EstateManagementModule.cs.

uint OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.GetEstateFlags ( )

inline

Definition at line 1509 of file EstateManagementModule.cs.

uint OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.GetRegionFlags ( )

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 125 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.handleEstateChangeInfo	(	IClientAPI	remoteClient,
		UUID	invoice,
		UUID	senderID,
		UInt32	parms1,
		UInt32	parms2
	)

inline

Definition at line 1396 of file EstateManagementModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.HandleOnEstateManageTelehub	(	IClientAPI	client,
		UUID	invoice,
		UUID	senderID,
		string	cmd,
		uint	param1
	)

inline

Definition at line 989 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.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 79 of file EstateManagementModule.cs.

bool OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.IsManager ( UUID avatarID )

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 182 of file EstateManagementModule.cs.

bool OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.IsTerrainXfer ( ulong xferID )

inline

Returns whether the transfer ID is being used for a terrain transfer.

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 237 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.RaiseRegionInfoChange	(	object	sender,
		ElapsedEventArgs	e
	)

inlineprotected

Definition at line 207 of file EstateManagementModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.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 108 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.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 106 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.sendRegionHandshake ( IClientAPI remoteClient )

inline

Definition at line 1356 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.sendRegionHandshakeToAll ( )

inline

Tell all clients about the current state of the region (terrain textures, water height, etc.).

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 194 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.sendRegionInfoPacketToAll ( )

inline

Definition at line 1348 of file EstateManagementModule.cs.

string OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.SetEstateName	(	int	estateID,
		string	newName
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 287 of file EstateManagementModule.cs.

Here is the call graph for this function:

string OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.SetEstateOwner	(	int	estateID,
		UserAccount	account
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 248 of file EstateManagementModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.setEstateTerrainBaseTexture	(	int	level,
		UUID	texture
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 226 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.setEstateTerrainBaseTexture	(	IClientAPI	remoteClient,
		int	level,
		UUID	texture
	)

inline

Definition at line 511 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.setEstateTerrainTextureHeights	(	int	corner,
		float	lowValue,
		float	highValue
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 232 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.setEstateTerrainTextureHeights	(	IClientAPI	client,
		int	corner,
		float	lowValue,
		float	highValue
	)

inline

Definition at line 537 of file EstateManagementModule.cs.

string OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.SetRegionEstate	(	RegionInfo	regionInfo,
		int	estateID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 334 of file EstateManagementModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.setRegionTerrainSettings	(	float	WaterHeight,
		float	TerrainRaiseLimit,
		float	TerrainLowerLimit,
		bool	UseEstateSun,
		bool	UseFixedSun,
		float	SunHour,
		bool	UseGlobal,
		bool	EstateFixedSun,
		float	EstateSunHour
	)

inline

Definition at line 570 of file EstateManagementModule.cs.

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.TriggerEstateInfoChange ( )

inline

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 199 of file EstateManagementModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.TriggerEstateMessage	(	UUID	fromID,
		string	fromName,
		string	message
	)

inline

Definition at line 1550 of file EstateManagementModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.TriggerRegionInfoChange ( )

inline

Fires the OnRegionInfoChange event.

Implements OpenSim.Region.Framework.Interfaces.IEstateModule.

Definition at line 215 of file EstateManagementModule.cs.

Here is the call graph for this function:

Member Data Documentation

EstateManagementCommands OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.m_commands

protected

Definition at line 57 of file EstateManagementModule.cs.

TelehubManager OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.m_Telehub

Definition at line 65 of file EstateManagementModule.cs.

Property Documentation

bool OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.AllowRegionRestartFromClient

getset

If false, region restart requests from the client are blocked even if they are otherwise legitimate.

Definition at line 62 of file EstateManagementModule.cs.

string OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.Name

get

Definition at line 75 of file EstateManagementModule.cs.

Type OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.ReplaceableInterface

get

Definition at line 77 of file EstateManagementModule.cs.

Scene OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.Scene

getset

Definition at line 54 of file EstateManagementModule.cs.

IUserManagement OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.UserManager

getset

Definition at line 55 of file EstateManagementModule.cs.

Event Documentation

ChangeDelegate OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.OnEstateInfoChange

Definition at line 68 of file EstateManagementModule.cs.

MessageDelegate OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.OnEstateMessage

Definition at line 69 of file EstateManagementModule.cs.

ChangeDelegate OpenSim.Region.CoreModules.World.Estate.EstateManagementModule.OnRegionInfoChange

Definition at line 67 of file EstateManagementModule.cs.

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

Region/CoreModules/World/Estate/EstateManagementModule.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation