Barotrauma Client Doc
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Properties | List of all members
Barotrauma.LocalizedString Class Referenceabstract
Inheritance diagram for Barotrauma.LocalizedString:
Barotrauma.AddedPunctuationLString Barotrauma.CapitalizeLString Barotrauma.ConcatLString Barotrauma.FallbackLString Barotrauma.FormattedLString Barotrauma.InputTypeLString Barotrauma.JoinLString Barotrauma.LimitLString Barotrauma.LowerLString Barotrauma.RawLString Barotrauma.ReplaceLString Barotrauma.ServerMsgLString Barotrauma.SplitLString Barotrauma.StripRichTagsLString Barotrauma.TagLString Barotrauma.TrimLString Barotrauma.UpperLString Barotrauma.WrappedLString

Public Member Functions

abstract void RetrieveValue ()
 
override string ToString ()
 
bool Contains (string subStr, StringComparison comparison=StringComparison.Ordinal)
 
bool Contains (char chr, StringComparison comparison=StringComparison.Ordinal)
 
virtual LocalizedString ToUpper ()
 
LocalizedString Fallback (LocalizedString fallback)
 
IReadOnlyList< LocalizedString > Split (params char[] separators)
 
LocalizedString Replace (Identifier find, LocalizedString replace, StringComparison stringComparison=StringComparison.Ordinal)
 
LocalizedString Replace (string find, LocalizedString replace, StringComparison stringComparison=StringComparison.Ordinal)
 
LocalizedString Replace (LocalizedString find, LocalizedString replace, StringComparison stringComparison=StringComparison.Ordinal)
 
LocalizedString TrimStart ()
 
LocalizedString TrimEnd ()
 
LocalizedString ToLower ()
 
override bool Equals (object? obj)
 
bool Equals (LocalizedString other, StringComparison comparison=StringComparison.Ordinal)
 
bool Equals (string other, StringComparison comparison=StringComparison.Ordinal)
 
bool StartsWith (LocalizedString other, StringComparison comparison=StringComparison.Ordinal)
 
bool StartsWith (string other, StringComparison comparison=StringComparison.Ordinal)
 
override int GetHashCode ()
 
int CompareTo (object? obj)
 

Static Public Member Functions

static implicit operator LocalizedString (string value)
 
static implicit operator LocalizedString (char value)
 
static LocalizedString operator+ (LocalizedString left, LocalizedString right)
 
static LocalizedString operator+ (LocalizedString left, object right)
 
static LocalizedString operator+ (object left, LocalizedString right)
 
static bool operator== (LocalizedString? left, LocalizedString? right)
 
static bool operator!= (LocalizedString? left, LocalizedString? right)
 
static LocalizedString Join (string separator, params LocalizedString[] subStrs)
 
static LocalizedString Join (string separator, IEnumerable< LocalizedString > subStrs)
 

Protected Types

enum class  LoadedSuccessfully { Unknown , No , Yes }
 

Protected Member Functions

void UpdateLanguage ()
 
virtual bool MustRetrieveValue ()
 

Static Protected Member Functions

static bool MustRetrieveValue (LocalizedString str)
 

Protected Attributes

string cachedValue = ""
 

Properties

LanguageIdentifier Language = LanguageIdentifier.None [get]
 
string Value [get]
 
int Length [get]
 
abstract bool Loaded [get]
 

Detailed Description

Definition at line 7 of file LocalizedString.cs.

Member Enumeration Documentation

◆ LoadedSuccessfully

enum Barotrauma.LocalizedString.LoadedSuccessfully
strongprotected
Enumerator
Unknown 
No 
Yes 

Definition at line 9 of file LocalizedString.cs.

Member Function Documentation

◆ CompareTo()

int Barotrauma.LocalizedString.CompareTo ( object?  obj)

Definition at line 172 of file LocalizedString.cs.

◆ Contains() [1/2]

bool Barotrauma.LocalizedString.Contains ( char  chr,
StringComparison  comparison = StringComparison.Ordinal 
)

Definition at line 78 of file LocalizedString.cs.

◆ Contains() [2/2]

bool Barotrauma.LocalizedString.Contains ( string  subStr,
StringComparison  comparison = StringComparison.Ordinal 
)

Definition at line 73 of file LocalizedString.cs.

◆ Equals() [1/3]

bool Barotrauma.LocalizedString.Equals ( LocalizedString  other,
StringComparison  comparison = StringComparison.Ordinal 
)

Definition at line 147 of file LocalizedString.cs.

◆ Equals() [2/3]

override bool Barotrauma.LocalizedString.Equals ( object?  obj)

Definition at line 140 of file LocalizedString.cs.

◆ Equals() [3/3]

bool Barotrauma.LocalizedString.Equals ( string  other,
StringComparison  comparison = StringComparison.Ordinal 
)

Definition at line 152 of file LocalizedString.cs.

◆ Fallback()

LocalizedString Barotrauma.LocalizedString.Fallback ( LocalizedString  fallback)

Definition at line 98 of file LocalizedString.cs.

◆ GetHashCode()

override int Barotrauma.LocalizedString.GetHashCode ( )

Definition at line 167 of file LocalizedString.cs.

◆ Join() [1/2]

static LocalizedString Barotrauma.LocalizedString.Join ( string  separator,
IEnumerable< LocalizedString >  subStrs 
)
static

Definition at line 93 of file LocalizedString.cs.

◆ Join() [2/2]

static LocalizedString Barotrauma.LocalizedString.Join ( string  separator,
params LocalizedString[]  subStrs 
)
static

Definition at line 88 of file LocalizedString.cs.

◆ MustRetrieveValue() [1/2]

virtual bool Barotrauma.LocalizedString.MustRetrieveValue ( )
protectedvirtual

Reimplemented in Barotrauma.RawLString, Barotrauma.InputTypeLString, Barotrauma.FallbackLString, and Barotrauma.LimitLString.

Definition at line 39 of file LocalizedString.cs.

◆ MustRetrieveValue() [2/2]

static bool Barotrauma.LocalizedString.MustRetrieveValue ( LocalizedString  str)
staticprotected

Definition at line 44 of file LocalizedString.cs.

◆ operator LocalizedString() [1/2]

static implicit Barotrauma.LocalizedString.operator LocalizedString ( char  value)
static

◆ operator LocalizedString() [2/2]

static implicit Barotrauma.LocalizedString.operator LocalizedString ( string  value)
static

◆ operator!=()

static bool Barotrauma.LocalizedString.operator!= ( LocalizedString?  left,
LocalizedString?  right 
)
static

Definition at line 63 of file LocalizedString.cs.

◆ operator+() [1/3]

static LocalizedString Barotrauma.LocalizedString.operator+ ( LocalizedString  left,
LocalizedString  right 
)
static

◆ operator+() [2/3]

static LocalizedString Barotrauma.LocalizedString.operator+ ( LocalizedString  left,
object  right 
)
static

◆ operator+() [3/3]

static LocalizedString Barotrauma.LocalizedString.operator+ ( object  left,
LocalizedString  right 
)
static

◆ operator==()

static bool Barotrauma.LocalizedString.operator== ( LocalizedString?  left,
LocalizedString?  right 
)
static

Definition at line 58 of file LocalizedString.cs.

◆ Replace() [1/3]

LocalizedString Barotrauma.LocalizedString.Replace ( Identifier  find,
LocalizedString  replace,
StringComparison  stringComparison = StringComparison.Ordinal 
)

Definition at line 109 of file LocalizedString.cs.

◆ Replace() [2/3]

LocalizedString Barotrauma.LocalizedString.Replace ( LocalizedString  find,
LocalizedString  replace,
StringComparison  stringComparison = StringComparison.Ordinal 
)

Definition at line 119 of file LocalizedString.cs.

◆ Replace() [3/3]

LocalizedString Barotrauma.LocalizedString.Replace ( string  find,
LocalizedString  replace,
StringComparison  stringComparison = StringComparison.Ordinal 
)

Definition at line 114 of file LocalizedString.cs.

◆ RetrieveValue()

abstract void Barotrauma.LocalizedString.RetrieveValue ( )
pure virtual

Implemented in Barotrauma.StripRichTagsLString, Barotrauma.UpperLString, Barotrauma.TrimLString, Barotrauma.TagLString, Barotrauma.SplitLString, Barotrauma.ServerMsgLString, Barotrauma.ReplaceLString, Barotrauma.RawLString, Barotrauma.LowerLString, Barotrauma.JoinLString, Barotrauma.InputTypeLString, Barotrauma.FormattedLString, Barotrauma.FallbackLString, Barotrauma.ConcatLString, Barotrauma.CapitalizeLString, Barotrauma.AddedPunctuationLString, Barotrauma.WrappedLString, and Barotrauma.LimitLString.

◆ Split()

IReadOnlyList<LocalizedString> Barotrauma.LocalizedString.Split ( params char[]  separators)

Definition at line 103 of file LocalizedString.cs.

◆ StartsWith() [1/2]

bool Barotrauma.LocalizedString.StartsWith ( LocalizedString  other,
StringComparison  comparison = StringComparison.Ordinal 
)

Definition at line 157 of file LocalizedString.cs.

◆ StartsWith() [2/2]

bool Barotrauma.LocalizedString.StartsWith ( string  other,
StringComparison  comparison = StringComparison.Ordinal 
)

Definition at line 162 of file LocalizedString.cs.

◆ ToLower()

LocalizedString Barotrauma.LocalizedString.ToLower ( )

Definition at line 135 of file LocalizedString.cs.

◆ ToString()

override string Barotrauma.LocalizedString.ToString ( )

Definition at line 68 of file LocalizedString.cs.

◆ ToUpper()

virtual LocalizedString Barotrauma.LocalizedString.ToUpper ( )
virtual

Reimplemented in Barotrauma.UpperLString.

Definition at line 83 of file LocalizedString.cs.

◆ TrimEnd()

LocalizedString Barotrauma.LocalizedString.TrimEnd ( )

Definition at line 130 of file LocalizedString.cs.

◆ TrimStart()

LocalizedString Barotrauma.LocalizedString.TrimStart ( )

Definition at line 125 of file LocalizedString.cs.

◆ UpdateLanguage()

void Barotrauma.LocalizedString.UpdateLanguage ( )
protected

Definition at line 33 of file LocalizedString.cs.

Member Data Documentation

◆ cachedValue

string Barotrauma.LocalizedString.cachedValue = ""
protected

Definition at line 19 of file LocalizedString.cs.

Property Documentation

◆ Language

LanguageIdentifier Barotrauma.LocalizedString.Language = LanguageIdentifier.None
get

Definition at line 16 of file LocalizedString.cs.

◆ Length

int Barotrauma.LocalizedString.Length
get

Definition at line 29 of file LocalizedString.cs.

◆ Loaded

abstract bool Barotrauma.LocalizedString.Loaded
get

Definition at line 31 of file LocalizedString.cs.

◆ Value

string Barotrauma.LocalizedString.Value
get

Definition at line 20 of file LocalizedString.cs.