Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WindowTextWidth

Name WindowTextWidth
Type Method
Summary Calculates the width of text in a miniwindow
Prototype long WindowTextWidth(BSTR WindowName, BSTR FontId, BSTR Text, BOOL Unicode);

View list of data type meanings
Description

This calculates how many pixels a particular piece of text will take up, which can help in calculating how big a window to create, or where to put other things. Note that WindowText returns the number of pixels when it draws text, so you don't need to call WindowTextWidth simply to work out where to draw the very next item.

WindowName - the name of an existing miniwindow.

FontId - a font id that you have loaded.

Text - the text to be calculated (maximum of 8192 characters)

Unicode - if true, the text is Unicode text in UTF-8 format


For more information, see:

http://www.gammon.com.au/mushclient/mw_text.htm

Note: Available in version 4.34 onwards.
Lua example 
width   = WindowTextWidth (win, "f", "Lazy dog yawns")  -- width of text
Returns If successful, returns the number of pixels the text would take horizontally.

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 4.34

See also ...

Function Description
WindowCreate Creates a miniwindow
WindowFont Loads a font into a miniwindow
WindowFontInfo Returns information about a font
WindowFontList Lists all fonts loaded into a miniwindow
WindowText Draws text into a miniwindow

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.

Home