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

MUSHclient scripting

Description of MUSHclient world function: world.StripANSI

Name StripANSI
Type Method
Summary Strips ANSI colour sequences from a string
Prototype BSTR StripANSI(BSTR Message);

View list of data type meanings


This removes ANSI colour sequences from a string.

The intention of this routine is to be used with incoming chat messages (which may have ANSI colour codes in them), if you want to display them in a plain colour, or reformat using your own colours.

Note: Available in version 3.37 onwards.

VBscript example
Note StripANSI (incoming_message)
Jscript example
Note (StripANSI (incoming_message));
PerlScript example
Note (StripANSI (incoming_message));
Python example
world.Note (StripANSI (world.incoming_message))
Lua example
Note (StripANSI (incoming_message))
Returns The supplied string with ANSI colour sequences removed.
Introduced in version 3.37

See also ...

Function Description
ANSI Generates an ANSI colour sequence
ChatMessage Sends a message to a chat user (raw format)
Note Sends a note to the output window

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]