OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Attributes | Properties | List of all members
OpenSim.Region.CoreModules.Avatar.Gods.GodsModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Avatar.Gods.GodsModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Avatar.Gods.GodsModule:
Collaboration graph
[legend]

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 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...
 
void SubscribeToClientEvents (IClientAPI client)
 
void UnsubscribeFromClientEvents (IClientAPI client)
 
void RequestGodlikePowers (UUID agentID, UUID sessionID, UUID token, bool godLike, IClientAPI controllingClient)
 Handle a request for admin rights More...
 
void KickUser (UUID godID, UUID sessionID, UUID agentID, uint kickflags, byte[] reason)
 Kicks User specified from the simulator. This logs them off of the grid If the client gets the UUID: 44e87126e7944ded05b37c42da3d5cdb it assumes that you're kicking it even if the avatar's UUID isn't the UUID that the agent is assigned More...
 

Protected Attributes

Scene m_scene
 
IDialogModule m_dialogModule
 

Properties

IDialogModule DialogModule [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...
 

Detailed Description

Definition at line 55 of file GodsModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 81 of file GodsModule.cs.

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.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 102 of file GodsModule.cs.

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.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
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 77 of file GodsModule.cs.

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.KickUser ( UUID  godID,
UUID  sessionID,
UUID  agentID,
uint  kickflags,
byte[]  reason 
)
inline

Kicks User specified from the simulator. This logs them off of the grid If the client gets the UUID: 44e87126e7944ded05b37c42da3d5cdb it assumes that you're kicking it even if the avatar's UUID isn't the UUID that the agent is assigned

Parameters
godIDThe person doing the kicking
sessionIDThe session of the person doing the kicking
agentIDthe person that is being kicked
kickflagsTells what to do to the user
reasonThe message to send to the user after it's been turned into a field

Implements OpenSim.Region.Framework.Interfaces.IGodsModule.

Definition at line 210 of file GodsModule.cs.

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 98 of file GodsModule.cs.

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 91 of file GodsModule.cs.

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.RequestGodlikePowers ( UUID  agentID,
UUID  sessionID,
UUID  token,
bool  godLike,
IClientAPI  controllingClient 
)
inline

Handle a request for admin rights

Parameters
agentID
sessionID
token
godLike
controllingClient

Implements OpenSim.Region.Framework.Interfaces.IGodsModule.

Definition at line 164 of file GodsModule.cs.

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.SubscribeToClientEvents ( IClientAPI  client)
inline

Definition at line 110 of file GodsModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.UnsubscribeFromClientEvents ( IClientAPI  client)
inline

Definition at line 116 of file GodsModule.cs.

Here is the call graph for this function:

Member Data Documentation

IDialogModule OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.m_dialogModule
protected

Definition at line 64 of file GodsModule.cs.

Scene OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.m_scene
protected

Definition at line 63 of file GodsModule.cs.

Property Documentation

IDialogModule OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.DialogModule
getprotected

Definition at line 67 of file GodsModule.cs.

string OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.Name
get

Definition at line 103 of file GodsModule.cs.

Type OpenSim.Region.CoreModules.Avatar.Gods.GodsModule.ReplaceableInterface
get

Definition at line 106 of file GodsModule.cs.


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