Barotrauma Client Doc
Classes | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Static Protected Attributes | List of all members
Barotrauma.Steam.WorkshopMenu Class Referenceabstract
Inheritance diagram for Barotrauma.Steam.WorkshopMenu:
Barotrauma.Steam.ImmutableWorkshopMenu Barotrauma.Steam.MutableWorkshopMenu Barotrauma.Steam.MutableWorkshopMenu Barotrauma.Steam.MutableWorkshopMenu Barotrauma.Steam.MutableWorkshopMenu Barotrauma.Steam.MutableWorkshopMenu

Classes

struct  ActionCarrier
 
struct  BBWord
 

Public Member Functions

 WorkshopMenu (GUIFrame parent)
 

Protected Member Functions

GUIComponent CreateActionCarrier (GUIComponent parent, Identifier id, Action action)
 
GUITextBox CreateSearchBox (RectTransform searchRectT)
 
abstract void UpdateModListItemVisibility ()
 
bool ModNameMatches (ContentPackage p, string query)
 

Static Protected Member Functions

static void CreateBBCodeElement (Steamworks.Ugc.Item workshopItem, GUIListBox container)
 
static RectTransform NewItemRectT (GUILayoutGroup parent, float heightScale=1.0f)
 
static void Spacer (GUILayoutGroup parent, float height=0.03f)
 
static GUITextBlock Label (GUILayoutGroup parent, LocalizedString str, GUIFont font, float heightScale=1.0f)
 
static GUITextBox ScrollableTextBox (GUILayoutGroup parent, float heightScale, string text)
 
static GUIDropDown DropdownEnum< T > (GUILayoutGroup parent, Func< T, LocalizedString > textFunc, T currentValue, Action< T > setter)
 
static GUIDropDown Dropdown< T > (GUILayoutGroup parent, Func< T, LocalizedString > textFunc, IReadOnlyList< T > values, T currentValue, Action< T > setter, float heightScale=1.0f)
 
static void SwapDropdownValues< T > (GUIDropDown dropdown, Func< T, LocalizedString > textFunc, IReadOnlyList< T > values, T currentValue, Action< T > setter)
 
static int Round (float v)
 
static string Percentage (float v)
 
static void CreateModErrorInfo (ContentPackage mod, GUIComponent uiElement, GUITextBlock nameText)
 

Static Protected Attributes

static readonly Regex bbTagRegex
 

Detailed Description

Definition at line 11 of file BBCode.cs.

Constructor & Destructor Documentation

◆ WorkshopMenu()

Barotrauma.Steam.WorkshopMenu.WorkshopMenu ( GUIFrame  parent)

Definition at line 9 of file WorkshopMenu.cs.

Member Function Documentation

◆ CreateActionCarrier()

GUIComponent Barotrauma.Steam.WorkshopMenu.CreateActionCarrier ( GUIComponent  parent,
Identifier  id,
Action  action 
)
protected

◆ CreateBBCodeElement()

static void Barotrauma.Steam.WorkshopMenu.CreateBBCodeElement ( Steamworks.Ugc.Item  workshopItem,
GUIListBox  container 
)
staticprotected

Definition at line 48 of file BBCode.cs.

◆ CreateModErrorInfo()

static void Barotrauma.Steam.WorkshopMenu.CreateModErrorInfo ( ContentPackage  mod,
GUIComponent  uiElement,
GUITextBlock  nameText 
)
staticprotected

Definition at line 139 of file UiUtil.cs.

◆ CreateSearchBox()

GUITextBox Barotrauma.Steam.WorkshopMenu.CreateSearchBox ( RectTransform  searchRectT)
protected

Definition at line 112 of file UiUtil.cs.

◆ Dropdown< T >()

static GUIDropDown Barotrauma.Steam.WorkshopMenu.Dropdown< T > ( GUILayoutGroup  parent,
Func< T, LocalizedString >  textFunc,
IReadOnlyList< T >  values,
T  currentValue,
Action< T >  setter,
float  heightScale = 1.0f 
)
staticprotected

Definition at line 61 of file UiUtil.cs.

◆ DropdownEnum< T >()

static GUIDropDown Barotrauma.Steam.WorkshopMenu.DropdownEnum< T > ( GUILayoutGroup  parent,
Func< T, LocalizedString >  textFunc,
T  currentValue,
Action< T >  setter 
)
staticprotected
Type Constraints
T :Enum 
T :Dropdown 
T :parent 
T :textFunc 
T :T 
T :Enum.GetValues 
T :typeof 
T :T 
T :currentValue 
T :setter 

◆ Label()

static GUITextBlock Barotrauma.Steam.WorkshopMenu.Label ( GUILayoutGroup  parent,
LocalizedString  str,
GUIFont  font,
float  heightScale = 1.0f 
)
staticprotected

Definition at line 20 of file UiUtil.cs.

◆ ModNameMatches()

bool Barotrauma.Steam.WorkshopMenu.ModNameMatches ( ContentPackage  p,
string  query 
)
protected

◆ NewItemRectT()

static RectTransform Barotrauma.Steam.WorkshopMenu.NewItemRectT ( GUILayoutGroup  parent,
float  heightScale = 1.0f 
)
staticprotected

◆ Percentage()

static string Barotrauma.Steam.WorkshopMenu.Percentage ( float  v)
staticprotected

◆ Round()

static int Barotrauma.Steam.WorkshopMenu.Round ( float  v)
staticprotected

◆ ScrollableTextBox()

static GUITextBox Barotrauma.Steam.WorkshopMenu.ScrollableTextBox ( GUILayoutGroup  parent,
float  heightScale,
string  text 
)
staticprotected

Definition at line 25 of file UiUtil.cs.

◆ Spacer()

static void Barotrauma.Steam.WorkshopMenu.Spacer ( GUILayoutGroup  parent,
float  height = 0.03f 
)
staticprotected

Definition at line 15 of file UiUtil.cs.

◆ SwapDropdownValues< T >()

static void Barotrauma.Steam.WorkshopMenu.SwapDropdownValues< T > ( GUIDropDown  dropdown,
Func< T, LocalizedString >  textFunc,
IReadOnlyList< T >  values,
T  currentValue,
Action< T >  setter 
)
staticprotected

Definition at line 70 of file UiUtil.cs.

◆ UpdateModListItemVisibility()

abstract void Barotrauma.Steam.WorkshopMenu.UpdateModListItemVisibility ( )
protectedpure virtual

Implemented in Barotrauma.Steam.MutableWorkshopMenu, and Barotrauma.Steam.ImmutableWorkshopMenu.

Member Data Documentation

◆ bbTagRegex

readonly Regex Barotrauma.Steam.WorkshopMenu.bbTagRegex
staticprotected
Initial value:
= new Regex(@"\[(.+?)\]",
RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant)

Definition at line 45 of file BBCode.cs.