Barotrauma.GUICustomComponent Class Reference
GUIComponent that can be used to render custom content on the UI More...
Inheritance diagram for Barotrauma.GUICustomComponent:
Public Member Functions | |
| GUICustomComponent (RectTransform rectT, Action< SpriteBatch, GUICustomComponent > onDraw=null, Action< float, GUICustomComponent > onUpdate=null) | |
 Public Member Functions inherited from Barotrauma.GUIComponent | |
| delegate bool | SecondaryButtonDownHandler (GUIComponent component, object userData) |
| T | GetChild< T > () |
| T | GetAnyChild< T > () |
| IEnumerable< T > | GetAllChildren< T > () |
| IEnumerable< GUIComponent > | GetAllChildren () |
| 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< GUIComponent > | FindChildren (object userData) |
| IEnumerable< GUIComponent > | FindChildren (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) |
Public Attributes | |
| Action< SpriteBatch, GUICustomComponent > | OnDraw |
| Action< float, GUICustomComponent > | OnUpdate |
| bool | HideElementsOutsideFrame |
| Public Attributes inherited from Barotrauma.GUIComponent | |
| CursorState | HoverCursor = CursorState.Default |
| bool | AlwaysOverrideCursor = false |
| SecondaryButtonDownHandler | OnSecondaryClicked |
| Action< GUIComponent > | OnAddedToGUIUpdateList |
| bool | CanBeFocused |
| Dictionary< ComponentState, List< UISprite > > | sprites |
| SpriteEffects | SpriteEffects |
| object | UserData |
| bool | ExternalHighlight = false |
Protected Member Functions | |
| override void | Draw (SpriteBatch spriteBatch) |
| override void | Update (float deltaTime) |
| 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 Color | GetColor (ComponentState state) |
| Color | GetBlendedColor (Color targetColor, ref Color blendedColor) |
| virtual void | SetAlpha (float a) |
Additional Inherited Members | |
| Public Types inherited from Barotrauma.GUIComponent | |
| enum class | ComponentState { None , Hover , Pressed , Selected , HoverSelected } |
| 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) |
| 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 |
| Properties inherited from Barotrauma.GUIComponent | |
| GUIComponent | Parent [get] |
| IEnumerable< GUIComponent > | Children [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] |
Detailed Description
GUIComponent that can be used to render custom content on the UI
Definition at line 10 of file GUICustomComponent.cs.
Constructor & Destructor Documentation
◆ GUICustomComponent()
| Barotrauma.GUICustomComponent.GUICustomComponent | ( | RectTransform | rectT, |
| Action< SpriteBatch, GUICustomComponent > | onDraw = null, |
||
| Action< float, GUICustomComponent > | onUpdate = null |
||
| ) |
Definition at line 17 of file GUICustomComponent.cs.
Member Function Documentation
◆ Draw()
|
protectedvirtual |
Reimplemented from Barotrauma.GUIComponent.
Definition at line 23 of file GUICustomComponent.cs.
◆ Update()
|
protectedvirtual |
Reimplemented from Barotrauma.GUIComponent.
Definition at line 45 of file GUICustomComponent.cs.
Member Data Documentation
◆ HideElementsOutsideFrame
| bool Barotrauma.GUICustomComponent.HideElementsOutsideFrame |
Definition at line 15 of file GUICustomComponent.cs.
◆ OnDraw
| Action<SpriteBatch, GUICustomComponent> Barotrauma.GUICustomComponent.OnDraw |
Definition at line 12 of file GUICustomComponent.cs.
◆ OnUpdate
| Action<float, GUICustomComponent> Barotrauma.GUICustomComponent.OnUpdate |
Definition at line 13 of file GUICustomComponent.cs.
