Chatroom

^{Chatroom 3.0}

Category / Domain :	Commtools
SCOL Voy@ger Compatibility :	V 3.2 or above
Update :	2000/03

Function

The CHATROOM module is a module used for dialogues between users and has no graphics. This module works on the same basis as the C3D3 module.

Attention : this module must be coupled with a Term or ColorTerm module. The ColorTerm module already associated with the C3D3 module(s) can be used, however it is uninteresting since ChatRoom module is designed to start a subsidiary chat in addition to the main which takes place in a C3D3 cell ; using the same ColorTerm module prevents these two simultaneous chats, so it is preferable to use another ColorTerm module for the ChatRoom module.

Configuration

Figure 1 : Chatroom module Interface

(1) : Add => Used to add a keyword which will serve as a command.

(2) : Remove => Removes the selected keyword.

(3) : Edit Intro => Used to enter the text used as introduction which the user will see when he or she enters the CHATROOM module.

Implementation

Open the SCS creation tree. Select the CommTools folder then double-click on ChatRoom 3.0.
Create required links for the project.

Action	Function
module.event à chatroom. !changeLogin	Accepts the change of nickname (to link with a Login or a LoginPx module).
module.event à chatroom.!speak	Forces to display a command.
module.event à chatroom.broadMsg	Displays a message to all the users.
module.event à chatroom.destroy	Stops the CHATROOM module.
module.event à chatroom.privateMsg	Displays a message to a selected user.
module.event à chatroom.start	Starts the CHATROOM module.

The two chatroom.destroy and colorTerm.destroy actions are required in order that a user may be able to come back later to the CHATROOM module, beacause entering in this module is determined with the ChatRoom.start action (which will be ineffective if the user has not exit the module, even if it is not longer visible). Subsequent to this event, the ColorTerm.start action is itself triggered.

Event	Function
chatroom.destroyed à module Action	Leaving the CHATROOM module generates an action.
chatroom.entering à colorTerm.start	Starts the ColorTerm module upon entering the ChatRoom module
chatroom.entering à module Action	Starting the module generates an action
chatroom.getDialog à colorterm.getDialog	Gives the control to the user in the COLORTERM module
chatroom.hear à colorterm.privateMsg	The COLORTERM module displays what one user writes to the others, with his name between the < and > characters
chatroom.log à log.log	Saves the chat of the CHATROOM module in the log file
chatroom.spy à module Action	Link used to enable a BOT module, for example
chatroom.mot_clef à module Action	Action generated by a keyword

Zone	Function	Interface	Assignment
None