Version 2.02 - Still hacky More...

Inheritance diagram for OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule:

Collaboration diagram for OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule:

Classes
class	Copse

Public Member Functions
void	Initialise (IConfigSource config)
	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...

SceneObjectGroup	AddTree (UUID uuid, UUID groupID, Vector3 scale, Quaternion rotation, Vector3 position, Tree treeType, bool newTree)
	Add a new tree to the scene. Used by other modules. More...

SceneObjectGroup	CreateEntity (UUID ownerID, UUID groupID, Vector3 pos, Quaternion rot, PrimitiveBaseShape shape)
	Create an entity More...

Static Public Member Functions
static void	SerializeObject (string fileName, Object obj)

static object	DeserializeObject (string fileName)

Static Protected Attributes
static readonly PCode[]	creationCapabilities = new PCode[] { PCode.NewTree, PCode.Tree }

Properties
ICommander	CommandInterface `[get]`

string	Name `[get]`

Type	ReplaceableInterface `[get]`

PCode[]	CreationCapabilities `[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...

Properties inherited from OpenSim.Region.Framework.Interfaces.ICommandableModule
ICommander	CommandInterface `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IEntityCreator
PCode[]	CreationCapabilities `[get]`
	The entities that this class is capable of creating. These match the PCode format. More...

Detailed Description

Version 2.02 - Still hacky

Definition at line 51 of file TreePopulatorModule.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.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 202 of file TreePopulatorModule.cs.

SceneObjectGroup OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.AddTree	(	UUID	uuid,
		UUID	groupID,
		Vector3	scale,
		Quaternion	rotation,
		Vector3	position,
		Tree	treeType,
		bool	newTree
	)

inline

Add a new tree to the scene. Used by other modules.

Parameters

uuid
groupID
scale
rotation
position
treeType
newTree

Returns

Implements OpenSim.Region.Framework.Interfaces.IVegetationModule.

Definition at line 492 of file TreePopulatorModule.cs.

void OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.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 224 of file TreePopulatorModule.cs.

SceneObjectGroup OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.CreateEntity	(	UUID	ownerID,
		UUID	groupID,
		Vector3	pos,
		Quaternion	rot,
		PrimitiveBaseShape	shape
	)

inline

Create an entity

Parameters

ownerID
groupID
pos
rot
shape

Returns: The entity created, or null if the creation failed

Implements OpenSim.Region.Framework.Interfaces.IEntityCreator.

Definition at line 512 of file TreePopulatorModule.cs.

static object OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.DeserializeObject ( string fileName )

inlinestatic

Definition at line 555 of file TreePopulatorModule.cs.

void OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.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 175 of file TreePopulatorModule.cs.

void OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.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 214 of file TreePopulatorModule.cs.

void OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.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 210 of file TreePopulatorModule.cs.

static void OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.SerializeObject	(	string	fileName,
		Object	obj
	)

inlinestatic

Definition at line 537 of file TreePopulatorModule.cs.

Member Data Documentation

readonly PCode [] OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.creationCapabilities = new PCode[] { PCode.NewTree, PCode.Tree }

staticprotected

Definition at line 509 of file TreePopulatorModule.cs.

Property Documentation

ICommander OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.CommandInterface

get

Definition at line 167 of file TreePopulatorModule.cs.

PCode [] OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.CreationCapabilities

get

Definition at line 510 of file TreePopulatorModule.cs.

string OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.Name

get

Definition at line 229 of file TreePopulatorModule.cs.

Type OpenSim.Region.OptionalModules.World.TreePopulator.TreePopulatorModule.ReplaceableInterface

get

Definition at line 234 of file TreePopulatorModule.cs.

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

Region/OptionalModules/World/TreePopulator/TreePopulatorModule.cs

Classes

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation