Inheritance diagram for Barotrauma.GUITickBox:

Public Member Functions
delegate bool	OnSelectedHandler (GUITickBox obj)

	GUITickBox (RectTransform rectT, LocalizedString label, GUIFont font=null, string style="")

void	SetRadioButtonGroup (GUIRadioButtonGroup rbg)

void	ResizeBox ()

void	SetSelected (bool selected, bool callOnSelected=true)

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
OnSelectedHandler	OnSelected

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	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	Draw (SpriteBatch spriteBatch)

virtual void	SetAlpha (float a)

Properties
override bool	Selected `[get, set]`

override ComponentState	State `[get, set]`

override bool	Enabled `[get, set]`

Color	TextColor `[get, set]`

override GUIFont	Font `[get, set]`

GUIFrame	Box `[get]`

GUITextBlock	TextBlock `[get]`

override RichString	ToolTip `[get, set]`

LocalizedString	Text `[get, set]`

float	ContentWidth `[get]`

GUISoundType	SoundType = GUISoundType.TickBox `[set]`

override bool	PlaySoundOnSelect = true `[get, set]`

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]`

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

Detailed Description

Definition at line 6 of file GUITickBox.cs.

Constructor & Destructor Documentation

◆ GUITickBox()

Barotrauma.GUITickBox.GUITickBox	(	RectTransform	rectT,
		LocalizedString	label,
		GUIFont	font = `null`,
		string	style = `""`
	)

Definition at line 120 of file GUITickBox.cs.

Member Function Documentation

◆ OnSelectedHandler()

delegate bool Barotrauma.GUITickBox.OnSelectedHandler ( GUITickBox obj )

◆ ResizeBox()

void Barotrauma.GUITickBox.ResizeBox ( )

Definition at line 164 of file GUITickBox.cs.

◆ SetRadioButtonGroup()

void Barotrauma.GUITickBox.SetRadioButtonGroup ( GUIRadioButtonGroup rbg )

Definition at line 159 of file GUITickBox.cs.

◆ SetSelected()

void Barotrauma.GUITickBox.SetSelected	(	bool	selected,
		bool	callOnSelected = `true`
	)

Definition at line 174 of file GUITickBox.cs.

◆ Update()

override void Barotrauma.GUITickBox.Update ( float deltaTime )

protectedvirtual

Reimplemented from Barotrauma.GUIComponent.

Definition at line 195 of file GUITickBox.cs.

Member Data Documentation

◆ OnSelected

OnSelectedHandler Barotrauma.GUITickBox.OnSelected

Definition at line 13 of file GUITickBox.cs.

Property Documentation

◆ Box

GUIFrame Barotrauma.GUITickBox.Box

get

Definition at line 87 of file GUITickBox.cs.

◆ ContentWidth

float Barotrauma.GUITickBox.ContentWidth

get

Definition at line 114 of file GUITickBox.cs.

◆ Enabled

override bool Barotrauma.GUITickBox.Enabled

getset

Definition at line 39 of file GUITickBox.cs.

◆ Font

override GUIFont Barotrauma.GUITickBox.Font

getset

Definition at line 73 of file GUITickBox.cs.

◆ PlaySoundOnSelect

override bool Barotrauma.GUITickBox.PlaySoundOnSelect = true

getset

Definition at line 118 of file GUITickBox.cs.

◆ Selected

override bool Barotrauma.GUITickBox.Selected

getset

Definition at line 17 of file GUITickBox.cs.

◆ SoundType

GUISoundType Barotrauma.GUITickBox.SoundType = GUISoundType.TickBox

set

Definition at line 116 of file GUITickBox.cs.

◆ State

override ComponentState Barotrauma.GUITickBox.State

getset

Definition at line 26 of file GUITickBox.cs.

◆ Text

LocalizedString Barotrauma.GUITickBox.Text

getset

Definition at line 108 of file GUITickBox.cs.

◆ TextBlock

GUITextBlock Barotrauma.GUITickBox.TextBlock

get

Definition at line 92 of file GUITickBox.cs.

◆ TextColor

Color Barotrauma.GUITickBox.TextColor

getset

Definition at line 53 of file GUITickBox.cs.

◆ ToolTip

override RichString Barotrauma.GUITickBox.ToolTip

getset

Definition at line 97 of file GUITickBox.cs.

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUITickBox()

Member Function Documentation

◆ OnSelectedHandler()

◆ ResizeBox()

◆ SetRadioButtonGroup()

◆ SetSelected()

◆ Update()

Member Data Documentation

◆ OnSelected

Property Documentation

◆ Box

◆ ContentWidth

◆ Enabled

◆ Font

◆ PlaySoundOnSelect

◆ Selected

◆ SoundType

◆ State

◆ Text

◆ TextBlock

◆ TextColor

◆ ToolTip