Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.FixupHTML

Name FixupHTML
Type Method
Summary Fixes up text for writing as HTML
Prototype BSTR FixupHTML(BSTR StringToConvert);

View list of data type meanings
Description

This translates text so that it can be logged as HTML.

It will translate "<", ">" and "&" to the HTML equivalents (eg. &lt; ), otherwise a line like this: "go <north>" would not log correctly as HTML.

This is intended for use in scripts that are used to log to the log file, where you are writing out a log file in HTML.
VBscript example 
world.note world.FixupHTML ("I will go <north> here")
Jscript example 
world.note(world.FixupHTML("I will go <north> here"));
PerlScript example 
$world->note($world->FixupHTML("I will go <north> here"));
Python example 
world.note(world.FixupHTML("I will go <north> here"))
Lua example 
Note(FixupHTML("I will go <north> here"))
Returns The supplied string with the following characters replaced with the HTML "escaped" equivalents:

< &lt;
> &gt;
& &amp;
" &quot;

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.

Home