LGUI2:LS1:lgui2layer
Jump to navigation
Jump to search
lgui2layer | |
Defined By | LavishGUI 2 |
Inherits | none |
Reduces To | same as Name |
Variable Object Type | none |
Uses Sub-Types | no |
C/C++ Type | void * |
A lgui2layer object provides access to a LavishGUI 2 Layer
Members
- string Name: Name of the layer, such as "base" (the default layer)
- lgui2screen Screen: The root element for the layer
- float X: The X coordinate of the top left corner of this layer
- float Y: The Y coordinate of the top left corner of this layer
- float Width: The Width of this layer
- float Height: The Height of this layer
- float CursorX: The X coordinate of the current mouse cursor position
- float CursorY: The Y coordinate of the current mouse cursor position
- lgui2element ElementFromPoint[X,Y]: Retrieves a UI element, given an (X,Y) pair
- lgui2element KeyboardFocusElement: Retrieves the element with keyboard focus, if any
- lgui2element MouseFocusElement: Retrieves the element with mouse focus, if any
- lgui2element MouseCaptureElement: Retrieves the element with Mouse Capture, if any
- lgui2element LoadFile[filename]: Loads an Element file into the layer, returning an lgui2element-derived object type depending on the LavishGUI 2 element type. A JSON Object is expected in the file.
- uint LoadArrayFile[filename]: Loads a JSON Array file containing Elements into the layer, returning the number of elements loaded.
- lgui2element LoadJSON[json]: Loads an Element, as defined by a json object, into the layer
- lgui2hud HUD: Retrieves the HUD element
Methods
- LoadBindingsFile[filename]: Loads an Input Bindings file into the layer. A JSON Array is expected in the file.
- LoadArrayFile[filename]: Loads a JSON Array file containing Elements into the layer.
- LoadFile[filename]: Loads an Element file into the layer. A JSON Object is expected in the file.
- LoadSkinFile[filename]: Loads a Skin file into the layer. A JSON Object is expected in the file.
- AddBinding[json]: Adds an Input Binding to the layer
- RemoveBinding[name]: Removes an Input Binding from the layer by name
- LoadJSON[json]: Loads an Element, as defined by a json object, into the layer
- LoadPackageFile[filename]: Loads a Package from file
- LoadPackageJSON[json]: Loads a Package as defined by a json object
Examples
LavishGUI 2 Element Types
- Base Element Types: Element - Content Container - Headered Content Container - Item List
- Layout: anchor - border - dockpanel - dragger - expander - hud - map - page - pagecontrol -panel - popup - radialpanel - screen - scrollviewer - stackpanel - tab - tabcontrol - table - treepanel - window - wrappanel
- Display: canvas - imagebox - progressbar - radialgauge - textblock
- Interaction: button - checkbox - combobox - contextmenu - dragin - filepicker - itemview - knob - listbox - mapitemview - objectview - propertyview - scrollbar - sensitivebutton - slider - textbox
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
- Layout: lgui2anchor - lgui2border - lgui2dockpanel - lgui2dragger - lgui2expander - lgui2hud - lgui2map - lgui2page - lgui2pagecontrol - lgui2panel - lgui2popup - lgui2radialpanel - lgui2screen - lgui2scrollviewer - lgui2stackpanel - lgui2tab - lgui2tabcontrol - lgui2table - lgui2treepanel - lgui2window - lgui2wrappanel
- Display: lgui2canvas - lgui2imagebox - lgui2progressbar - lgui2radialgauge - lgui2textblock
- Interaction: lgui2button - lgui2checkbox - lgui2combobox - lgui2contextmenu - lgui2dragin - lgui2filepicker - lgui2itemview - lgui2knob - lgui2listbox - lgui2mapitemview - lgui2objectview - lgui2propertyview - lgui2scrollbar - lgui2sensitivebutton - lgui2slider - lgui2textbox