This section lists all methods that the GuiSys (C++) code predefines for the GUI windows of all window classes. These methods are intended to be called from your Lua scripts for convenient access to the window details. These are the key methods for setting up and customizing the windows of your GUI.

Currently, all methods are available for all window classes (windowClass, editClass, etc.), and behave identically. Deviations from this rule are mentioned explicitly in the respective documentation below.

Sets the window variable with name var to the given value.

Nothing (nil).

Many variables are tuples of 2 or 4 individual values. E.g. all color values have a red, green, blue and alpha component, and positions have an x- and y-component. Therefore, for many variables there is a form with which you can set all components at once, and forms with which you can set a subset of the components.

Here is a list with all variable names that you can use for var, in logically grouped order. The second column indicates how many arguments and their related types are expected.

• Also note that all coordinates are given with regards to the “virtual screen coordinate system”, which has a resolution of 640 * 480 pixels and is automatically scaled to the true resolution.
• Color components (red, green, blue and alpha) are always given in percent, that is, as fractional values between 0 and 1.

    function ConsoleFrame:OnInit()
        self:set("rect", 20, 20, 600, 440);
        self:set("backColor", 0.82, 0.49, 0.17, 0.2);
        self:set("borderWidth", 0.7);
        self:set("borderColor", 0.82, 0.49, 0.17, 1.0);
        self:set("text", "Hello!");
    end

Returns the value the window variable.

The value of the desired variable in the appropriate type.

As Lua supports tuples as return types, this method works with all variables listed at the set() method, except for “backMaterial” and “font”, which are write-only.

• Cannot be used with the variables “backMaterial” and “font”, as they are write-only.

    function RotatingWin:OnFrame()
        self:set("rotAngle", self:get("time")*50);
    end
 
    function OtherWin:OnAction()
        -- Toggle the hor. text alignment of RotatingWin.
        local newAlign=RotatingWin:get("textAlignHor")+1;
        if (newAlign>2) then newAlign=0; end
 
        RotatingWin:set("textAlignHor", newAlign);
    end

Interpolates the value of the given variable from start value s to end value e over time t.

Nothing (nil).

• For var only variables of type number are allowed, see set() for a list.

    function ButtonOK:OnMouseEnter()
        self:interpolate("rotAngle", 0, 360, 250);
        self:interpolate("textScale", 0.2, 0.25, 500);
        self:interpolate("pos.y", 300, 380, 750);
    end

Returns a short string that describes the window.

None.

A short string that describes the window.

• This method is not intended to be called directly. Rather, it's the metamethod for Luas tostring() method that allows the conversion of a window into a string.

This method makes the following examples work:

    s=tostring(myWin);    -- myWin is a GuiSys window object (which has the __tostring() metamethod).
    print(s);
 
    print(myWin);         -- Same as:   print(tostring(myWin));