Inheritance diagram for OpenSim.Region.CoreModules.World.Vegetation.VegetationModule:

Collaboration diagram for OpenSim.Region.CoreModules.World.Vegetation.VegetationModule:

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	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. 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...

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

Protected Member Functions
void	AdaptTree (ref PrimitiveBaseShape tree)

Protected Attributes
Scene	m_scene

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

Properties
PCode[]	CreationCapabilities `[get]`

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

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

Definition at line 41 of file VegetationModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.AdaptTree ( ref PrimitiveBaseShape tree )

inlineprotected

Definition at line 114 of file VegetationModule.cs.

void OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.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 54 of file VegetationModule.cs.

SceneObjectGroup OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.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 77 of file VegetationModule.cs.

void OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.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 65 of file VegetationModule.cs.

SceneObjectGroup OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.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 90 of file VegetationModule.cs.

void OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.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 50 of file VegetationModule.cs.

void OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.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 73 of file VegetationModule.cs.

void OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.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 60 of file VegetationModule.cs.

Member Data Documentation

readonly PCode [] OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.creationCapabilities = new PCode[] { PCode.Grass, PCode.NewTree, PCode.Tree }

staticprotected

Definition at line 47 of file VegetationModule.cs.

Scene OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.m_scene

protected

Definition at line 45 of file VegetationModule.cs.

Property Documentation

PCode [] OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.CreationCapabilities

get

Definition at line 48 of file VegetationModule.cs.

string OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.Name

get

Definition at line 66 of file VegetationModule.cs.

Type OpenSim.Region.CoreModules.World.Vegetation.VegetationModule.ReplaceableInterface

get

Definition at line 69 of file VegetationModule.cs.

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

Region/CoreModules/World/Vegetation/VegetationModule.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation