ColorTerm 2.3

Category / Domain : Interface
SCOL Voy@ger Compatibility : V 3.5 or above
Update : 2003/10

Function

The COLORTERM module is a module of communication : it allows users to have a real-time dialogue (chat) via a window with colored text, report line and a macro system allowing to memorize some sentences.
While associating it to the LoginP4 module, it permits to put a pseudonym in "away" ( and to inform the other visitors of it via the chat).

Configuration


Figure 1 : Interface of the Colorterm module

For each of the options below, it is necessary to click the colored box to change it.

(1) : Background color => Background color of the chat window.

(2) : System message (>) color => Color of system messages beginning by >.

(3) : System message (>>) color => Color of system messages beginning by >>.

(4) : Color of user login name => Color of the users' logins.

(5) : Action message color => Color of the action messages (macros).

(6) : Message random color => List of 8 colors randomly assigned to the users whom have not yet chosen a color.

(7) : Alternate color for others => Alternate default color for other users

(8) : Color for other users => Default color for other users.

(9) : Choose the color of edit line=> choose the color of text in the edit line.

(10) : Another color of text=> alternate color fot text.

(11) : Away button=> Change your status to away.

(12) :Macro files => Default filename of macros.

Implementation

The three links below are imperative to use the module, what implies that a user must have entered in a 3d cell so that it is active.


Action Function
shell.start à Colorterm.start Starts and shows the COLORTERM module at the client side
C3D3.hear à Colorterm.privateMsg Allows to send a specific user a message
module.event à Colorterm.destroy Cancels the COLORTERM module at the client side
module.event à Colorterm.broadMsg Allows to send all users a message
module.event à Colorterm.privateInfo Sends one user a message(do not manage spaces : insert \ before each space of the message).
The expected string is like :
"text typeface size color flag" with text as required element.

Other parameters are processed in the order if present. In case of problem, default values are used. The typeface must be specified, for example :
Arial for arial
Size must be given to the decimal format.
The colour can be also parametrized, under decimal format : 7829367 instead of 0x777777

A string like "text typeface" can be used for example but not a string like "text size", the elements of the chain having to follow the model without breaking the string.

Other flags can be built-in, Flag can be of the following values (which can be cumulated to combine the effects) :

  • [ nothing ] for normal
  • 1 for Underlined
  • 2 for Bold
  • 4 for Italic
  • 8 for Strikethrough
module.event à Colorterm.broadInfo

Sends all users a message (does not take into account spaces). See privateInfo, above.
module.event à Colorterm.registerExtMacro

Adds an external macro without using a configuration file. Waits for a parameter like :
"originCat shortcut info flag"

To use with the IRC module
module.event à Colorterm.unregisterExtMacro

Removes an external macro without using a configuration file. Only takes into account the parameters :
"OriginCat shortcut"

To use with the IRC module
module.event à Colorterm. !ChgLogin Any change of alias is taken into account in the COLORTERM module (to relate to the Login or LoginPx module).
module.event à Colorterm.ignLogOut Allows the COLORTERM module to take into account the available actions of the Ignore module.
module.event à Colorterm. !addCommand Allows to add a specific order in the input zone of the module
module.event à Colorterm.getDialogS Obsolete
module.event à Colorterm.getDialog Obsolete

Event Function
Colorterm.command à C3D3. !speak à module Action Allows to send connected avatars the messages
Colorterm.entering à module Action Generates an action when entering in the module
Colorterm.destroyed à module Action

Generates an action when closing the module
Colorterm.extMacroCommand à module Action Action started with a macro input
Colorterm.in à module Action The initialization of the module generates an action
Colorterm.away à module Action  To link  with the same action name in the Loginp4 module
Colorterm.back à module Action  To link  with the same action name in the Loginp4 module

Zone Function Interface Assignment
ColorTerm.colorTerm Interface allowing to send and receive messages Client Yes