LGUI2:LS1:lgui2animateargs

From Lavish Software Wiki
Jump to: navigation, search
Object Type Vitals
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

LavishGUI 2 LavishScript Object Types

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