Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleClick here to show Table of Contents
Table of Contents

This control defines the main chat window. The recommended location for it is in a desktop panel. Only one instance of the control can exist, attempts to create more than one will fail.

The chat window contains several chatentry objects representing the entries in the chat buffer. The messages added to the buffer can either be sent to other clients taking part in the session or used as local notification messages. See addMessage and deliverMessage for details.

See Comm package for details on the chat message structure.

...

messagedata   (table)   
A table containing information about the message. See the Comm package for details.

clear

...

messagedata   (table)   
A table containing information about the message. See the Comm package for details.

deliverMessage

...

messagedata   (table)   
A table containing information about the message. See the Comm package for details.

recipient   (string)   
A string containing the user name of the desired recipient

...

messagedata   (table)   
A table containing information about the message. See the Comm package for details.

recipients   (table)   
An integer indexed table containing strings specifying the user names of the desired recipients

...

draginfo   (dragdata)   
dragdata reference containing information about the drag used to roll the dice.

...

messagedata   (table)   
A table containing information about the message. See the Comm package for details.

Return values

...

messagedata   (table)   
A table containing information about the message. See the Comm package for details.

Return values

...

This function is used to trigger a roll of the dice without direct UI actions. Technically, the roll is performed by creating a dragdata object and triggering the action of the dice.

...

dragtype   (string)   
The type used for the dragdata object. A value of "dice" performs a normal die roll.

...

An alternate version of the function used to trigger a roll of the dice without direct UI actions. Technically, the roll is performed by creating a dragdata object and triggering the action of the dice.

...

data   (table)   
See the dragdata object for a description of the table (same as dragdata.setData)