Difference between revisions of "LGUI2:LS1:lgui2"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 5: Line 5:
 
== Members ==
 
== Members ==
 
* ... '''LoadFile['''filename''']''': Loads an [[LGUI2:Element|Element]] file into the base LavishGUI 2 layer, returning an [[LGUI2:LS1:lgui2element|lgui2element]]-derived object type depending on the LavishGUI 2 element type. A JSON Object is expected in the file.
 
* ... '''LoadFile['''filename''']''': Loads an [[LGUI2:Element|Element]] file into the base LavishGUI 2 layer, returning an [[LGUI2:LS1:lgui2element|lgui2element]]-derived object type depending on the LavishGUI 2 element type. A JSON Object is expected in the file.
 +
* [[LGUI2:LS1:lgui2screen|lgui2screen]] '''Screen''': The root element for the "base" (default) Layer
 +
* ... '''Element['''#''']''': Retrieves an Element by ID #
 +
* ... '''Element['''elementName''','''elementType''','''locateFlags]''': [[LGUI2:Locate|Locates]] an Element
 +
* [[LGUI2:LS1:lgui2elementtype|lgui2elementtype]] '''ElementType['''elementType''']''':
  
 
== Methods ==
 
== Methods ==

Revision as of 05:01, 3 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"]