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

Public Member Functions

virtual 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...
 
virtual 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...
 
virtual 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...
 
virtual 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...
 
virtual void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
virtual void PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
virtual void OnNewClient (IClientAPI client)
 
virtual void OnChatFromClient (Object sender, OSChatMessage c)
 
virtual void OnChatFromWorld (Object sender, OSChatMessage c)
 
virtual void OnChatBroadcast (Object sender, OSChatMessage c)
 
void ParcelFreezeUser (IClientAPI client, UUID parcelowner, uint flags, UUID target)
 

Protected Member Functions

OSChatMessage FixPositionOfChatMessage (OSChatMessage c)
 
virtual void DeliverChatToAvatars (ChatSourceType sourceType, OSChatMessage c)
 
virtual bool TrySendChatMessage (ScenePresence presence, Vector3 fromPos, Vector3 regionPos, UUID fromAgentID, UUID ownerID, string fromName, ChatTypeEnum type, string message, ChatSourceType src, bool ignoreDistance)
 Try to send a message to the given presence More...
 

Properties

Type ReplaceableInterface [get]
 
virtual 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 43 of file ChatModule.cs.

Member Function Documentation

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.AddRegion ( Scene  scene)
inlinevirtual

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.

Reimplemented in OpenSim.Region.OptionalModules.Avatar.Concierge.ConciergeModule.

Definition at line 82 of file ChatModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.Close ( )
inlinevirtual

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Reimplemented in OpenSim.Region.OptionalModules.Avatar.Concierge.ConciergeModule.

Definition at line 129 of file ChatModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.DeliverChatToAvatars ( ChatSourceType  sourceType,
OSChatMessage  c 
)
inlineprotectedvirtual

Definition at line 202 of file ChatModule.cs.

Here is the call graph for this function:

OSChatMessage OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.FixPositionOfChatMessage ( OSChatMessage  c)
inlineprotected

Definition at line 155 of file ChatModule.cs.

Here is the call graph for this function:

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.Initialise ( IConfigSource  source)
inlinevirtual

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.

Reimplemented in OpenSim.Region.OptionalModules.Avatar.Concierge.ConciergeModule.

Definition at line 62 of file ChatModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.OnChatBroadcast ( Object  sender,
OSChatMessage  c 
)
inlinevirtual

Reimplemented in OpenSim.Region.OptionalModules.Avatar.Concierge.ConciergeModule.

Definition at line 329 of file ChatModule.cs.

Here is the call graph for this function:

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.OnChatFromClient ( Object  sender,
OSChatMessage  c 
)
inlinevirtual

Reimplemented in OpenSim.Region.OptionalModules.Avatar.Concierge.ConciergeModule.

Definition at line 165 of file ChatModule.cs.

Here is the call graph for this function:

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.OnChatFromWorld ( Object  sender,
OSChatMessage  c 
)
inlinevirtual
virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.OnNewClient ( IClientAPI  client)
inlinevirtual
void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.ParcelFreezeUser ( IClientAPI  client,
UUID  parcelowner,
uint  flags,
UUID  target 
)
inline

Definition at line 440 of file ChatModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.PostInitialise ( )
inlinevirtual

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Reimplemented in OpenSim.Region.OptionalModules.Avatar.Concierge.ConciergeModule.

Definition at line 133 of file ChatModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.RegionLoaded ( Scene  scene)
inlinevirtual

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 101 of file ChatModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.RemoveRegion ( Scene  scene)
inlinevirtual

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.

Reimplemented in OpenSim.Region.OptionalModules.Avatar.Concierge.ConciergeModule.

Definition at line 113 of file ChatModule.cs.

virtual bool OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.TrySendChatMessage ( ScenePresence  presence,
Vector3  fromPos,
Vector3  regionPos,
UUID  fromAgentID,
UUID  ownerID,
string  fromName,
ChatTypeEnum  type,
string  message,
ChatSourceType  src,
bool  ignoreDistance 
)
inlineprotectedvirtual

Try to send a message to the given presence

Parameters
presenceThe receiver
fromPos
regionPos/param>
Parameters
fromAgentID
ownerIDOwner of the message. For at least some messages from objects, this has to be correctly filled with the owner's UUID. This is the case for script error messages in viewer 3 since LLViewer change EXT-7762
fromName
type
message
src
Returns
true if the message was sent to the receiver, false if it was not sent due to failing a precondition

Definition at line 407 of file ChatModule.cs.

Property Documentation

virtual string OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.Name
get

Definition at line 143 of file ChatModule.cs.

Type OpenSim.Region.CoreModules.Avatar.Chat.ChatModule.ReplaceableInterface
get

Definition at line 138 of file ChatModule.cs.


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