Inheritance diagram for OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule:

Collaboration diagram for OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule:

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	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	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	SendAlertToUser (IClientAPI client, string message)
	Send a non-modal alert message to a particular user. This can disappear from the user's view after a small interval. More...

void	SendAlertToUser (IClientAPI client, string message, bool modal)
	Send an alert message to a particular user. More...

void	SendAlertToUser (UUID agentID, string message)
	Send a non-modal alert message to a particular user. More...

void	SendAlertToUser (UUID agentID, string message, bool modal)
	Send an alert message to a particular user. More...

void	SendAlertToUser (string firstName, string lastName, string message, bool modal)
	Send an alert message to a particular user. More...

void	SendGeneralAlert (string message)
	Send an alert message to all users in the scene. More...

void	SendDialogToUser (UUID avatarID, string objectName, UUID objectID, UUID ownerID, string message, UUID textureID, int ch, string[] buttonlabels)
	Send a dialog box to a particular user. More...

void	SendUrlToUser (UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url)
	Send a url to a particular user. More...

void	SendTextBoxToUser (UUID avatarid, string message, int chatChannel, string name, UUID objectid, UUID ownerID)
	Send a textbox entry for the client to respond to More...

void	SendNotificationToUsersInRegion (UUID fromAvatarID, string fromAvatarName, string message)
	Send a notification to all users in the scene. This notification should remain around until the user explicitly dismisses it. More...

void	HandleAlertConsoleCommand (string module, string[] cmdparams)
	Handle an alert command from the console. More...

Protected Attributes
Scene	m_scene

Properties
Type	ReplaceableInterface `[get]`

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 44 of file DialogModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.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 DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.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 85 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.HandleAlertConsoleCommand	(	string	module,
		string[]	cmdparams
	)

inline

Handle an alert command from the console.

Parameters

module
cmdparams

Definition at line 216 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.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 DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.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 60 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.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 77 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendAlertToUser	(	IClientAPI	client,
		string	message
	)

inline

Send a non-modal alert message to a particular user. This can disappear from the user's view after a small interval.

Parameters

client	IClientAPI object representing the user.
message	Message text to send to the user.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 88 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendAlertToUser	(	IClientAPI	client,
		string	message,
		bool	modal
	)

inline

Send an alert message to a particular user.

Parameters

client	IClientAPI object representing the user.
message	Message text to send to the user.
modal	Flag to control modality.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 93 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendAlertToUser	(	UUID	agentID,
		string	message
	)

inline

Send a non-modal alert message to a particular user.

Parameters

agentID	UUID of agent representing the user.
message	Message text to send to the user.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 99 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendAlertToUser	(	UUID	agentID,
		string	message,
		bool	modal
	)

inline

Send an alert message to a particular user.

Parameters

agentID	UUID of agent representing the user.
message	Message text to send to the user.
modal	Flag to control modality.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 104 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendAlertToUser	(	string	firstName,
		string	lastName,
		string	message,
		bool	modal
	)

inline

Send an alert message to a particular user.

Parameters

firstName	Account first name
lastName	Account last name
message	Message text to send to the user.
modal	Flag to control modality.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 112 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendDialogToUser	(	UUID	avatarID,
		string	objectName,
		UUID	objectID,
		UUID	ownerID,
		string	message,
		UUID	textureID,
		int	ch,
		string[]	buttonlabels
	)

inline

Send a dialog box to a particular user.

Parameters

avatarID	UUID of the avatar representing the user.
objectName	Name of the object sending the dialog.
objectID	UUID of the object sending the dialog.
ownerID	UUID of the user that owns the object.
message	Message text to send to the user.
textureID	Texture UUID to pass along with the dialog.
ch	Channel on which the selected button text should be broadcast.
buttonlabels	Dialog button text.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 132 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendGeneralAlert ( string message )

inline

Send an alert message to all users in the scene.

Parameters

message Message text to send to all users.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 124 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendNotificationToUsersInRegion	(	UUID	fromAvatarID,
		string	fromAvatarName,
		string	message
	)

inline

Send a notification to all users in the scene. This notification should remain around until the user explicitly dismisses it.

On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the screen.

Parameters

fromAvatarID	The user sending the message
fromAvatarName	The name of the user doing the sending
message	The message being sent to the user

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 201 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendTextBoxToUser	(	UUID	avatarid,
		string	message,
		int	chatChannel,
		string	name,
		UUID	objectid,
		UUID	ownerid
	)

inline

Send a textbox entry for the client to respond to

Parameters

avatarID	UUID of the avatar representing the user.
message	Message text to send to the user.
chatChannel	Chat channel that the user's input should be broadcast on.
name	Name of the object sending the dialog.
objectid	UUID of the object sending the dialog.
ownerid	UUID of the user that owns the object.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 173 of file DialogModule.cs.

void OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.SendUrlToUser	(	UUID	avatarID,
		string	objectName,
		UUID	objectID,
		UUID	ownerID,
		bool	groupOwned,
		string	message,
		string	url
	)

inline

Send a url to a particular user.

Parameters

avatarID	UUID of the avatar representing the user.
objectName	Name of the object sending the dialog.
objectID	UUID of the object sending the dialog.
ownerID	UUID of the user that owns the object.
groupOwned	Flag indicating whether or not the object is group-owned.
message	Message text to send to the user.
url	Url to send to the user.

Implements OpenSim.Region.Framework.Interfaces.IDialogModule.

Definition at line 160 of file DialogModule.cs.

Member Data Documentation

Scene OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.m_scene

protected

Definition at line 48 of file DialogModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.Name

get

Definition at line 86 of file DialogModule.cs.

Type OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.ReplaceableInterface

get

Definition at line 52 of file DialogModule.cs.

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

Region/CoreModules/Avatar/Dialog/DialogModule.cs

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation