Description of MUSHclient world function: world.WindowArc
||Draws an arc in a miniwindow
long WindowArc(BSTR WindowName, long Left, long Top, long Right, long Bottom, long x1, long y1, long x2, long y2, long PenColour, long PenStyle, long PenWidth);
View list of data type meanings
This draws an arc from x1,y1 to x2,y2 inside the box (Left,Top,Right,Bottom) with the designated pen.
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.
WindowName - the name of an existing miniwindow.
Left, Top, Right, Bottom - describes the rectangle into which the arc must fit.
x1, y2 - the starting point for the arc - this point does not have to lie exactly on the arc.
x2, y2 - the ending point for the arc - this point does not have to lie exactly on the arc.
PenColour - the RGB colour for this pen
PenStyle - what style of pen to use:
0 - solid (an unbroken pen)
1 - dash: -------
2 - dot: .......
3 - dashdot: _._._._
4 - dashdotdot: _.._.._
5 - null (no pen)
6 - insideframe - a solid pen, drawn inside the shape
Also you can add into the style:
0x0000 - round ends (0 = the default)
0x0100 - square ends (256)
0x0200 - flat ends (512)
0x0000 - round joins (0 = the default)
0x1000 - bevel joins (4096)
0x2000 - miter joins (8192)
PenWidth - the width of the pen in pixels. For styles 1 to 4 only a width of 1 is valid.
For a particular shape, specify style 5 (no pen) if you only want to fill the shape, and not stroke it as well.
For more information, see:
Note: Available in version 4.34 onwards.
WindowArc (win, 20, 20, 80, 80, 30, 30, 120, 50, ColourNameToRGB ("green"), 0, 4)
You can use the following constants for the pen style:
miniwin.pen_solid = 0
miniwin.pen_dash = 1
miniwin.pen_dot = 2
miniwin.pen_dash_dot = 3
miniwin.pen_dash_dot_dot = 4
miniwin.pen_null = 5
miniwin.pen_inside_frame = 6
-- how lines join (eg. in polygons) (add this to the style)
miniwin.pen_join_round = 0
miniwin.pen_join_bevel = 4096
miniwin.pen_join_miter = 8192
-- how lines end (add this to the style)
miniwin.pen_endcap_round = 0
miniwin.pen_endcap_square = 256
miniwin.pen_endcap_flat = 512
eNoSuchWindow - no such miniwindow
ePenStyleNotValid - invalid pen style
eOK - completed OK
View list of return code meanings
|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 )