GUI.TextBox

Barotrauma.GUITextBox

Functions

AddToGUIUpdateList(ignoreChildren, order)

AddToGUIUpdateList

Parameters

  • ignoreChildren bool

  • order number

ApplySizeRestrictions(style)

ApplySizeRestrictions

Parameters

  • style GUIComponentStyle

ApplyStyle(style)

ApplyStyle

Parameters

  • style GUIComponentStyle

ClearChildren()

ClearChildren

Deselect()

Deselect

DrawAuto(spriteBatch)

DrawAuto

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

DrawChildren(spriteBatch, recursive)

DrawChildren

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • recursive bool

DrawIMEPreview(spriteBatch)

DrawIMEPreview

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

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, flashRectOffset)

Flash

Parameters

  • color optional Microsoft.Xna.Framework.Color

  • flashDuration number

  • useRectangleFlash bool

  • useCircularFlash bool

  • flashRectOffset optional Microsoft.Xna.Framework.Vector2

ForceLayoutRecalculation()

ForceLayoutRecalculation

ForceUpdate()

ForceUpdate

GUITextBox(rectT, text, textColor, font, textAlignment, wrap, style, color, createClearButton, createPenIcon)

GUITextBox

Parameters

  • textColor optional Microsoft.Xna.Framework.Color

  • font GUIFont

  • textAlignment Alignment

  • wrap bool

  • color optional Microsoft.Xna.Framework.Color

  • createClearButton bool

  • createPenIcon bool

GetAllChildren()

GetAllChildren

Returns

  • IEnumerable

GetAllChildren()

GetAllChildren

Returns

  • IEnumerable

GetAnyChild()

GetAnyChild

Returns

  • T

GetChild(index)

GetChild

Parameters

  • index number

Returns

  • GUIComponent

GetChild()

GetChild

Returns

  • T

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

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(inputChar)

ReceiveTextInput

Parameters

  • inputChar Char

ReceiveTextInput(input)

ReceiveTextInput

Parameters

RemoveChild(child)

RemoveChild

Parameters

  • child GUIComponent

RemoveFromGUIUpdateList(alsoChildren)

RemoveFromGUIUpdateList

Parameters

  • alsoChildren bool

Select(forcedCaretIndex, ignoreSelectSound)

Select

Parameters

  • forcedCaretIndex number

  • ignoreSelectSound bool

SelectAll()

SelectAll

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

UpdateManually(deltaTime, alsoChildren, recursive)

UpdateManually

Parameters

  • deltaTime number

  • alsoChildren bool

  • recursive bool

Fields

AlwaysOverrideCursor

AlwaysOverrideCursor, field of type bool

  • AlwaysOverrideCursor

AutoDraw

AutoDraw, field of type bool

  • AutoDraw

AutoUpdate

AutoUpdate, field of type bool

  • AutoUpdate

Bounce

Bounce, field of type bool

  • Bounce

CanBeFocused

CanBeFocused, field of type bool

  • CanBeFocused

CaretColor

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

  • CaretColor

CaretEnabled

CaretEnabled, field of type bool

  • CaretEnabled

CaretIndex

CaretIndex, field of type number

  • CaretIndex

CaretScreenPos

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

  • CaretScreenPos

Censor

Censor, field of type bool

  • Censor

Center

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

  • Center

Children

Children, field of type IEnumerable

  • Children

ClampMouseRectToParent

ClampMouseRectToParent, field of type bool

  • ClampMouseRectToParent

ClampText

ClampText, field of type bool

  • ClampText

Color

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

  • Color

ColorCrossFadeTime

ColorCrossFadeTime, field of type number

  • ColorCrossFadeTime

ColorTransition

ColorTransition, field of type TransitionMode

  • ColorTransition

CountChildren

CountChildren, field of type number

  • CountChildren

DefaultColor

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

  • DefaultColor

DeselectAfterMessage

DeselectAfterMessage, field of type bool

  • DeselectAfterMessage

DisabledColor

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

  • DisabledColor

Enabled

Enabled, field of type bool

  • Enabled

ExternalHighlight

ExternalHighlight, field of type bool

  • ExternalHighlight

FallBackState

FallBackState, field of type SpriteFallBackState

  • FallBackState

FlashTimer

FlashTimer, field of type number

  • FlashTimer

Font

Font, field of type GUIFont

  • Font

Frame

Frame, field of type GUIFrame

  • Frame

GlowOnSelect

GlowOnSelect, field of type bool

  • GlowOnSelect

HoverColor

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

  • HoverColor

HoverCursor

HoverCursor, field of type CursorState

  • HoverCursor

IgnoreLayoutGroups

IgnoreLayoutGroups, field of type bool

  • IgnoreLayoutGroups

IsIMEActive

IsIMEActive, field of type bool

  • IsIMEActive

MaxTextLength

MaxTextLength, field of type ?Int32

  • MaxTextLength

MouseRect

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

  • MouseRect

OnAddedToGUIUpdateList

OnAddedToGUIUpdateList, field of type Action

  • OnAddedToGUIUpdateList

OnEnterPressed

OnEnterPressed, field of type OnEnterHandler

  • OnEnterPressed

OnSecondaryClicked

OnSecondaryClicked, field of type SecondaryButtonDownHandler

  • OnSecondaryClicked

OnTextChangedDelegate

OnTextChangedDelegate, field of type OnTextChangedHandler

  • OnTextChangedDelegate

OutlineColor

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

  • OutlineColor

OverflowClip

OverflowClip, field of type bool

  • OverflowClip

Padding

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

  • Padding

Parent

Parent, field of type GUIComponent

  • Parent

PlaySoundOnSelect

PlaySoundOnSelect, field of type bool

  • PlaySoundOnSelect

PressedColor

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

  • PressedColor

Readonly

Readonly, field of type bool

  • Readonly

Rect

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

  • Rect

RectTransform

RectTransform, field of type RectTransform

  • RectTransform

Selected

Selected, field of type bool

  • Selected

SelectedColor

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

  • SelectedColor

SelectionColor

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

  • SelectionColor

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

Text

Text, field of type string

  • Text

TextBlock

TextBlock, field of type GUITextBlock

  • TextBlock

TextColor

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

  • TextColor

TextGetter

TextGetter, field of type TextGetterHandler

  • TextGetter

ToolTip

ToolTip, field of type RichString

  • ToolTip

UVOffset

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

  • UVOffset

UpdateOrder

UpdateOrder, field of type number

  • UpdateOrder

UserData

UserData, field of type Object

  • UserData

Visible

Visible, field of type bool

  • Visible

Wrap

Wrap, field of type bool

  • Wrap

WrappedText

WrappedText, field of type string

  • WrappedText

sprites

sprites, field of type table

  • sprites

textFilterFunction

textFilterFunction, field of type function

  • textFilterFunction