GUI.ListBox

Barotrauma.GUIListBox

Functions

AddToGUIUpdateList(ignoreChildren, order)

AddToGUIUpdateList

Parameters

  • ignoreChildren bool

  • order number

ApplySizeRestrictions(style)

ApplySizeRestrictions

Parameters

  • style GUIComponentStyle

ApplyStyle(style)

ApplyStyle

Parameters

  • style GUIComponentStyle

CalculateTopOffset()

CalculateTopOffset

Returns

  • Microsoft.Xna.Framework.Vector2

ClearChildren()

ClearChildren

Deselect()

Deselect

DeselectElement(child)

DeselectElement

Parameters

  • child GUIComponent

DrawAuto(spriteBatch)

DrawAuto

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

DrawChildren(spriteBatch, recursive)

DrawChildren

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • recursive bool

DrawManually(spriteBatch, alsoChildren, recursive)

DrawManually

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • alsoChildren bool

  • recursive bool

DrawToolTip(spriteBatch)

DrawToolTip

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

Equals(obj)

Equals

Parameters

  • obj Object

Returns

  • bool

FadeIn(wait, duration, alsoChildren)

FadeIn

Parameters

  • wait number

  • duration number

  • alsoChildren bool

FadeOut(duration, removeAfter, wait, onRemove, alsoChildren)

FadeOut

Parameters

  • duration number

  • removeAfter bool

  • wait number

  • onRemove Action

  • alsoChildren bool

FindChild(predicate, recursive)

FindChild

Parameters

  • predicate function

  • recursive bool

Returns

  • GUIComponent

FindChild(userData, recursive)

FindChild

Parameters

  • userData Object

  • recursive bool

Returns

  • GUIComponent

FindChildren(predicate)

FindChildren

Parameters

  • predicate function

Returns

  • IEnumerable

FindChildren(userData)

FindChildren

Parameters

  • userData Object

Returns

  • IEnumerable

Flash(color, flashDuration, useRectangleFlash, useCircularFlash, flashRectInflate)

Flash

Parameters

  • color optional Microsoft.Xna.Framework.Color

  • flashDuration number

  • useRectangleFlash bool

  • useCircularFlash bool

  • flashRectInflate optional Microsoft.Xna.Framework.Vector2

ForceLayoutRecalculation()

ForceLayoutRecalculation

ForceUpdate()

ForceUpdate

GUIListBox(rectT, isHorizontal, color, style, isScrollBarOnDefaultSide, useMouseDownToSelect)

GUIListBox

Parameters

  • isHorizontal bool

  • color optional Microsoft.Xna.Framework.Color

  • isScrollBarOnDefaultSide bool

  • useMouseDownToSelect bool

GetAllChildren()

GetAllChildren

Returns

  • IEnumerable

GetAllChildren()

GetAllChildren

Returns

  • IEnumerable

GetAnyChild()

GetAnyChild

Returns

  • T

GetChild()

GetChild

Returns

  • T

GetChild(index)

GetChild

Parameters

  • index number

Returns

  • GUIComponent

GetChildByUserData(obj)

GetChildByUserData

Parameters

  • obj Object

Returns

  • GUIComponent

GetChildIndex(child)

GetChildIndex

Parameters

  • child GUIComponent

Returns

  • number

GetHashCode()

GetHashCode

Returns

  • number

GetType()

GetType

Returns

  • Type

ImmediateFlash(color)

ImmediateFlash

Parameters

  • color optional Microsoft.Xna.Framework.Color

InheritTotalChildrenHeight()

InheritTotalChildrenHeight

InheritTotalChildrenMinHeight()

InheritTotalChildrenMinHeight

IsChildOf(component, recursive)

IsChildOf

Parameters

  • component GUIComponent

  • recursive bool

Returns

  • bool

IsParentOf(component, recursive)

IsParentOf

Parameters

  • component GUIComponent

  • recursive bool

Returns

  • bool

Pulsate(startScale, endScale, duration)

Pulsate

Parameters

  • startScale Microsoft.Xna.Framework.Vector2

  • endScale Microsoft.Xna.Framework.Vector2

  • duration number

RecalculateChildren()

RecalculateChildren

ReceiveCommandInput(command)

ReceiveCommandInput

Parameters

  • command Char

ReceiveEditingInput(text, start, length)

ReceiveEditingInput

Parameters

  • start number

  • length number

ReceiveSpecialInput(key)

ReceiveSpecialInput

Parameters

  • key Microsoft.Xna.Framework.Input.Keys

ReceiveTextInput(text)

ReceiveTextInput

Parameters

ReceiveTextInput(inputChar)

ReceiveTextInput

Parameters

  • inputChar Char

RemoveChild(child)

RemoveChild

Parameters

  • child GUIComponent

RemoveFromGUIUpdateList(alsoChildren)

RemoveFromGUIUpdateList

Parameters

  • alsoChildren bool

ScrollToElement(component, playSelectSound)

ScrollToElement

Parameters

  • component GUIComponent

  • playSelectSound PlaySelectSound

ScrollToEnd(duration)

ScrollToEnd

Parameters

  • duration number

Select(userData, force, autoScroll)

Select

Parameters

  • userData Object

  • force Force

  • autoScroll AutoScroll

Select(children)

Select

Parameters

  • children IEnumerable

Select(childIndex, force, autoScroll, takeKeyBoardFocus, playSelectSound)

Select

Parameters

  • childIndex number

  • force Force

  • autoScroll AutoScroll

  • takeKeyBoardFocus TakeKeyBoardFocus

  • playSelectSound PlaySelectSound

SelectNext(force, autoScroll, takeKeyBoardFocus, playSelectSound)

SelectNext

Parameters

  • force Force

  • autoScroll AutoScroll

  • takeKeyBoardFocus TakeKeyBoardFocus

  • playSelectSound PlaySelectSound

SelectPrevious(force, autoScroll, takeKeyBoardFocus, playSelectSound)

SelectPrevious

Parameters

  • force Force

  • autoScroll AutoScroll

  • takeKeyBoardFocus TakeKeyBoardFocus

  • playSelectSound PlaySelectSound

SetAsFirstChild()

SetAsFirstChild

SetAsLastChild()

SetAsLastChild

SlideIn(wait, duration, amount, direction)

SlideIn

Parameters

  • wait number

  • duration number

  • amount number

  • direction SlideDirection

SlideOut(duration, amount, direction)

SlideOut

Parameters

  • duration number

  • amount number

  • direction SlideDirection

ToString()

ToString

Returns

UpdateAuto(deltaTime)

UpdateAuto

Parameters

  • deltaTime number

UpdateChildren(deltaTime, recursive)

UpdateChildren

Parameters

  • deltaTime number

  • recursive bool

UpdateDimensions()

UpdateDimensions

UpdateManually(deltaTime, alsoChildren, recursive)

UpdateManually

Parameters

  • deltaTime number

  • alsoChildren bool

  • recursive bool

UpdateScrollBarSize()

UpdateScrollBarSize

Fields

AfterSelected

AfterSelected, field of type OnSelectedHandler

  • AfterSelected

AllSelected

AllSelected, field of type IReadOnlyList

  • AllSelected

AllowArrowKeyScroll

AllowArrowKeyScroll, field of type bool

  • AllowArrowKeyScroll

AllowMouseWheelScroll

AllowMouseWheelScroll, field of type bool

  • AllowMouseWheelScroll

AlwaysOverrideCursor

AlwaysOverrideCursor, field of type bool

  • AlwaysOverrideCursor

AutoDraw

AutoDraw, field of type bool

  • AutoDraw

AutoHideScrollBar

AutoHideScrollBar, field of type bool

  • AutoHideScrollBar

AutoUpdate

AutoUpdate, field of type bool

  • AutoUpdate

BarScroll

BarScroll, field of type number

  • BarScroll

BarSize

BarSize, field of type number

  • BarSize

Bounce

Bounce, field of type bool

  • Bounce

CanBeFocused

CanBeFocused, field of type bool

  • CanBeFocused

CanInteractWhenUnfocusable

CanInteractWhenUnfocusable, field of type bool

  • CanInteractWhenUnfocusable

CanTakeKeyBoardFocus

CanTakeKeyBoardFocus, field of type bool

  • CanTakeKeyBoardFocus

Center

Center, field of type Microsoft.Xna.Framework.Vector2

  • Center

CheckSelected

CheckSelected, field of type CheckSelectedHandler

  • CheckSelected

Children

Children, field of type IEnumerable

  • Children

ClampMouseRectToParent

ClampMouseRectToParent, field of type bool

  • ClampMouseRectToParent

ClampScrollToElements

ClampScrollToElements, field of type bool

  • ClampScrollToElements

Color

Color, field of type Microsoft.Xna.Framework.Color

  • Color

ColorCrossFadeTime

ColorCrossFadeTime, field of type number

  • ColorCrossFadeTime

ColorTransition

ColorTransition, field of type TransitionMode

  • ColorTransition

Content

Content, field of type GUIFrame

  • Content

ContentBackground

ContentBackground, field of type GUIFrame

  • ContentBackground

CountChildren

CountChildren, field of type number

  • CountChildren

CurrentDragMode

CurrentDragMode, field of type DragMode

  • CurrentDragMode

CurrentSelectMode

CurrentSelectMode, field of type SelectMode

  • CurrentSelectMode

DefaultColor

DefaultColor, field of type Microsoft.Xna.Framework.Color

  • DefaultColor

DisabledColor

DisabledColor, field of type Microsoft.Xna.Framework.Color

  • DisabledColor

DraggedElement

DraggedElement, field of type GUIComponent

  • DraggedElement

Enabled

Enabled, field of type bool

  • Enabled

ExternalHighlight

ExternalHighlight, field of type bool

  • ExternalHighlight

FadeElements

FadeElements, field of type bool

  • FadeElements

FallBackState

FallBackState, field of type SpriteFallBackState

  • FallBackState

FlashTimer

FlashTimer, field of type number

  • FlashTimer

Font

Font, field of type GUIFont

  • Font

GlowOnSelect

GlowOnSelect, field of type bool

  • GlowOnSelect

HasDraggedElementIndexChanged

HasDraggedElementIndexChanged, field of type bool

  • HasDraggedElementIndexChanged

HideChildrenOutsideFrame

HideChildrenOutsideFrame, field of type bool

  • HideChildrenOutsideFrame

HideDraggedElement

HideDraggedElement, field of type bool

  • HideDraggedElement

HoverColor

HoverColor, field of type Microsoft.Xna.Framework.Color

  • HoverColor

HoverCursor

HoverCursor, field of type CursorState

  • HoverCursor

IgnoreLayoutGroups

IgnoreLayoutGroups, field of type bool

  • IgnoreLayoutGroups

KeepSpaceForScrollBar

KeepSpaceForScrollBar, field of type bool

  • KeepSpaceForScrollBar

MouseRect

MouseRect, field of type Microsoft.Xna.Framework.Rectangle

  • MouseRect

OnAddedToGUIUpdateList

OnAddedToGUIUpdateList, field of type Action

  • OnAddedToGUIUpdateList

OnRearranged

OnRearranged, field of type OnRearrangedHandler

  • OnRearranged

OnSecondaryClicked

OnSecondaryClicked, field of type SecondaryButtonDownHandler

  • OnSecondaryClicked

OnSelected

OnSelected, field of type OnSelectedHandler

  • OnSelected

OutlineColor

OutlineColor, field of type Microsoft.Xna.Framework.Color

  • OutlineColor

PadBottom

PadBottom, field of type bool

  • PadBottom

Padding

Padding, field of type Microsoft.Xna.Framework.Vector4

  • Padding

Parent

Parent, field of type GUIComponent

  • Parent

PlaySoundOnDragStop

PlaySoundOnDragStop, field of type bool

  • PlaySoundOnDragStop

PlaySoundOnSelect

PlaySoundOnSelect, field of type bool

  • PlaySoundOnSelect

PressedColor

PressedColor, field of type Microsoft.Xna.Framework.Color

  • PressedColor

Rect

Rect, field of type Microsoft.Xna.Framework.Rectangle

  • Rect

RectTransform

RectTransform, field of type RectTransform

  • RectTransform

ResizeContentToMakeSpaceForScrollBar

ResizeContentToMakeSpaceForScrollBar, field of type bool

  • ResizeContentToMakeSpaceForScrollBar

ScrollBar

ScrollBar, field of type GUIScrollBar

  • ScrollBar

ScrollBarEnabled

ScrollBarEnabled, field of type bool

  • ScrollBarEnabled

ScrollBarVisible

ScrollBarVisible, field of type bool

  • ScrollBarVisible

SelectMultiple

SelectMultiple, field of type bool

  • SelectMultiple

SelectTop

SelectTop, field of type bool

  • SelectTop

Selected

Selected, field of type bool

  • Selected

SelectedColor

SelectedColor, field of type Microsoft.Xna.Framework.Color

  • SelectedColor

SelectedComponent

SelectedComponent, field of type GUIComponent

  • SelectedComponent

SelectedData

SelectedData, field of type Object

  • SelectedData

SelectedIndex

SelectedIndex, field of type number

  • SelectedIndex

SmoothScroll

SmoothScroll, field of type bool

  • SmoothScroll

SoundOnDragStart

SoundOnDragStart, field of type ?GUISoundType

  • SoundOnDragStart

SoundOnDragStop

SoundOnDragStop, field of type ?GUISoundType

  • SoundOnDragStop

Spacing

Spacing, field of type number

  • Spacing

SpriteCrossFadeTime

SpriteCrossFadeTime, field of type number

  • SpriteCrossFadeTime

SpriteEffects

SpriteEffects, field of type Microsoft.Xna.Framework.Graphics.SpriteEffects

  • SpriteEffects

State

State, field of type ComponentState

  • State

Style

Style, field of type GUIComponentStyle

  • Style

ToolTip

ToolTip, field of type RichString

  • ToolTip

TotalSize

TotalSize, field of type number

  • TotalSize

UVOffset

UVOffset, field of type Microsoft.Xna.Framework.Vector2

  • UVOffset

UpdateOrder

UpdateOrder, field of type number

  • UpdateOrder

UseGridLayout

UseGridLayout, field of type bool

  • UseGridLayout

UserData

UserData, field of type Object

  • UserData

Visible

Visible, field of type bool

  • Visible

sprites

sprites, field of type table

  • sprites