Barotrauma.LocalizedString Class Reference

Inheritance diagram for Barotrauma.LocalizedString:

Public Member Functions
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, bool useDefaultLanguageIfFound=true)
	Use this text instead if the original text cannot be found.
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)

Static Public Attributes
static readonly RawLString	EmptyString = new RawLString("")

Protected Types
enum	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]
bool	Loaded [get]

Member Enumeration Documentation

LoadedSuccessfully

enum Barotrauma.LocalizedString.LoadedSuccessfully

protected

Enumerator
Unknown
No
Yes

Member Function Documentation

CompareTo()

int Barotrauma.LocalizedString.CompareTo

(

object?

obj

)

Contains() [1/2]

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

Contains() [2/2]

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

Equals() [1/3]

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

Equals() [2/3]

override bool Barotrauma.LocalizedString.Equals

(

object?

obj

)

Equals() [3/3]

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

Fallback()

LocalizedString Barotrauma.LocalizedString.Fallback	(	LocalizedString	fallback,
		bool	useDefaultLanguageIfFound = true )

Use this text instead if the original text cannot be found.

Parameters

fallback	The text to use as a fallback
useDefaultLanguageIfFound	Should the default language (English) text be used instead of this fallback if there is a text available in the default language?

GetHashCode()

override int Barotrauma.LocalizedString.GetHashCode

(

)

Join() [1/2]

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

static

Join() [2/2]

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

static

MustRetrieveValue() [1/2]

virtual bool Barotrauma.LocalizedString.MustRetrieveValue ( )

protectedvirtual

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

MustRetrieveValue() [2/2]

static bool Barotrauma.LocalizedString.MustRetrieveValue ( LocalizedString str )

staticprotected

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

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

Replace() [1/3]

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

Replace() [2/3]

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

Replace() [3/3]

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

RetrieveValue()

void Barotrauma.LocalizedString.RetrieveValue ( )

abstract

Split()

IReadOnlyList< LocalizedString > Barotrauma.LocalizedString.Split

(

params char[]

separators

)

StartsWith() [1/2]

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

StartsWith() [2/2]

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

ToLower()

LocalizedString Barotrauma.LocalizedString.ToLower

(

)

ToString()

override string Barotrauma.LocalizedString.ToString

(

)

ToUpper()

virtual LocalizedString Barotrauma.LocalizedString.ToUpper ( )

virtual

Reimplemented in Barotrauma.UpperLString.

TrimEnd()

LocalizedString Barotrauma.LocalizedString.TrimEnd

(

)

TrimStart()

LocalizedString Barotrauma.LocalizedString.TrimStart

(

)

UpdateLanguage()

void Barotrauma.LocalizedString.UpdateLanguage ( )

protected

Member Data Documentation

cachedValue

string Barotrauma.LocalizedString.cachedValue = ""

protected

EmptyString

readonly RawLString Barotrauma.LocalizedString.EmptyString = new RawLString("")

static

Property Documentation

Language

LanguageIdentifier Barotrauma.LocalizedString.Language = LanguageIdentifier.None

get

Length

int Barotrauma.LocalizedString.Length

get

Loaded

bool Barotrauma.LocalizedString.Loaded

getabstract

Value

string Barotrauma.LocalizedString.Value

get

---

The documentation for this class was generated from the following file:

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Text/LocalizedString/LocalizedString.cs