Replace
Script function

world.Replace

DOC_scripting Read about scripting

Type

Method

Summary

Replaces one substring with another

Prototype

BSTR Replace(BSTR Source, BSTR SearchFor, BSTR ReplaceWith, boolean Multiple);

DOC_data_types 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.


Return value

The source string with one or more occurences of "SearchFor" replaced by "ReplaceWith".



See Also ...

Topics

DOC_scripting Scripting
DOC_utils Utilities

Functions

FNC_Base64Decode Base64Decode (Takes a base-64 encoded string and decodes it.)
FNC_Base64Encode Base64Encode (Encodes a string using base-64 encoding.)
FNC_ChangeDir ChangeDir (Changes the MUSHclient working directory)
FNC_CreateGUID CreateGUID (Creates a GUID - Global Unique Identifier)
FNC_EditDistance EditDistance (Returns the Levenshtein Edit Distance between two words)
FNC_ErrorDesc ErrorDesc (Converts a MUSHclient script error code into an human-readable description)
FNC_ExportXML ExportXML (Exports a world item in XML format)
FNC_FixupEscapeSequences FixupEscapeSequences (Converts "escape sequences" like \t to their equivalent codes.)
FNC_FixupHTML FixupHTML (Fixes up text for writing as HTML)
FNC_GenerateName GenerateName (Generates a random character name)
FNC_GetClipboard GetClipboard (Gets the clipboard contents)
FNC_GetScriptTime GetScriptTime (Returns the amount of time spent in script routines)
FNC_GetUniqueID GetUniqueID (Creates a unique ID for general use, or for making Plugin IDs)
FNC_GetUniqueNumber GetUniqueNumber (Returns a unique number)
FNC_Hash Hash (Produces a hash (checksum) of a specified piece of text)
FNC_Help Help (Shows help for a script function, or a list of functions)
FNC_ImportXML ImportXML (Imports configuration data in XML format)
FNC_Metaphone Metaphone (Returns the metaphone code for the supplied word)
FNC_MtRand MtRand (Returns pseudo-random number using the Mersenne Twister algorithm)
FNC_MtSrand MtSrand (Seed the Mersenne Twister pseudo-random number generator)
FNC_ReadNamesFile ReadNamesFile (Loads in a file for generating character names)
FNC_SetClipboard SetClipboard (Sets the clipboard contents)
FNC_SetStatus SetStatus (Sets the status line text)
FNC_Simulate Simulate (Simulate input from the MUD, for debugging purposes)
FNC_Sound Sound (Plays a sound)
FNC_StripANSI StripANSI (Strips ANSI colour sequences from a string)
FNC_Trace Trace (Trace mode property)
FNC_TraceOut TraceOut (Outputs the supplied message to the world Trace)
FNC_TranslateGerman TranslateGerman (Translate German umluat sequences)
FNC_Transparency Transparency (Sets the transparency of the main MUSHclient window under Windows XP)
FNC_Trim Trim (Trims leading and trailing spaces from a string)

(Help topic: function=Replace)

DOC_contents Documentation contents page