Barotrauma Client Doc
Barotrauma.SerializableEntityEditor Class Reference
Inheritance diagram for Barotrauma.SerializableEntityEditor:
Barotrauma.GUIComponent

Public Member Functions

void UpdateValue (SerializableProperty property, object newValue, bool flash=true)
 
 SerializableEntityEditor (RectTransform parent, ISerializableEntity entity, bool inGame, bool showName, string style="", int elementHeight=24, GUIFont titleFont=null)
 
 SerializableEntityEditor (RectTransform parent, ISerializableEntity entity, IEnumerable< SerializableProperty > properties, bool showName, string style="", int elementHeight=24, GUIFont titleFont=null)
 
void AddCustomContent (GUIComponent component, int childIndex)
 
void RefreshValues ()
 
void Recalculate ()
 
GUIComponent CreateNewField (SerializableProperty property, ISerializableEntity entity)
 
GUIComponent CreateBoolField (ISerializableEntity entity, SerializableProperty property, bool value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateIntField (ISerializableEntity entity, SerializableProperty property, int value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateFloatField (ISerializableEntity entity, SerializableProperty property, float value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateEnumField (ISerializableEntity entity, SerializableProperty property, object value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateEnumFlagField (ISerializableEntity entity, SerializableProperty property, object value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateStringField (ISerializableEntity entity, SerializableProperty property, string value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreatePointField (ISerializableEntity entity, SerializableProperty property, Point value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateVector2Field (ISerializableEntity entity, SerializableProperty property, Vector2 value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateVector3Field (ISerializableEntity entity, SerializableProperty property, Vector3 value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateVector4Field (ISerializableEntity entity, SerializableProperty property, Vector4 value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateColorField (ISerializableEntity entity, SerializableProperty property, Color value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateRectangleField (ISerializableEntity entity, SerializableProperty property, Rectangle value, LocalizedString displayName, LocalizedString toolTip)
 
GUIComponent CreateStringArrayField (ISerializableEntity entity, SerializableProperty property, string[] value, LocalizedString displayName, LocalizedString toolTip)
 
void CreateTextPicker (string textTag, ISerializableEntity entity, SerializableProperty property, GUITextBox textBox)
 
- Public Member Functions inherited from Barotrauma.GUIComponent
delegate bool SecondaryButtonDownHandler (GUIComponent component, object userData)
 
GetChild< T > ()
 
GetAnyChild< T > ()
 
IEnumerable< T > GetAllChildren< T > ()
 
IEnumerable< GUIComponentGetAllChildren ()
 Returns all child elements in the hierarchy. More...
 
GUIComponent GetChild (int index)
 
int GetChildIndex (GUIComponent child)
 
GUIComponent GetChildByUserData (object obj)
 
bool IsParentOf (GUIComponent component, bool recursive=true)
 
bool IsChildOf (GUIComponent component, bool recursive=true)
 
virtual void RemoveChild (GUIComponent child)
 
GUIComponent FindChild (Func< GUIComponent, bool > predicate, bool recursive=false)
 
GUIComponent FindChild (object userData, bool recursive=false)
 
IEnumerable< GUIComponentFindChildren (object userData)
 
IEnumerable< GUIComponentFindChildren (Func< GUIComponent, bool > predicate)
 
virtual void ClearChildren ()
 
void SetAsFirstChild ()
 
void SetAsLastChild ()
 
virtual void AddToGUIUpdateList (bool ignoreChildren=false, int order=0)
 
void RemoveFromGUIUpdateList (bool alsoChildren=true)
 
void UpdateAuto (float deltaTime)
 Only GUI should call this method. Auto updating follows the order of GUI update list. This order can be tweaked by changing the UpdateOrder property. More...
 
void UpdateManually (float deltaTime, bool alsoChildren=false, bool recursive=true)
 By default, all the gui elements are updated automatically in the same order they appear on the update list. More...
 
virtual void ForceLayoutRecalculation ()
 
void ForceUpdate ()
 
void UpdateChildren (float deltaTime, bool recursive)
 Updates all the children manually. More...
 
void DrawAuto (SpriteBatch spriteBatch)
 Only GUI should call this method. Auto drawing follows the order of GUI update list. This order can be tweaked by changing the UpdateOrder property. More...
 
virtual void DrawManually (SpriteBatch spriteBatch, bool alsoChildren=false, bool recursive=true)
 By default, all the gui elements are drawn automatically in the same order they appear on the update list. More...
 
virtual void DrawChildren (SpriteBatch spriteBatch, bool recursive)
 Draws all the children manually. More...
 
void DrawToolTip (SpriteBatch spriteBatch)
 Creates and draws a tooltip. More...
 
virtual void Flash (Color? color=null, float flashDuration=1.5f, bool useRectangleFlash=false, bool useCircularFlash=false, Vector2? flashRectInflate=null)
 
void ImmediateFlash (Color? color=null)
 
void FadeOut (float duration, bool removeAfter, float wait=0.0f, Action onRemove=null)
 
void FadeIn (float wait, float duration)
 
void SlideIn (float wait, float duration, int amount, SlideDirection direction)
 
void SlideOut (float duration, int amount, SlideDirection direction)
 
void Pulsate (Vector2 startScale, Vector2 endScale, float duration)
 
virtual void ApplyStyle (GUIComponentStyle style)
 
void ApplySizeRestrictions (GUIComponentStyle style)
 

Static Public Member Functions

static bool IsEntityRemoved (object entity)
 
static void CommitCommandBuffer ()
 
- Static Public Member Functions inherited from Barotrauma.GUIComponent
static void DrawToolTip (SpriteBatch spriteBatch, RichString toolTip, Vector2 pos)
 
static void DrawToolTip (SpriteBatch spriteBatch, RichString toolTip, Rectangle targetElement, Anchor anchor=Anchor.BottomCenter, Pivot pivot=Pivot.TopLeft)
 
static GUIComponent FromXML (ContentXElement element, RectTransform parent)
 

Static Public Attributes

static bool LockEditing
 
static bool PropertyChangesActive
 
static DateTime NextCommandPush
 
static Tuple< SerializableProperty, PropertyCommand > CommandBuffer
 

Properties

int? ContentHeight [get]
 
int ContentCount [get]
 
Dictionary< Identifier, GUIComponent[]> Fields = new Dictionary<Identifier, GUIComponent[]>() [get]
 Holds the references to the input fields. More...
 
- Properties inherited from Barotrauma.GUIComponent
GUIComponent Parent [get]
 
IEnumerable< GUIComponentChildren [get]
 
bool AutoUpdate = true [get, set]
 
bool AutoDraw = true [get, set]
 
int UpdateOrder [get, set]
 
bool Bounce [get, set]
 
bool GlowOnSelect [get, set]
 
Vector2 UVOffset [get, set]
 
virtual float FlashTimer [get]
 
bool IgnoreLayoutGroups [get, set]
 
virtual GUIFont Font [get, set]
 
virtual RichString ToolTip [get, set]
 
GUIComponentStyle Style [get]
 
bool Visible [get, set]
 
virtual bool Enabled [get, set]
 
Vector2 Center [get]
 
virtual Rectangle Rect [get]
 
bool ClampMouseRectToParent = false [get, set]
 
virtual Rectangle? MouseRect [get]
 
virtual Color OutlineColor [get, set]
 
virtual bool Selected [get, set]
 
virtual ComponentState State [get, set]
 
int CountChildren [get]
 
Color DefaultColor [get, set]
 Currently only used for the fade effect in GUIListBox, should be set to the same value as Color but only assigned once More...
 
virtual Color Color [get, set]
 
virtual Color HoverColor [get, set]
 
virtual Color SelectedColor [get, set]
 
virtual Color DisabledColor [get, set]
 
virtual Color PressedColor [get, set]
 
TransitionMode ColorTransition [get]
 
SpriteFallBackState FallBackState [get]
 
float SpriteCrossFadeTime [get]
 
float ColorCrossFadeTime [get]
 
virtual bool PlaySoundOnSelect = false [get, set]
 
RectTransform RectTransform [get]
 

Additional Inherited Members

- Public Types inherited from Barotrauma.GUIComponent
enum class  ComponentState {
  None , Hover , Pressed , Selected ,
  HoverSelected
}
 
- Public Attributes inherited from Barotrauma.GUIComponent
CursorState HoverCursor = CursorState.Default
 
bool AlwaysOverrideCursor = false
 
SecondaryButtonDownHandler OnSecondaryClicked
 
Action< GUIComponentOnAddedToGUIUpdateList
 
bool CanBeFocused
 
Dictionary< ComponentState, List< UISprite > > sprites
 
SpriteEffects SpriteEffects
 
object UserData
 
bool ExternalHighlight = false
 
- Protected Member Functions inherited from Barotrauma.GUIComponent
Rectangle ClampRect (Rectangle r)
 
 GUIComponent (string style, RectTransform rectT)
 This is the new constructor. More...
 
 GUIComponent (string style)
 
virtual void Update (float deltaTime)
 
virtual Color GetColor (ComponentState state)
 
Color GetBlendedColor (Color targetColor, ref Color blendedColor)
 
virtual void Draw (SpriteBatch spriteBatch)
 
virtual void SetAlpha (float a)
 
- Protected Attributes inherited from Barotrauma.GUIComponent
Alignment alignment
 
Identifier[] styleHierarchy
 
Color color
 
Color hoverColor
 
Color selectedColor
 
Color disabledColor
 
Color pressedColor
 
Color flashColor
 
float flashDuration = 1.5f
 
float flashTimer
 
bool enabled
 
ComponentState _state
 
ComponentState _previousState
 
bool isSelected
 
Color _currentColor
 

Detailed Description

Definition at line 12 of file SerializableEntityEditor.cs.

Constructor & Destructor Documentation

◆ SerializableEntityEditor() [1/2]

Barotrauma.SerializableEntityEditor.SerializableEntityEditor ( RectTransform  parent,
ISerializableEntity  entity,
bool  inGame,
bool  showName,
string  style = "",
int  elementHeight = 24,
GUIFont  titleFont = null 
)

Definition at line 292 of file SerializableEntityEditor.cs.

◆ SerializableEntityEditor() [2/2]

Barotrauma.SerializableEntityEditor.SerializableEntityEditor ( RectTransform  parent,
ISerializableEntity  entity,
IEnumerable< SerializableProperty properties,
bool  showName,
string  style = "",
int  elementHeight = 24,
GUIFont  titleFont = null 
)

Definition at line 299 of file SerializableEntityEditor.cs.

Member Function Documentation

◆ AddCustomContent()

void Barotrauma.SerializableEntityEditor.AddCustomContent ( GUIComponent  component,
int  childIndex 
)

Definition at line 325 of file SerializableEntityEditor.cs.

◆ CommitCommandBuffer()

static void Barotrauma.SerializableEntityEditor.CommitCommandBuffer ( )
static

Definition at line 1444 of file SerializableEntityEditor.cs.

◆ CreateBoolField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateBoolField ( ISerializableEntity  entity,
SerializableProperty  property,
bool  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 459 of file SerializableEntityEditor.cs.

◆ CreateColorField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateColorField ( ISerializableEntity  entity,
SerializableProperty  property,
Color  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 1089 of file SerializableEntityEditor.cs.

◆ CreateEnumField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateEnumField ( ISerializableEntity  entity,
SerializableProperty  property,
object  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 618 of file SerializableEntityEditor.cs.

◆ CreateEnumFlagField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateEnumFlagField ( ISerializableEntity  entity,
SerializableProperty  property,
object  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 651 of file SerializableEntityEditor.cs.

◆ CreateFloatField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateFloatField ( ISerializableEntity  entity,
SerializableProperty  property,
float  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 553 of file SerializableEntityEditor.cs.

◆ CreateIntField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateIntField ( ISerializableEntity  entity,
SerializableProperty  property,
int  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 508 of file SerializableEntityEditor.cs.

◆ CreateNewField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateNewField ( SerializableProperty  property,
ISerializableEntity  entity 
)

Definition at line 340 of file SerializableEntityEditor.cs.

◆ CreatePointField()

GUIComponent Barotrauma.SerializableEntityEditor.CreatePointField ( ISerializableEntity  entity,
SerializableProperty  property,
Point  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 786 of file SerializableEntityEditor.cs.

◆ CreateRectangleField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateRectangleField ( ISerializableEntity  entity,
SerializableProperty  property,
Rectangle  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 1183 of file SerializableEntityEditor.cs.

◆ CreateStringArrayField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateStringArrayField ( ISerializableEntity  entity,
SerializableProperty  property,
string[]  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 1255 of file SerializableEntityEditor.cs.

◆ CreateStringField()

GUIComponent Barotrauma.SerializableEntityEditor.CreateStringField ( ISerializableEntity  entity,
SerializableProperty  property,
string  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 691 of file SerializableEntityEditor.cs.

◆ CreateTextPicker()

void Barotrauma.SerializableEntityEditor.CreateTextPicker ( string  textTag,
ISerializableEntity  entity,
SerializableProperty  property,
GUITextBox  textBox 
)

Definition at line 1324 of file SerializableEntityEditor.cs.

◆ CreateVector2Field()

GUIComponent Barotrauma.SerializableEntityEditor.CreateVector2Field ( ISerializableEntity  entity,
SerializableProperty  property,
Vector2  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 855 of file SerializableEntityEditor.cs.

◆ CreateVector3Field()

GUIComponent Barotrauma.SerializableEntityEditor.CreateVector3Field ( ISerializableEntity  entity,
SerializableProperty  property,
Vector3  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 932 of file SerializableEntityEditor.cs.

◆ CreateVector4Field()

GUIComponent Barotrauma.SerializableEntityEditor.CreateVector4Field ( ISerializableEntity  entity,
SerializableProperty  property,
Vector4  value,
LocalizedString  displayName,
LocalizedString  toolTip 
)

Definition at line 1008 of file SerializableEntityEditor.cs.

◆ IsEntityRemoved()

static bool Barotrauma.SerializableEntityEditor.IsEntityRemoved ( object  entity)
static

◆ Recalculate()

void Barotrauma.SerializableEntityEditor.Recalculate ( )

◆ RefreshValues()

void Barotrauma.SerializableEntityEditor.RefreshValues ( )

Definition at line 333 of file SerializableEntityEditor.cs.

◆ UpdateValue()

void Barotrauma.SerializableEntityEditor.UpdateValue ( SerializableProperty  property,
object  newValue,
bool  flash = true 
)

Definition at line 50 of file SerializableEntityEditor.cs.

Member Data Documentation

◆ CommandBuffer

Tuple<SerializableProperty, PropertyCommand> Barotrauma.SerializableEntityEditor.CommandBuffer
static

Definition at line 25 of file SerializableEntityEditor.cs.

◆ LockEditing

bool Barotrauma.SerializableEntityEditor.LockEditing
static

Definition at line 22 of file SerializableEntityEditor.cs.

◆ NextCommandPush

DateTime Barotrauma.SerializableEntityEditor.NextCommandPush
static

Definition at line 24 of file SerializableEntityEditor.cs.

◆ PropertyChangesActive

bool Barotrauma.SerializableEntityEditor.PropertyChangesActive
static

Definition at line 23 of file SerializableEntityEditor.cs.

Property Documentation

◆ ContentCount

int Barotrauma.SerializableEntityEditor.ContentCount
get

Definition at line 40 of file SerializableEntityEditor.cs.

◆ ContentHeight

int? Barotrauma.SerializableEntityEditor.ContentHeight
get

Definition at line 29 of file SerializableEntityEditor.cs.

◆ Fields

Dictionary<Identifier, GUIComponent[]> Barotrauma.SerializableEntityEditor.Fields = new Dictionary<Identifier, GUIComponent[]>()
get

Holds the references to the input fields.

Definition at line 48 of file SerializableEntityEditor.cs.