Difference between revisions of "LGUI2:LS1:lgui2animateargs"
Jump to navigation
Jump to search
(Created page with "{{ObjectType-Vitals|lgui2animateargs|LavishGUI 2|none|lgui2animateargs|none|no|void *}} A lgui2animateargs object is provided as the Context Top-Level Object when an LG...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ObjectType-Vitals|lgui2animateargs|[[LavishGUI 2]]|none|lgui2animateargs|none|no|void *}} | {{ObjectType-Vitals|lgui2animateargs|[[LavishGUI 2]]|none|lgui2animateargs|none|no|void *}} | ||
| − | A lgui2animateargs object is provided as the Context Top-Level Object when an [[LGUI2:Animation]] is processing. | + | A lgui2animateargs object is provided as the Context Top-Level Object when an [[LGUI2:Animation|Animation]] is processing. |
| + | |||
== Members == | == Members == | ||
| Line 11: | Line 12: | ||
* [[ObjectType:uint|uint]] '''Timestamp''': The current Timestamp | * [[ObjectType:uint|uint]] '''Timestamp''': The current Timestamp | ||
* [[LGUI2:LS1:elgui2animationframestate|elgui2animationframestate]] '''FrameState''': The current state (Start, Continue, Stop) | * [[LGUI2:LS1:elgui2animationframestate|elgui2animationframestate]] '''FrameState''': The current state (Start, Continue, Stop) | ||
| + | * [[ObjectType:unistring|unistring]] '''Error''': An error message set by the SetError method, indicating an error condition on the Animation (and resulting in a Stop) | ||
| + | |||
== Methods == | == Methods == | ||
| + | * '''SetError['''error''']''': An error message to indicate an error condition on a custom Animation. The Animation will Stop. | ||
| + | |||
== Examples == | == Examples == | ||
| + | |||
{{LGUI2:ObjectType}} | {{LGUI2:ObjectType}} | ||
[[Category:LavishGUI 2 Animations]] | [[Category:LavishGUI 2 Animations]] | ||
Latest revision as of 01:33, 17 November 2018
| lgui2animateargs | |
| Defined By | LavishGUI 2 |
| Inherits | none |
| Reduces To | lgui2animateargs |
| Variable Object Type | none |
| Uses Sub-Types | no |
| C/C++ Type | void * |
A lgui2animateargs object is provided as the Context Top-Level Object when an Animation is processing.
Members
- lgui2animation Animation: The Animation object
- lgui2element Element: The Element to animate
- jsonobject Args: The Item data (also accessible via Item.Data)
- jsonvalue Args[key]: Retrieves a value from the Item data
- uint Timestamp: The current Timestamp
- elgui2animationframestate FrameState: The current state (Start, Continue, Stop)
- unistring Error: An error message set by the SetError method, indicating an error condition on the Animation (and resulting in a Stop)
Methods
- SetError[error]: An error message to indicate an error condition on a custom Animation. The Animation will Stop.
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
