MUSHclient scripting

Description of MUSHclient world function: world.Replace

Name	Replace
Type	Method
Summary	Replaces one substring with another
Prototype	`BSTR Replace(BSTR Source, BSTR SearchFor, BSTR ReplaceWith, boolean Multiple);` View list of data type meanings
Description	This is a utility function for doing a "find and replace" inside a string. It is intended to simplify writing scripts that need to replace things. If "Multiple" is true then all occurences are replaced, otherwise only the first one is replaced.
VBscript example	`world.Note world.Replace ("go north, go east", "go", "walk", true)`
Jscript example	`world.Note(world.Replace("go north, go east", "go", "walk", true));`
PerlScript example	`$world->Note($world->Replace("go north, go east", "go", "walk", true));`
Python example	`world.Note(world.Replace("go north, go east", "go", "walk", True))`
Lua example	`Note(Replace("go north, go east", "go", "walk", true))`
Lua notes	`The Multiple flag is optional, and defaults to true.`
Returns	`The source string with one or more occurences of "SearchFor" replaced by "ReplaceWith".`

See also ...

Function	Description
FixupEscapeSequences	Converts "escape sequences" like \t to their equivalent codes.
FixupHTML	Fixes up text for writing as HTML
Trim	Trims leading and trailing spaces from a string

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.

Leave blank to show all functions.

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

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

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