OpenSim.Framework.OSChatMessage Class Reference

ChatFromViewer Arguments More...

Inheritance diagram for OpenSim.Framework.OSChatMessage:

Collaboration diagram for OpenSim.Framework.OSChatMessage:

Public Member Functions
	OSChatMessage ()
override string	ToString ()

Protected Attributes
int	m_channel
string	m_from
string	m_message
Vector3	m_position
IScene	m_scene
IClientAPI	m_sender
object	m_senderObject
ChatTypeEnum	m_type
UUID	m_fromID
UUID	m_destination = UUID.Zero

Properties
string	Message [get, set]
	The message sent by the user More...
ChatTypeEnum	Type [get, set]
	The type of message, eg say, shout, broadcast. More...
int	Channel [get, set]
	Which channel was this message sent on? Different channels may have different listeners. Public chat is on channel zero. More...
Vector3	Position [get, set]
	The position of the sender at the time of the message broadcast. More...
string	From [get, set]
	The name of the sender (needed for scripts) More...
IClientAPI	Sender [get, set]
	The client responsible for sending the message, or null. More...
object	SenderObject [get, set]
	The object responsible for sending the message, or null. More...
UUID	SenderUUID [get, set]
UUID	Destination [get, set]
IScene	Scene [get, set]
Properties inherited from OpenSim.Framework.IEventArgs
IScene	Scene [get, set]
IClientAPI	Sender [get, set]

Detailed Description

ChatFromViewer Arguments

Definition at line 42 of file OSChatMessage.cs.

Constructor & Destructor Documentation

OpenSim.Framework.OSChatMessage.OSChatMessage ( )

inline

Definition at line 56 of file OSChatMessage.cs.

Member Function Documentation

override string OpenSim.Framework.OSChatMessage.ToString ( )

inline

Definition at line 150 of file OSChatMessage.cs.

Member Data Documentation

int OpenSim.Framework.OSChatMessage.m_channel

protected

Definition at line 44 of file OSChatMessage.cs.

UUID OpenSim.Framework.OSChatMessage.m_destination = UUID.Zero

protected

Definition at line 54 of file OSChatMessage.cs.

string OpenSim.Framework.OSChatMessage.m_from

protected

Definition at line 45 of file OSChatMessage.cs.

UUID OpenSim.Framework.OSChatMessage.m_fromID

protected

Definition at line 53 of file OSChatMessage.cs.

string OpenSim.Framework.OSChatMessage.m_message

protected

Definition at line 46 of file OSChatMessage.cs.

Vector3 OpenSim.Framework.OSChatMessage.m_position

protected

Definition at line 47 of file OSChatMessage.cs.

IScene OpenSim.Framework.OSChatMessage.m_scene

protected

Definition at line 49 of file OSChatMessage.cs.

IClientAPI OpenSim.Framework.OSChatMessage.m_sender

protected

Definition at line 50 of file OSChatMessage.cs.

object OpenSim.Framework.OSChatMessage.m_senderObject

protected

Definition at line 51 of file OSChatMessage.cs.

ChatTypeEnum OpenSim.Framework.OSChatMessage.m_type

protected

Definition at line 52 of file OSChatMessage.cs.

Property Documentation

int OpenSim.Framework.OSChatMessage.Channel

getset

Which channel was this message sent on? Different channels may have different listeners. Public chat is on channel zero.

Definition at line 83 of file OSChatMessage.cs.

UUID OpenSim.Framework.OSChatMessage.Destination

getset

Definition at line 136 of file OSChatMessage.cs.

string OpenSim.Framework.OSChatMessage.From

getset

The name of the sender (needed for scripts)

Definition at line 101 of file OSChatMessage.cs.

string OpenSim.Framework.OSChatMessage.Message

getset

The message sent by the user

Definition at line 65 of file OSChatMessage.cs.

Vector3 OpenSim.Framework.OSChatMessage.Position

getset

The position of the sender at the time of the message broadcast.

Definition at line 92 of file OSChatMessage.cs.

IScene OpenSim.Framework.OSChatMessage.Scene

getset

Definition at line 145 of file OSChatMessage.cs.

IClientAPI OpenSim.Framework.OSChatMessage.Sender

getset

The client responsible for sending the message, or null.

TODO: Sender and SenderObject should just be Sender and of type IChatSender

Definition at line 115 of file OSChatMessage.cs.

object OpenSim.Framework.OSChatMessage.SenderObject

getset

The object responsible for sending the message, or null.

Definition at line 124 of file OSChatMessage.cs.

UUID OpenSim.Framework.OSChatMessage.SenderUUID

getset

Definition at line 130 of file OSChatMessage.cs.

ChatTypeEnum OpenSim.Framework.OSChatMessage.Type

getset

The type of message, eg say, shout, broadcast.

Definition at line 74 of file OSChatMessage.cs.

---

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

• Framework/OSChatMessage.cs