GUIDropdownComponent

From Virtual World Web Wiki
Jump to: navigation, search

Abstract class representing components which open to have a panel of subobjects when clicked

Remarks [edit]

Properties

float AnimationDelaySeconds {get; set;}
How long to wait for the reveal/disappear animation to complete
string DisappearAnimation {get; set;}
Disappear animation to use from the animator when hiding (note: only Disappear01 right now)
string MenuItemTemplate {get; set;}
Template to use for creating subcomponents by default
bool MenuVisible {get; set;}
Hide/Show the panel of sub components
GUIPanel Panel {get;}
Reference to the panel which holds the subcomponents
GUISprite PanelSprite {get;}
Reference to the sprite on the back of the Panel
JSVector2 PopupOffset {get; set;}
Offset to place the panel from the parent button
string RevealAnimation {get; set;}
Reveal animation to use from the animator when showing (note: only Appear01 right now)

Events

OnClosing()
Event fired when we stop showing subcomponents
OnDone()
Event fired when we choose a subcomponent
OnOpening()
Event fired when we start showing subcomponents

Methods

void ClearItems()
Remove all items from this component
IEnumerable<GUIComponent> GetDropDownItems()
Returns a list of the components on the panel
GUIComponent GetItem(int i)
Returns the i'th item from the DropDownComponents collection.
List<GUIComponent> GetItems()
Returns a list of all the immediate children of this dropdown component