Simulate
Script function

world.Simulate

DOC_scripting Read about scripting

Type

Method

Summary

Simulate input from the MUD, for debugging purposes

Prototype

void Simulate(BSTR Text);

DOC_data_types View list of data type meanings

Description

The argument to this function is supplied to MUSHclient as if it had been sent from the MUD. This is intended for debugging triggers etc, similar to the Game -> Test Trigger menu option.

This should be used with caution inside scripts. If you simulate input inside a trigger, the input causing another trigger to fire, you are likely to get a stack overflow.

An example of using it would be to bind it to a keystroke (like F11), so that if you are testing a trigger that matches on:

Exits: north

... then you might do this:

Accelerator ("F11", "/Simulate 'Exits: north\n' ")

VBscript example

Simulate "Exits: north" + vbCrLf


Jscript example

Simulate ("Exits: north\n");


Lua example

Simulate ("Exits: north\n")


Lua notes

You can supply multiple arguments, which are concatenated together.


Return value

Nothing.



See Also ...

Topics

DOC_scripting Scripting
DOC_utils Utilities

Functions

FNC_AddFont AddFont (Adds a custom font for use by MUSHclient)
FNC_Base64Decode Base64Decode (Takes a base-64 encoded string and decodes it.)
FNC_Base64Encode Base64Encode (Encodes a string using base-64 encoding.)
FNC_BlendPixel BlendPixel (Blends a single pixel with another, using a specified blending mode)
FNC_ChangeDir ChangeDir (Changes the MUSHclient working directory)
FNC_CreateGUID CreateGUID (Creates a GUID - Global Unique Identifier)
FNC_Debug Debug (Displays debugging information about the world)
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_FilterPixel FilterPixel (Performs a filtering operation on one pixel)
FNC_FixupEscapeSequences FixupEscapeSequences (Converts "escape sequences" like \t to their equivalent codes.)
FNC_FixupHTML FixupHTML (Fixes up text for writing as HTML)
FNC_FlashIcon FlashIcon (Flashes the MUSHclient icon on the Windows taskbar)
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_GetSoundStatus GetSoundStatus (Gets the status of a sound started by PlaySound)
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_MoveMainWindow MoveMainWindow (Move and resize the main MUSHclient window)
FNC_MoveWorldWindow MoveWorldWindow (Move and resize a world window)
FNC_MoveWorldWindowX MoveWorldWindowX (Move and resize a specific world window)
FNC_MtRand MtRand (Returns pseudo-random number using the Mersenne Twister algorithm)
FNC_MtSrand MtSrand (Seed the Mersenne Twister pseudo-random number generator)
FNC_PlaySound PlaySound (Plays a sound using DirectSound)
FNC_ReadNamesFile ReadNamesFile (Loads in a file for generating character names)
FNC_Replace Replace (Replaces one substring with another)
FNC_SetBackgroundColour SetBackgroundColour (Sets a background colour for the output window)
FNC_SetBackgroundImage SetBackgroundImage (Sets a background image for the output window)
FNC_SetClipboard SetClipboard (Sets the clipboard contents)
FNC_SetForegroundImage SetForegroundImage (Sets a foreground image for the output window)
FNC_SetStatus SetStatus (Sets the status line text)
FNC_SetToolBarPosition SetToolBarPosition (Sets the position of the game toolbars on the screen.)
FNC_ShiftTabCompleteItem ShiftTabCompleteItem (Adds an item to the list shown for Shift+Tab completion)
FNC_Sound Sound (Plays a sound)
FNC_StopSound StopSound (Stop playing a sound started by PlaySound)
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_TranslateDebug TranslateDebug (Sends a debugging message to the localizing translator script)
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=Simulate)

DOC_contents Documentation contents page