GUI.SerializableEntityEditor

Barotrauma.SerializableEntityEditor

Functions

AddCustomContent(component, childIndex)

AddCustomContent

Parameters

  • component GUIComponent

  • childIndex number

AddToGUIUpdateList(ignoreChildren, order)

AddToGUIUpdateList

Parameters

  • ignoreChildren bool

  • order number

ApplySizeRestrictions(style)

ApplySizeRestrictions

Parameters

  • style GUIComponentStyle

ApplyStyle(style)

ApplyStyle

Parameters

  • style GUIComponentStyle

ClearChildren()

ClearChildren

CreateBoolField(entity, property, value, displayName, toolTip)

CreateBoolField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value bool

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateColorField(entity, property, value, displayName, toolTip)

CreateColorField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Microsoft.Xna.Framework.Color

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateEnumField(entity, property, value, displayName, toolTip)

CreateEnumField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Object

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateEnumFlagField(entity, property, value, displayName, toolTip)

CreateEnumFlagField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Object

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateFloatField(entity, property, value, displayName, toolTip)

CreateFloatField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value number

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateIntField(entity, property, value, displayName, toolTip)

CreateIntField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value number

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateNewField(property, entity)

CreateNewField

Parameters

  • property SerializableProperty

  • entity ISerializableEntity

Returns

  • GUIComponent

CreatePointField(entity, property, value, displayName, toolTip)

CreatePointField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Microsoft.Xna.Framework.Point

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateRectangleField(entity, property, value, displayName, toolTip)

CreateRectangleField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Microsoft.Xna.Framework.Rectangle

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateStringArrayField(entity, property, value, displayName, toolTip)

CreateStringArrayField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value String[]

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateStringField(entity, property, value, displayName, toolTip)

CreateStringField

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateTextPicker(textTag, entity, property, textBox)

CreateTextPicker

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • textBox GUITextBox

CreateVector2Field(entity, property, value, displayName, toolTip)

CreateVector2Field

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Microsoft.Xna.Framework.Vector2

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateVector3Field(entity, property, value, displayName, toolTip)

CreateVector3Field

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Microsoft.Xna.Framework.Vector3

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • GUIComponent

CreateVector4Field(entity, property, value, displayName, toolTip)

CreateVector4Field

Parameters

  • entity ISerializableEntity

  • property SerializableProperty

  • value Microsoft.Xna.Framework.Vector4

  • displayName LocalizedString

  • toolTip LocalizedString

Returns

  • 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(userData, recursive)

FindChild

Parameters

  • userData Object

  • recursive bool

Returns

  • GUIComponent

FindChild(predicate, recursive)

FindChild

Parameters

  • predicate function

  • 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

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

Recalculate()

Recalculate

RefreshValues()

RefreshValues

RemoveChild(child)

RemoveChild

Parameters

  • child GUIComponent

RemoveFromGUIUpdateList(alsoChildren)

RemoveFromGUIUpdateList

Parameters

  • alsoChildren bool

SerializableEntityEditor(parent, entity, inGame, showName, style, elementHeight, titleFont)

SerializableEntityEditor

Parameters

  • entity ISerializableEntity

  • inGame bool

  • showName bool

  • elementHeight number

  • titleFont GUIFont

SerializableEntityEditor(parent, entity, properties, showName, style, elementHeight, titleFont)

SerializableEntityEditor

Parameters

  • entity ISerializableEntity

  • properties IEnumerable

  • showName bool

  • elementHeight number

  • titleFont GUIFont

SerializableEntityEditor.CommitCommandBuffer()

CommitCommandBuffer

SerializableEntityEditor.IsEntityRemoved(entity)

IsEntityRemoved

Parameters

  • entity Object

Returns

  • bool

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

UpdateValue(property, newValue, flash)

UpdateValue

Parameters

  • property SerializableProperty

  • newValue Object

  • flash 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

Center

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

  • Center

Children

Children, field of type IEnumerable

  • Children

ClampMouseRectToParent

ClampMouseRectToParent, field of type bool

  • ClampMouseRectToParent

Color

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

  • Color

ColorCrossFadeTime

ColorCrossFadeTime, field of type number

  • ColorCrossFadeTime

ColorTransition

ColorTransition, field of type TransitionMode

  • ColorTransition

ContentCount

ContentCount, field of type number

  • ContentCount

ContentHeight

ContentHeight, field of type number

  • ContentHeight

CountChildren

CountChildren, field of type number

  • CountChildren

DefaultColor

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

  • DefaultColor

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

Fields

Fields, field of type table

  • Fields

FlashTimer

FlashTimer, field of type number

  • FlashTimer

Font

Font, field of type GUIFont

  • Font

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

MouseRect

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

  • MouseRect

OnAddedToGUIUpdateList

OnAddedToGUIUpdateList, field of type Action

  • OnAddedToGUIUpdateList

OnSecondaryClicked

OnSecondaryClicked, field of type SecondaryButtonDownHandler

  • OnSecondaryClicked

OutlineColor

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

  • OutlineColor

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

SerializableEntityEditor.CommandBuffer

SerializableEntityEditor.CommandBuffer, field of type Tuple

SerializableEntityEditor.LockEditing

SerializableEntityEditor.LockEditing, field of type bool

SerializableEntityEditor.MissingLocalizations

SerializableEntityEditor.MissingLocalizations, field of type table

SerializableEntityEditor.NextCommandPush

SerializableEntityEditor.NextCommandPush, field of type DateTime

SerializableEntityEditor.PropertyChangesActive

SerializableEntityEditor.PropertyChangesActive, field of type bool

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

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

sprites

sprites, field of type table

  • sprites