world.ChatNameChange

MUSHclient script function (Method) — introduced in version 3.37

Changes your chat name

Prototype

long ChatNameChange(BSTR NewName);

Data type meanings

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.

VBscript example

ChatNameChange "Krenath"

Jscript example

ChatNameChange ("Krenath");

PerlScript example

ChatNameChange ("Krenath");

Python example

world.ChatNameChange ("Krenath")

Lua example

ChatNameChange ("Krenath")

Return value

eBadParameter: No name supplied
eOK: Name changed

Return code meanings

Related topic

Chat system

See also

FunctionDescription
GetChatInfoGet information about a chat connection
GetChatOptionGets the value of a chat session option
SetChatOptionSets the value of a chat session option