Metaphone
Script function world.Metaphone Read about scripting Type Method Summary Returns the metaphone code for the supplied word Prototype `BSTR Metaphone(BSTR Word, short Length);` View list of data type meanings Description `Returns a code indicating the "sound" of the supplied word. This is intended for use in a spell checker or similar to find words that sound the same or similar. For example: swordfish = SRTF,XRTF Gammon = KMN gamon = KMN gamin = KMN Cameron = KMRN bruise = PRS Bruce = PRS You supply the word to be converted, and a length indicating the maximum size code you want returned. This uses the "double metaphone" algorithm written by Lawrence Philips. It returns either a single metaphone (like KMN for Gammon) or two metaphones where an alternative pronunciation could be considered. Thus in the case of "swordfish" you could store that under SRTF or XRTF and consider both sound-alikes. If there is a comma present, then you know you had an alternative returned. Because of this, if you specify a 4 character length, you might get back 9 characters (two 4-character metaphones, plus a comma). Apart from the comma, only the following letters will be returned: 0 A F H J K L M N P R S T X (First one is a zero indicating the "th" sound). For a fast lookup, you could map each letter into a hex digit and then combine them into a single 16-bit number, eg. 0 = 0 A = 1 F = 2 H = 3 J = 4 K = 5 L = 6 M = 7 N = 8 P = 9 R = A S = B T = C X = D` VBscript example
    Note Metaphone ("swordfish", 4)
Lua example
    Note (Metaphone ("swordfish"))
Lua notes
    The length is optional and defaults to 4.

    Also available as utils.metaphone.
Return value
    The converted code, or two codes separated by commas.
See Also ... Topics Scripting Utilities Functions Base64Decode (Takes a base-64 encoded string and decodes it.) Base64Encode (Encodes a string using base-64 encoding.) ChangeDir (Changes the MUSHclient working directory) CreateGUID (Creates a GUID - Global Unique Identifier) EditDistance (Returns the Levenshtein Edit Distance between two words) ErrorDesc (Converts a MUSHclient script error code into an human-readable description) ExportXML (Exports a world item in XML format) FixupEscapeSequences (Converts "escape sequences" like &#x5C;t to their equivalent codes.) FixupHTML (Fixes up text for writing as HTML) GenerateName (Generates a random character name) GetClipboard (Gets the clipboard contents) GetScriptTime (Returns the amount of time spent in script routines) GetUniqueID (Creates a unique ID for general use, or for making Plugin IDs) GetUniqueNumber (Returns a unique number) Hash (Produces a hash (checksum) of a specified piece of text) Help (Shows help for a script function, or a list of functions) ImportXML (Imports configuration data in XML format) MtRand (Returns pseudo-random number using the Mersenne Twister algorithm) MtSrand (Seed the Mersenne Twister pseudo-random number generator) ReadNamesFile (Loads in a file for generating character names) Replace (Replaces one substring with another) SetClipboard (Sets the clipboard contents) SetStatus (Sets the status line text) Simulate (Simulate input from the MUD, for debugging purposes) Sound (Plays a sound) StripANSI (Strips ANSI colour sequences from a string) Trace (Trace mode property) TraceOut (Outputs the supplied message to the world Trace) TranslateGerman (Translate German umluat sequences) Transparency (Sets the transparency of the main MUSHclient window under Windows XP) Trim (Trims leading and trailing spaces from a string) (Help topic: function=Metaphone) Documentation contents page