Inheritance diagram for OpenSim.Region.Framework.Interfaces.IWorldComm:

Public Member Functions
int	Listen (uint LocalID, UUID itemID, UUID hostID, int channel, string name, UUID id, string msg)
	Create a listen event callback with the specified filters. The parameters localID,itemID are needed to uniquely identify the script during 'peek' time. Parameter hostID is needed to determine the position of the script. More...

int	Listen (uint LocalID, UUID itemID, UUID hostID, int channel, string name, UUID id, string msg, int regexBitfield)

void	DeliverMessage (ChatTypeEnum type, int channel, string name, UUID id, string msg)
	This method scans over the objects which registered an interest in listen callbacks. For everyone it finds, it checks if it fits the given filter. If it does, then enqueue the message for delivery to the objects listen event handler. The enqueued ListenerInfo no longer has filter values, but the actually trigged values. Objects that do an llSay have their messages delivered here and for nearby avatars, the OnChatFromClient event is used. More...

void	DeliverMessageTo (UUID target, int channel, Vector3 pos, string name, UUID id, string msg)
	Delivers the message to a specified object in the region. More...

bool	HasMessages ()
	Are there any listen events ready to be dispatched? More...

IWorldCommListenerInfo	GetNextMessage ()
	Pop the first availlable listen event from the queue More...

void	ListenControl (UUID itemID, int handle, int active)

void	ListenRemove (UUID itemID, int handle)

void	DeleteListener (UUID itemID)

Object[]	GetSerializationData (UUID itemID)

void	CreateFromData (uint localID, UUID itemID, UUID hostID, Object[] data)

Properties
int	ListenerCount `[get]`
	Total number of listeners More...

Detailed Description

Definition at line 57 of file IWorldComm.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IWorldComm.CreateFromData	(	uint	localID,
		UUID	itemID,
		UUID	hostID,
		Object[]	data
	)

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

void OpenSim.Region.Framework.Interfaces.IWorldComm.DeleteListener ( UUID itemID )

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

void OpenSim.Region.Framework.Interfaces.IWorldComm.DeliverMessage	(	ChatTypeEnum	type,
		int	channel,
		string	name,
		UUID	id,
		string	msg
	)

This method scans over the objects which registered an interest in listen callbacks. For everyone it finds, it checks if it fits the given filter. If it does, then enqueue the message for delivery to the objects listen event handler. The enqueued ListenerInfo no longer has filter values, but the actually trigged values. Objects that do an llSay have their messages delivered here and for nearby avatars, the OnChatFromClient event is used.

Parameters

type	type of delvery (whisper,say,shout or regionwide)
channel	channel to sent on
name	name of sender (object or avatar)
id	key of sender (object or avatar)
msg	msg to sent

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

void OpenSim.Region.Framework.Interfaces.IWorldComm.DeliverMessageTo	(	UUID	target,
		int	channel,
		Vector3	pos,
		string	name,
		UUID	id,
		string	msg
	)

Delivers the message to a specified object in the region.

Parameters

target	Target.
channel	Channel.
name	Name.
id	Identifier.
msg	Message.

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

IWorldCommListenerInfo OpenSim.Region.Framework.Interfaces.IWorldComm.GetNextMessage ( )

Pop the first availlable listen event from the queue

Returns: ListenerInfo with filter filled in

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

Object [] OpenSim.Region.Framework.Interfaces.IWorldComm.GetSerializationData ( UUID itemID )

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

bool OpenSim.Region.Framework.Interfaces.IWorldComm.HasMessages ( )

Are there any listen events ready to be dispatched?

Returns: boolean indication

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

int OpenSim.Region.Framework.Interfaces.IWorldComm.Listen	(	uint	LocalID,
		UUID	itemID,
		UUID	hostID,
		int	channel,
		string	name,
		UUID	id,
		string	msg
	)

Create a listen event callback with the specified filters. The parameters localID,itemID are needed to uniquely identify the script during 'peek' time. Parameter hostID is needed to determine the position of the script.

Parameters

LocalID	localID of the script engine
itemID	UUID of the script engine
hostID	UUID of the SceneObjectPart
channel	channel to listen on
name	name to filter on
id	key to filter on (user given, could be totally faked)
msg	msg to filter on

Returns: number of the scripts handle

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

int OpenSim.Region.Framework.Interfaces.IWorldComm.Listen	(	uint	LocalID,
		UUID	itemID,
		UUID	hostID,
		int	channel,
		string	name,
		UUID	id,
		string	msg,
		int	regexBitfield
	)

Create a listen event callback with the specified filters. The parameters localID,itemID are needed to uniquely identify the script during 'peek' time. Parameter hostID is needed to determine the position of the script.

Parameters

LocalID	localID of the script engine
itemID	UUID of the script engine
hostID	UUID of the SceneObjectPart
channel	channel to listen on
name	name to filter on
id	key to filter on (user given, could be totally faked)
msg	msg to filter on
regexBitfield	Bitfield indicating which strings should be processed as regex.

Returns: number of the scripts handle

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

void OpenSim.Region.Framework.Interfaces.IWorldComm.ListenControl	(	UUID	itemID,
		int	handle,
		int	active
	)

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

void OpenSim.Region.Framework.Interfaces.IWorldComm.ListenRemove	(	UUID	itemID,
		int	handle
	)

Implemented in OpenSim.Region.CoreModules.Scripting.WorldComm.WorldCommModule.

Property Documentation

int OpenSim.Region.Framework.Interfaces.IWorldComm.ListenerCount

get

Total number of listeners

Definition at line 62 of file IWorldComm.cs.

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

Region/Framework/Interfaces/IWorldComm.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation