ImportXML
Script function world.ImportXML Read about scripting Type Method Summary Imports configuration data in XML format Prototype `long ImportXML(BSTR XML);` View list of data type meanings Description `This duplicates the functionality in the File menu -> Import -> Clipboard. It allows you to import one or more triggers, aliases, macros, timers, variables, colours, numeric keypad configuration items. The two things you cannot import here are general world configuration (use SetOption and SetAlphaOption for that), and plugins. The XML text should start with one of the following, or -1 will be returned: <?xml <!-- <!DOCTYPE <muclient <world <triggers <aliases <timers <macros <variables <colours <keypad <printing <comment <include <plugin <script In other words, to import a trigger you should start with <triggers>. You can import more than one type of thing, eg. <triggers> ... </triggers> <aliases> ... </aliases> The syntax is exactly the same as used in the world file, or if you copy a trigger/alias/timers/variable to the clipboard from the world configuration screens. If there is a parsing error (eg. bad XML format, like unterminated element, or unknown option for an item) then a text window will open with the error description shown. Also, the function will return -2. If there is no parsing error then the function will return the number of items imported, which might be zero if the syntax was OK, but nothing was actually added, eg. "<triggers></triggers>" would parse OK but not add anything. If you copy triggers etc. from the world configuration then you will need to "double" the quotes (or escape them appropriately) as you will probably have quotes within quotes. See the examples below for more details.` VBscript example
    ImportXML _
      "<timers>" & _
      "<timer name=""mylabel"" script=""timerscript"" enabled=""y"" hour=""16"" at_time=""y"" >" & _
      "</timer>" &_
      "</timers>"
Jscript example
    ImportXML (
      "<timers>" +
      "<timer name="mylabel" script="timerscript" enabled="y" hour="16" at_time="y" >" +
      "</timer>" +
      "</timers>");
PerlScript example
    ImportXML (
      "<timers>" .
      "<timer name="mylabel" script="timerscript" enabled="y" hour="16" at_time="y" >" .
      "</timer>" .
      "</timers>");
Python example
    world.ImportXML (
      "<timers>" +
      "<timer name="mylabel" script="timerscript" enabled="y" hour="16" at_time="y" >" +
      "</timer>" +
      "</timers>")
Lua example
    ImportXML
    [[
    <timers>
      <timer name="mytimer"
             enabled="y"
             minute="10"
             group="battle" >
      <send>sigh</send>
      </timer>
    </timers>
    ]]
Lua notes
    A useful trick in Lua is to use multiple-line constants, as illustrated above.
Return value
    -1 : not XML format - failed initial check
    -2 : error parsing XML - see error window
    0 or more: count of items imported
See Also ... Topics Scripting Utilities Functions AddAlias (Adds an alias) AddTimer (Adds a timer) AddTrigger (Adds a trigger) 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) Metaphone (Returns the metaphone code for the supplied word) 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) SetAlphaOption (Sets value of a named world alphanumeric option) SetClipboard (Sets the clipboard contents) SetOption (Sets value of a named world option) 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=ImportXML) Documentation contents page