OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.Framework.Interfaces.IWindModule Interface Reference
Inheritance diagram for OpenSim.Region.Framework.Interfaces.IWindModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.Framework.Interfaces.IWindModule:
Collaboration graph
[legend]

Public Member Functions

Vector3 WindSpeed (int x, int y, int z)
 Retrieves the current wind speed at the given Region Coordinates More...
 
void WindParamSet (string plugin, string param, float value)
 Set Wind Plugin Parameter More...
 
float WindParamGet (string plugin, string param)
 Get Wind Plugin Parameter More...
 
- Public Member Functions inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
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...
 

Properties

string WindActiveModelPluginName [get]
 Current active wind model plugin or String.Empty More...
 
- 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 32 of file IWindModule.cs.

Member Function Documentation

float OpenSim.Region.Framework.Interfaces.IWindModule.WindParamGet ( string  plugin,
string  param 
)

Get Wind Plugin Parameter

Implemented in OpenSim.Region.CoreModules.WindModule.

void OpenSim.Region.Framework.Interfaces.IWindModule.WindParamSet ( string  plugin,
string  param,
float  value 
)

Set Wind Plugin Parameter

Implemented in OpenSim.Region.CoreModules.WindModule.

Vector3 OpenSim.Region.Framework.Interfaces.IWindModule.WindSpeed ( int  x,
int  y,
int  z 
)

Retrieves the current wind speed at the given Region Coordinates

Implemented in OpenSim.Region.CoreModules.WindModule.

Property Documentation

string OpenSim.Region.Framework.Interfaces.IWindModule.WindActiveModelPluginName
get

Current active wind model plugin or String.Empty

Definition at line 53 of file IWindModule.cs.


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