[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.ChatGetID

Name ChatGetID
Type Method
Summary Looks up what chat ID (identifier) corresponds to a particular chat name
Prototype long ChatGetID(BSTR Who);

View list of data type meanings


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.

Note: Available in version 3.37 onwards.

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)
Returns The chat ID corresponding to that name, or zero if none is found.
Introduced in version 3.37

See also ...

Function Description
ChatMessage Sends a message to a chat user (raw format)
ChatNameChange Changes your chat name
ChatPeekConnections Sends a "peek connections" message to the specified chat user
ChatPing Sends a ping message to the specified chat user
ChatRequestConnections Sends a "request connections" message to the specified chat user
ChatSendFile Starts sending a file to the specified chat user
ChatStopFileTransfer Stops a file transfer in progress to that chat user
GetChatInfo Get information about a chat connection
GetChatOption Gets the value of a chat session option
SetChatOption Sets the value of a chat session option

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]