Inheritance diagram for OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule:

Collaboration diagram for OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule:

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	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. 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	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	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	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	LoadPrimsFromXml (Scene scene, string fileName, bool newIDS, Vector3 loadOffset)
	Load prims from the xml format More...

void	SavePrimsToXml (Scene scene, string fileName)
	Save prims in the xml format More...

void	LoadPrimsFromXml2 (Scene scene, string fileName)
	Load prims from the xml2 format More...

void	LoadPrimsFromXml2 (Scene scene, TextReader reader, bool startScripts)
	Load prims from the xml2 format More...

void	SavePrimsToXml2 (Scene scene, string fileName)
	Save prims in the xml2 format More...

void	SavePrimsToXml2 (Scene scene, TextWriter stream, Vector3 min, Vector3 max)
	Save prims in the xml2 format, optionally specifying a bounding box for which prims should be saved. If both min and max vectors are Vector3.Zero, then all prims are exported. More...

void	SaveNamedPrimsToXml2 (Scene scene, string primName, string fileName)

SceneObjectGroup	DeserializeGroupFromXml2 (string xmlString)
	Deserializes a scene object from its xml2 representation. This does not load the object into the scene. More...

string	SerializeGroupToXml2 (SceneObjectGroup grp, Dictionary< string, object > options)
	Serialize an individual scene object into the xml2 format More...

void	SavePrimListToXml2 (EntityBase[] entityList, string fileName)
	Save a set of prims in the xml2 format More...

void	SavePrimListToXml2 (EntityBase[] entityList, TextWriter stream, Vector3 min, Vector3 max)
	Save a set of prims in the xml2 format, optionally specifying a bounding box for which prims should be saved. If both min and max vectors are Vector3.Zero, then all prims are exported. More...

List< string >	SerialiseRegion (Scene scene, string saveDir)

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

Detailed Description

Definition at line 46 of file SerialiserModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.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 85 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.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 109 of file SerialiserModule.cs.

SceneObjectGroup OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.DeserializeGroupFromXml2 ( string xmlString )

inline

Deserializes a scene object from its xml2 representation. This does not load the object into the scene.

Parameters

xmlString

Returns: The scene object created

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 159 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.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 63 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.LoadPrimsFromXml	(	Scene	scene,
		string	fileName,
		bool	newIDS,
		Vector3	loadOffset
	)

inline

Load prims from the xml format

Parameters

scene
fileName
newIDS
loadOffset

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 124 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.LoadPrimsFromXml2	(	Scene	scene,
		string	fileName
	)

inline

Load prims from the xml2 format

Parameters

scene
fileName

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 134 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.LoadPrimsFromXml2	(	Scene	scene,
		TextReader	reader,
		bool	startScripts
	)

inline

Load prims from the xml2 format

Parameters

scene
reader
startScripts

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 139 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.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 74 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.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 97 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.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 SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SaveNamedPrimsToXml2	(	Scene	scene,
		string	primName,
		string	fileName
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 154 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SavePrimListToXml2	(	EntityBase[]	entityList,
		string	fileName
	)

inline

Save a set of prims in the xml2 format

Parameters

entityList
fileName

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 169 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SavePrimListToXml2	(	EntityBase[]	entityList,
		TextWriter	stream,
		Vector3	min,
		Vector3	max
	)

inline

Save a set of prims in the xml2 format, optionally specifying a bounding box for which prims should be saved. If both min and max vectors are Vector3.Zero, then all prims are exported.

Parameters

entityList
stream
min
max

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 174 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SavePrimsToXml	(	Scene	scene,
		string	fileName
	)

inline

Save prims in the xml format

Parameters

scene
fileName

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 129 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SavePrimsToXml2	(	Scene	scene,
		string	fileName
	)

inline

Save prims in the xml2 format

Parameters

scene
fileName

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 144 of file SerialiserModule.cs.

void OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SavePrimsToXml2	(	Scene	scene,
		TextWriter	stream,
		Vector3	min,
		Vector3	max
	)

inline

Save prims in the xml2 format, optionally specifying a bounding box for which prims should be saved. If both min and max vectors are Vector3.Zero, then all prims are exported.

Parameters

scene
stream
min
max

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 149 of file SerialiserModule.cs.

List<string> OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SerialiseRegion	(	Scene	scene,
		string	saveDir
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 179 of file SerialiserModule.cs.

string OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.SerializeGroupToXml2	(	SceneObjectGroup	grp,
		Dictionary< string, object >	options
	)

inline

Serialize an individual scene object into the xml2 format

Parameters

grp

Returns

Implements OpenSim.Region.Framework.Interfaces.IRegionSerialiserModule.

Definition at line 164 of file SerialiserModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.Name

get

Definition at line 115 of file SerialiserModule.cs.

Type OpenSim.Region.CoreModules.World.Serialiser.SerialiserModule.ReplaceableInterface

get

Definition at line 59 of file SerialiserModule.cs.

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

Region/CoreModules/World/Serialiser/SerialiserModule.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation