Difference between revisions of "LGUI2:LS1:lgui2"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 27: Line 27:
  
  
[[Category:LavishGUI 2]]
+
{{LGUI2:ObjectType}}
[[Category:LavishGUI 2 LavishScript API]]
 

Revision as of 14:41, 5 July 2018

Object Type Vitals
lgui2
Defined By LavishGUI 2
Inherits none
Reduces To LavishGUI 2.0
Variable Object Type none
Uses Sub-Types no
C/C++ Type

The lgui2 object type is the main LavishScript interface to LavishGUI 2

Members

  • ... LoadFile[filename]: Loads an Element file into the base LavishGUI 2 layer, returning an lgui2element-derived object type depending on the LavishGUI 2 element type. A JSON Object is expected in the file.
  • lgui2screen Screen: The root element for the "base" (default) Layer
  • ... Element[#]: Retrieves an Element by ID #
  • ... Element[elementName,elementType,locateFlags]: Locates an Element
  • lgui2elementtype ElementType[elementType]:

Methods

  • Clear: Clears the base LavishGUI 2 layer
  • LoadBindingsFile[filename]: Loads an Input Bindings file into the base LavishGUI 2 layer. A JSON Array is expected in the file.
  • LoadFile[filename]: Loads an Element file into the base LavishGUI 2 layer. A JSON Object is expected in the file.
  • LoadSkinFile[filename]: Loads a Skin file into the base LavishGUI 2 layer. A JSON Object is expected in the file.
  • PushSkin[skin name]: Pushes a Skin by name onto the Skin stack
  • PopSkin[skin name]: Pops a Skin by name off of the Skin stack, if it is the top of the stack

Examples

Load a Skin file
LGUI2:LoadSkinFile["testskin.json"]
Push a Skin called "test skin" on to the Skin stack
LGUI2:PushSkin["test skin"]
Load an Element file
LGUI2:LoadFile["testui.json"]


LavishGUI 2 Element Types

LavishGUI 2 LavishScript Object Types

Core API (see Using LavishGUI 2 from LavishScript)
lgui2 - lgui2animateargs - lgui2animationtype - lgui2elementref - lgui2eventargs - lgui2eventhandler - lgui2elementtype - lgui2itemviewgeneratorargs - lgui2inputbinding - lgui2layer - lgui2skin - lgui2trigger
Enums
elgui2animationframestate - elgui2dpad - elgui2edge - elgui2fontflags - elgui2horizontalalignment - elgui2imageorientation - elgui2progresstext - elgui2scrollbar - elgui2sizetocontent - elgui2verticalignment - elgui2visibility
Element Components
lgui2animation - lgui2brush - lgui2fontstyle - lgui2margins - lgui2item - lgui2property - lgui2radialitem - lgui2radialgaugeneedle
Element Base Types
lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
Elements