Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SpellCheckDlg


Name SpellCheckDlg
Type Method
Summary Spell checks an arbitrary string of text, invloking the spell-checker dialog
Prototype VARIANT SpellCheckDlg(BSTR Text);
Description

This function lets you call the MUSHclient spell-checker from a script on any arbitrary text string.

Note that if the spell-check engine has not been initialised (eg. the DLL is not present, or the spell check dictionary is not there), it returns the Empty variant (or nil in Lua).

You supply a string of text to be checked.

The corrected string is returned, after the spellchecker dialog box has been invoked, as many times as necessary, for each misspelt word. If the dialog box is canclled them the NULL variant (or nil in Lua) is returned.


Note: Available in version 3.85 onwards.


VBscript example
result = SpellCheckDlg _
  ("Twas brillig, and the slithy toves Did gyre and gimble in the the wabe")

if IsEmpty (result) then
  Note "Spell check cancelled"
else
  Note "Corrected string: " & result
end if
Lua example
result = SpellCheckDlg  (
  "Twas brillig, and the slithy toves Did gyre and gimble in the the wabe")

print (type (result))

if result == nil then
  Note "Spell check cancelled"
else
  Note ("Corrected string: ", result)
end -- if
Returns If the spell checker is not available, or if the spellcheck dialog box is cancelled, an Empty variant (or nil in Lua).

Otherwise, the supplied string is returned, with any misspelt words corrected.
Introduced in version 3.85

See also ...

Function Description
AddSpellCheckWord Adds a word to the user spell check dictionary
SpellCheck Spell checks an arbitrary string of text
SpellCheckCommand Spell checks the text in the command 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

[Back]

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