Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.ChatNameChange


Name ChatNameChange
Type Method
Summary Changes your chat name
Prototype long ChatNameChange(BSTR NewName);
Description

This changes your chat name - the name other people see when connecting to you, or when you connect to them. A message is sent to all directly connected users notifying them of the name change, so their clients should show the new name immediately.


Note: Available in version 3.37 onwards.


VBscript example
ChatNameChange "Krenath"
Jscript example
ChatNameChange ("Krenath");
PerlScript example
ChatNameChange ("Krenath");
Python example
world.ChatNameChange ("Krenath")
Lua example
ChatNameChange ("Krenath")
Returns eBadParameter: No name supplied
eOK: Name changed
Introduced in version 3.37

See also ...

Function Description
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

[Back]

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