Description of MUSHclient world function: world.WindowText
||Draws text into a miniwindow
long WindowText(BSTR WindowName, BSTR FontId, BSTR Text, long Left, long Top, long Right, long Bottom, long Colour, BOOL Unicode);
View list of data type meanings
This draws some text in miniwindow.
Note that changes to miniwindows will not become visible until the output window is redrawn. This happens when new (visible) lines arrive from the MUD, or if you call WindowShow, or Redraw.
This function does not do anything special for newlines, carriage-returns, tabs etc. Probably a box or graphical character will be drawn if you attempt to use them. To handle changing lines you will need to do a second WindowText with the Y (Top) parameter increased. To handle tabbing you would need to increase the X (Left) parameter.
WindowName - the name of an existing miniwindow.
FontId - a font id that you have loaded.
Text - the text to be drawn (maximum of 8192 characters)
Left, Top, Right, Bottom - describes the rectangle to be drawn.
Colour - what colour to draw the text in (RGB)
Unicode - if true, the text is Unicode text in UTF-8 format
For more information, see:
Note: Available in version 4.34 onwards.
WindowText (win, "f", "Quest Log",
5, 10, 0, 0, -- rectangle
false) -- not Unicode
WindowText (win, "f2", "MUSHclient",
5, 40, 0, 0, -- rectangle
false) -- not Unicode
If successful, returns the number of pixels the text took horizontally. Thus, by adding that to the "Left" parameter, you can draw some more text to the right of what was just drawn.
If unsuccessful, returns a negative number as follows:
-1 : That window name does not exist
-2 : That font was not loaded
-3 : For Unicode, invalid UTF-8 sequence
|Introduced in version
See also ...
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.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise
of the function.
view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
view a list of the data types used in function prototypes
View all functions
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )