[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.WindowSetZOrder


Name WindowSetZOrder
Type Method
Summary Sets the Z-Order for a miniwindow
Prototype long WindowSetZOrder(BSTR WindowName, long Order);

View list of data type meanings

Description

Sets a Z-Order (drawing order) for the 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.

Parameters:

WindowName - the name of an existing miniwindow.

Order - the order to draw the window. Lower is drawn sooner. Windows with the same Z-Order are drawn in window name order. So for example, the default case of a zero Z-Order results in windows being drawn in name order.

More specifically:

* Windows with a negative Z-order are drawn first (in order, so -2 would be drawn before -1).

* Windows with a zero Z-order (the default) are drawn next, in name order (lower name first)

* Windows with a positive Z-order are drawn last, in Z-order sequence.

* If there are two (or more) windows with the same Z-order number, they are drawn in name order.

Note that being "drawn first" means that a window appears underneath a window which is drawn later.


Note: Available in version 4.73 onwards.


Lua example
WindowSetZOrder (win, 20)
Returns eNoSuchWindow - no such miniwindow

eOK - success

View list of return code meanings

Introduced in version 4.73

See also ...

Function Description
WindowArc Draws an arc in a miniwindow
WindowBezier Draws a B├ęzier curve in a miniwindow
WindowCircleOp Draws ellipses, filled rectangles, round rectangles, chords, pies in a miniwindow
WindowCreate Creates a miniwindow
WindowDrawImage Draws an image into a miniwindow
WindowGetPixel Gets the colour of a single pixel in a miniwindow
WindowLine Draws a line in a miniwindow
WindowPolygon Draws a polygon in a miniwindow
WindowRectOp Draws a rectangle in 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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]