Inheritance diagram for OpenSim.Region.RegionCombinerModule.RegionCombinerModule:

Collaboration diagram for OpenSim.Region.RegionCombinerModule.RegionCombinerModule:

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

bool	IsRootForMegaregion (UUID regionId)
	Does the given id belong to the root region of a megaregion? More...

Vector2	GetSizeOfMegaregion (UUID regionId)
	Gets the size of megaregion. More...

bool	PositionIsInMegaregion (UUID currentRegion, int xx, int yy)
	Tests to see of position (relative to the region) is within the megaregion More...

void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

void	ForwardPermissionRequests (RegionConnections BigRegion, Scene VirtualRegion)

void	FixPhantoms (string module, string[] cmdparams)

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

Detailed Description

Definition at line 45 of file RegionCombinerModule.cs.

Member Function Documentation

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.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 95 of file RegionCombinerModule.cs.

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.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 91 of file RegionCombinerModule.cs.

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.FixPhantoms	(	string	module,
		string[]	cmdparams
	)

inline

Definition at line 866 of file RegionCombinerModule.cs.

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.ForwardPermissionRequests	(	RegionConnections	BigRegion,
		Scene	VirtualRegion
	)

inline

Definition at line 813 of file RegionCombinerModule.cs.

Vector2 OpenSim.Region.RegionCombinerModule.RegionCombinerModule.GetSizeOfMegaregion ( UUID regionId )

inline

Gets the size of megaregion.

Returns size in meters. Do not rely on this method remaining the same - this area is actively under development.

Parameters

sceneId The id of the root region for a megaregion. This may change in the future to allow any region id that makes up a megaregion. Currently, will throw an exception if this does not match a root region.

Implements OpenSim.Region.Framework.Interfaces.IRegionCombinerModule.

Definition at line 126 of file RegionCombinerModule.cs.

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.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 78 of file RegionCombinerModule.cs.

bool OpenSim.Region.RegionCombinerModule.RegionCombinerModule.IsRootForMegaregion ( UUID regionId )

inline

Does the given id belong to the root region of a megaregion?

Implements OpenSim.Region.Framework.Interfaces.IRegionCombinerModule.

Definition at line 120 of file RegionCombinerModule.cs.

bool OpenSim.Region.RegionCombinerModule.RegionCombinerModule.PositionIsInMegaregion	(	UUID	currentRegion,
		int	xx,
		int	yy
	)

inline

Tests to see of position (relative to the region) is within the megaregion

Implements OpenSim.Region.Framework.Interfaces.IRegionCombinerModule.

Definition at line 143 of file RegionCombinerModule.cs.

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.PostInitialise ( )

inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 781 of file RegionCombinerModule.cs.

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.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 107 of file RegionCombinerModule.cs.

void OpenSim.Region.RegionCombinerModule.RegionCombinerModule.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 101 of file RegionCombinerModule.cs.

Property Documentation

string OpenSim.Region.RegionCombinerModule.RegionCombinerModule.Name

get

Definition at line 51 of file RegionCombinerModule.cs.

Type OpenSim.Region.RegionCombinerModule.RegionCombinerModule.ReplaceableInterface

get

Definition at line 56 of file RegionCombinerModule.cs.

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

Region/OptionalModules/RegionCombinerModule/RegionCombinerModule.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation