world.ChatGetID

MUSHclient script function (Method) — introduced in version 3.37

Looks up what chat ID (identifier) corresponds to a particular chat name

Prototype

long ChatGetID(BSTR Who);

Data type meanings

Description

Each call is identified by its "chat ID" - each chat session has a unique ID, which starts at one, and is incremented by one, per world.

You can use ChatGetID to find the chat ID corresponding to a particular chat name.

If more than one person has that name the first one (earliest connection) is returned.

If no person has that name zero is returned.

A message is sent to the output window, so you can use ChatGetID in scripts and have them automatically notify you if that person cannot be found.

VBscript example

ChatID ChatGetID ("nick"), "hi there", 0

Jscript example

ChatID (ChatGetID ("nick"), "hi there", 0);

PerlScript example

ChatID (ChatGetID ("nick"), "hi there", 0);

Python example

world.ChatID (world.ChatGetID ("nick"), "hi there", 0)

Lua example

ChatID (ChatGetID ("nick"), "hi there", 0)

Return value

The chat ID corresponding to that name, or zero if none is found.

Related topic

Chat system

See also