Classes
class	string

Functions
proto native int	string::ToInt ()
	Converts string to integer.

proto native int	string::HexToInt ()
	Converts string to integer.

proto native float	string::ToFloat ()
	Converts string to float.

proto vector	string::ToVector ()
	Returns a vector from a string.

vector	string::BeautifiedToVector ()
	Convert beautified string into a vector.

proto native int	string::ToAscii ()
	Converts string's first character to ASCII code.

proto native	string::ToType ()
	Returns internal type representation. Can be used in runtime, or cached in variables and used for faster inheritance checking.

static proto string	string::ToString (void var, bool type=false, bool name=false, bool quotes=true)
	Return string representation of variable.

proto string	string::Substring (int start, int len)
	Substring of 'str' from 'start' position 'len' number of characters.

string	string::SubstringInverted (string string_to_split, int position_start, int position_end)
	Inverted SubString. This deletes everything in between position_start and position_end.

proto string	string::SubstringUtf8 (int startChar, int len)
	Substring of 'str' from 'startChar' position 'len' number of characters for UTF8 strings with multibyte chars.

proto int	string::Replace (string sample, string replace)
	Replace all occurrances of 'sample' in 'str' by 'replace'.

proto int	string::ToLower ()
	Changes string to lowercase. Returns length.

proto int	string::ToUpper ()
	Changes string to uppercase. Returns length.

proto native int	string::Length ()
	Returns length of string.

proto native int	string::LengthUtf8 ()
	Returns number of characters in UTF8 string.

proto native int	string::Hash ()
	Returns hash of string.

proto native int	string::IndexOf (string sample)
	Finds 'sample' in 'str'. Returns -1 when not found.

proto native int	string::LastIndexOf (string sample)
	Finds last 'sample' in 'str'. Returns -1 when not found.

proto native int	string::IndexOfFrom (int start, string sample)
	Finds 'sample' in 'str' from 'start' position. Returns -1 when not found.

bool	string::Contains (string sample)
	Returns true if sample is substring of string.

proto string	string::Trim ()
	Returns trimmed string with removed leading and trailing whitespaces.

proto int	string::TrimInPlace ()
	Removes leading and trailing whitespaces in string. Returns length.

proto int	string::ParseStringEx (out string token)
	Parses one token from input string. Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.

proto int	string::ParseString (out string tokens[])
	Parses string into array of tokens returns number of tokens.

void	string::Split (string sample, out array< string > output)
	Splits string into array of strings separated by 'sample'.

static string	string::Join (string separator, notnull TStringArray tokens)

proto string	string::Get (int index)
	Gets n-th character from string.

proto void	string::Set (int index, string input)
	Sets the n-th character in string with the input, replacing previous value.

proto void	string::Insert (int index, string input)
	Inserts a string into the n-th index, increasing the string length by the size of the input.

static proto string	string::Format (string fmt, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL)
	Gets n-th character from string.

Variables
static const string	string::Empty

Detailed Description

Function Documentation

◆ BeautifiedToVector()

vector string::BeautifiedToVector ( )

inlineprivate

Convert beautified string into a vector.

Parameters

vec	`beautified` string

Returns: vector resulting vector

Definition at line 67 of file EnString.c.

  {
    string copy = value;
    copy.Replace("<", "");
    copy.Replace(">", "");
    copy.Replace(",", " ");
    return copy.ToVector();
  }

References string::Replace(), and string::ToVector().

Referenced by ScriptConsoleGeneralTab::OnClick().

◆ Contains()

bool string::Contains ( string sample )

inlineprivate

Returns true if sample is substring of string.

Parameters

sample string Finding string expression

Returns: bool true if sample is substring of string
string str = "Hello World";

Print( str.IndexOfFrom( 3, "Hello" ) );

Print( str.IndexOfFrom( 3, "Mexico" ) );

>> true

>> false

Print
proto void Print(void var)
Prints content of variable to console/log.

Definition at line 286 of file EnString.c.

  {
    return value.IndexOf(sample) != -1;
  }

Referenced by BaseBuildingBase::CheckLevelVerticalDistance(), AttachmentsOutOfReach::CreateAttachmentPosition(), CreateMission(), ItemBase::ToggleAnimation(), and ObjectSpawnerHandler::ValidatePath().

◆ Format()

static proto string string::Format	(	string	fmt,
		void	param1 = NULL,
		void	param2 = NULL,
		void	param3 = NULL,
		void	param4 = NULL,
		void	param5 = NULL,
		void	param6 = NULL,
		void	param7 = NULL,
		void	param8 = NULL,
		void	param9 = NULL )

staticprivate

Gets n-th character from string.

Parameters

index character index

Returns: string character on index-th position in string
int a = 5;

float b = 5.99;

string c = "beta";

string test = string.Format("Ahoj %1 = %3 , %2", a, b, c);

Print(test);

>> 'Ahoj 5 = 'beta' , 5.99'

Referenced by Add(), ItemBase::EEItemAttached(), ItemBase::EEItemDetached(), FullTimeData::FormatedWithZero(), GetAdminLogMessage(), ErrorProperties::GetClientMessage(), GetColorString(), GetComponentNamesFromDamageZone(), GetDamageZoneMap(), TentBase::GetMaterialPath(), ErrorProperties::GetServerMessage(), ErrorHandlerModule::GetSimpleMessage(), array::GetTestEx(), Entity::InitDamageZoneDisplayNameMapping(), LandMineTrap(), ParticleList::RegisterParticle(), TFModule::Result(), and TripwireTrap().

◆ Get()

proto string string::Get ( int index )

private

Gets n-th character from string.

Parameters

index character index

Returns: string character on index-th position in string

Warning: VME When index less than 0 or greater than string length
string str = "Hello World";

Print( str[4] ); // Print( str.Get(4) );

>> 'o'

Referenced by FireworksLauncherClientEvent::FireworksLauncherClientEvent(), ScriptedWidgetEventHandler::Highlight(), and ScriptedWidgetEventHandler::Select().

◆ Hash()

proto native int string::Hash ( )

private

Returns hash of string.

Returns: int - Hash of string
string str = "Hello World";

int hash = str.Hash();

Print(hash);

Referenced by Capture(), DayZPlayer::OnStepEvent(), and ArrowManagerPlayer::Save().

◆ HexToInt()

proto native int string::HexToInt ( )

private

Converts string to integer.

Returns: int - Converted string.
string str = "0xFF";

int i = str.HexToInt();

Print(i);

>> i = 255

◆ IndexOf()

proto native int string::IndexOf ( string sample )

private

Finds 'sample' in 'str'. Returns -1 when not found.

Parameters

sample string Finding string

Returns: int - Returns position where sample starts, or -1 when sample not found
string str = "Hello World";

Print( str.IndexOf( "H" ) );

Print( str.IndexOf( "W" ) );

Print( str.IndexOf( "Q" ) );

>> 0

>> 6

>> -1

Referenced by PluginBase::GetPlayerPrefix().

◆ IndexOfFrom()

proto native int string::IndexOfFrom	(	int	start,
		string	sample )

private

Finds 'sample' in 'str' from 'start' position. Returns -1 when not found.

Parameters

start	`int` Start from position
sample	`string` Finding string expression

Returns: int - Length of string s
string str = "Hello World";

Print( str.IndexOfFrom( 3, "H" ) );

Print( str.IndexOfFrom( 3, "W" ) );

Print( str.IndexOfFrom( 3, "Q" ) );

>> -1

>> 6

>> -1

Referenced by ActionUnmountBarbedWire::ActionCondition(), and CGame::SetMissionPath().

◆ Insert()

proto void string::Insert	(	int	index,
		string	input )

private

Inserts a string into the n-th index, increasing the string length by the size of the input.

Parameters

index	index to insert at
input	string value to insert with

Warning: VME When index less than 0 or greater than string length; VME When string is empty
string str = "Hello World";

str.Insert(6, "Test ");

Print( str );

>> 'Hello Test World'

Referenced by HFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::GetHierarchyPath(), ScriptedWidgetEventHandler::LoadEntries(), and string::Split().

◆ Join()

static string string::Join	(	string	separator,
		notnull TStringArray	tokens )

inlinestaticprivate

Definition at line 424 of file EnString.c.

  {
    string output;
    foreach (int i, string s: tokens)
    {
      if (i != 0)
        output += separator;
      output += s;
    }
    return output;
  }

◆ LastIndexOf()

proto native int string::LastIndexOf ( string sample )

private

Finds last 'sample' in 'str'. Returns -1 when not found.

Parameters

sample string Finding string

Returns: int - Returns position where sample starts, or -1 when sample not found
string str = "Hello World";

Print( str.IndexOf( "l" ) );

>> 9

◆ Length()

proto native int string::Length ( )

private

Returns length of string.

Returns: int - Length of string
string str = "Hello World";

int i = str.Length();

Print(i);

>> i = 11

Referenced by ActionMountBarbedWire::ActionCondition(), ActionUnmountBarbedWire::ActionCondition(), FireworksLauncherClientEvent::FireworksLauncherClientEvent(), ItemBase::GetSlotIndexBySelection(), ActionCarDoors::OnEnd(), DayZPlayer::OnStepEvent(), string::SubstringInverted(), and ToStringLen().

◆ LengthUtf8()

proto native int string::LengthUtf8 ( )

private

Returns number of characters in UTF8 string.

Returns: int - Number of characters in UTF8 string
string str = "こんにちは世界";

int i = str.LengthUtf8();

Print(i);

>> i = 7

◆ ParseString()

proto int string::ParseString ( out string tokens[] )

private

Parses string into array of tokens returns number of tokens.

Parameters

[out] tokens array[] Parsed string in array

Returns: int Number of tokens
string token[2];

string str = "Hello World";

int result = str.ParseString(token);

for (int i = 0; i < 2; i++)

{

Print(token[i]);

}

>> 'Hello'

>> 'World'

◆ ParseStringEx()

proto int string::ParseStringEx ( out string token )

private

Parses one token from input string. Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.

Parameters

[out] token string Founded string token

Returns

int Type of token

Token types:
0 - error, no token
1 - defined token (special characters etc. . / * )
2 - quoted string. Quotes are removed -> TODO
3 - alphabetic string
4 - number
5 - end of line -> TODO

string input = "Hello*World";
string token1;
string token2;
 
int result1 = input.ParseStringEx(token1);
int result2 = input.ParseStringEx(token2);
 
Print( "Token1 = '" + token1 + "' Type = " + result1.ToString() ) );
Print( "Token2 = '" + token2 + "' Type = " + result2.ToString() ) );
 
>> 'Toke1 = 'Hello' Type = 3'
>> 'Toke1 = '*' Type = 1'

◆ Replace()

proto int string::Replace	(	string	sample,
		string	replace )

private

Replace all occurrances of 'sample' in 'str' by 'replace'.

Parameters

sample	string to search in `str`
replace	string which replace `sample` in `str`

Returns: int - number of occurrances of 'sample' in 'str'
string test = "If the length of the C string in source is less than num, only the content up to the terminating null-character is copied.";

Print(test);

int count = test.Replace("the", "*");

Print(count);

Print(test);

>> string test = 'If the length of the C string in source is less than num, only the content up to the terminating null-character is copied.';

>> int count = 4

>> string test = 'If * length of * C string in source is less than num, only * content up to * terminating null-character is copied.'

Referenced by string::BeautifiedToVector(), and ResavePlugin::RunCommandline().

◆ Set()

proto void string::Set	(	int	index,
		string	input )

private

Sets the n-th character in string with the input, replacing previous value.

Parameters

index	index to be replaced
input	single non-terminated character value to replace with

Warning: VME When index less than 0 or greater than string length; (Diag) VME When string is empty or greater than length of 1 (Retail) Calls 'string.Insert' except it replaces only the initial character
string str = "Hello World";

str[4] = "O";

Print( str );

>> 'HellO World'

string str = "Hello World";
str[6] = "Test ";
Print( str );
 
>> 'Hello Test orld'

◆ Split()

void string::Split	(	string	sample,
		out array< string >	output )

inlineprivate

Splits string into array of strings separated by 'sample'.

Parameters

sample string Strings separator

Returns: TStringArray Array with strings
string example = "The quick brown fox jumps over the lazy dog";

TStringArray strs = new TStringArray;

example.Split(" ", strs);

for (int i = 0; i < strs.Count(); i++)

{

Print(strs.Get(i));

}

>> 'The'

>> 'quick'

>> 'brown'

>> 'fox'

>> 'jumps'

>> 'over'

>> 'the'

>> 'lazy'

>> 'dog'

array< string >

TStringArray
array< string > TStringArray
Definition EnScript.c:666

Definition at line 396 of file EnString.c.

  {
    int txt_len = 0;
    int sep_pos = -1;
    int nxt_sep_pos = 0;
    string text = "";
 
    bool line_end = false;
    while (line_end == false)
    {
      sep_pos = sep_pos + txt_len + 1;
      nxt_sep_pos = value.IndexOfFrom(sep_pos, sample);
      if (nxt_sep_pos == -1)
      {
        nxt_sep_pos = value.Length();
        line_end = true;
      }
 
      txt_len = nxt_sep_pos - sep_pos;
      if (txt_len > 0)
      {
        text = value.Substring(sep_pos, txt_len);
        output.Insert(text);
      }
    }
  }

References string::Insert(), and string::Substring().

Referenced by ScriptConsoleConfigTab::OnClick(), and ParseData().

◆ Substring()

proto string string::Substring	(	int	start,
		int	len )

private

Substring of 'str' from 'start' position 'len' number of characters.

Parameters

start	Position in `str`
len	Count of characters

Returns: string - Substring of str
string str = "Hello World";

string strSub = str.Substring(2, 5);

Print(strSub);

>> strSub = llo W

Referenced by ActionUnmountBarbedWire::ActionCondition(), PluginBase::GetPlayerPrefix(), CGame::SetMissionPath(), string::Split(), and string::SubstringInverted().

◆ SubstringInverted()

string string::SubstringInverted	(	string	string_to_split,
		int	position_start,
		int	position_end )

inlineprivate

Inverted SubString. This deletes everything in between position_start and position_end.

Definition at line 116 of file EnString.c.

  {
    string first_half = string_to_split.Substring(0, position_start);
    string second_half = string_to_split.Substring(position_end, string_to_split.Length() - position_end);
    string result = first_half + second_half;
    return result;
  }

References string::Length(), and string::Substring().

◆ SubstringUtf8()

proto string string::SubstringUtf8	(	int	startChar,
		int	len )

private

Substring of 'str' from 'startChar' position 'len' number of characters for UTF8 strings with multibyte chars.

Parameters

startChar	Position in `str`.
len	Count of characters

Returns: string - Substring of str with startChar character and len characters
string str = "こんにちは世界";

string strSub = str.SubstringUtf8(2, 4);

Print(strSub);

>> strSub = にちは世

◆ ToAscii()

proto native int string::ToAscii ( )

private

Converts string's first character to ASCII code.

Parameters

str	String for convert to ASCII code

Returns: ascii code int.
int ascii = "M".ToAscii();

Print(ascii);

>> ascii = 77

◆ ToFloat()

proto native float string::ToFloat ( )

private

Converts string to float.

Returns: float - Converted string in float.
string str = "56.6";

float f = str.ToFloat();

Print(f);

>> f = 56.6

◆ ToInt()

proto native int string::ToInt ( )

private

Converts string to integer.

Returns: int - Converted string.
string str = "56";

int i = str.ToInt();

Print(i);

>> i = 56

◆ ToLower()

proto int string::ToLower ( )

private

Changes string to lowercase. Returns length.

Returns: int - Length of changed string
string str = "Hello World";

int i = str.ToLower();

Print(str);

Print(i);

>> str = hello world

>> i = 11

Referenced by AttachmentsOutOfReach::CreateAttachmentPosition().

◆ ToString()

static proto string string::ToString	(	void	var,
		bool	type = false,
		bool	name = false,
		bool	quotes = true )

staticprivate

Return string representation of variable.

Referenced by PrintElements(), and ToStringLen().

◆ ToType()

proto native string::ToType ( )

private

Returns internal type representation. Can be used in runtime, or cached in variables and used for faster inheritance checking.

Returns: typename Type of class
???

Referenced by CreateParticle(), ImpactMaterials::EvaluateImpactEffect(), PluginBase::GetModuleType(), EffectArea::GetRequesterIndex(), and ImpactMaterials::RegisterSurface().

◆ ToUpper()

proto int string::ToUpper ( )

private

Changes string to uppercase. Returns length.

Returns: int - Length of changed string
string str = "Hello World";

int i = str.ToUpper();

Print(str);

Print(i);

>> str = HELLO WORLD

>> i = 11

WORLD
@ WORLD
4_World
Definition EnProfiler.c:30

◆ ToVector()

proto vector string::ToVector ( )

private

Returns a vector from a string.

Returns: vector Converted s as vector
string str = "1 0 1";

vector v = str.ToVector();

Print(v);

>> v = <1,0,1>

vector
Definition EnConvert.c:106

Referenced by string::BeautifiedToVector().

◆ Trim()

proto string string::Trim ( )

private

Returns trimmed string with removed leading and trailing whitespaces.

Returns: string - Trimmed string
string str = " Hello World "

Print( str );

Print( str.Trim() );

>> ' Hello World '

>> 'Hello World'

◆ TrimInPlace()

proto int string::TrimInPlace ( )

private

Removes leading and trailing whitespaces in string. Returns length.

Returns: int - Count of chars
string str = " Hello World ";

int i = str.TrimInPlace();

Print(str);

Print(i);

>> str = 'Hello World'

>> i = 11

Variable Documentation

◆ Empty

const string string::Empty

staticprivate

Definition at line 7 of file EnString.c.

Referenced by ActionTuneFrequencyOnGround::ActionTuneFrequencyOnGround(), PluginBase::GetFileName(), PluginBase::GetSubFolderName(), PlayerSpawnPresetComplexChildrenType::IsValid(), Debug::LogMessage(), WeaponStateBase::OnEntry(), WeaponStateBase::OnExit(), DebugPrint::TrimStackTrace(), UIScriptedMenu::UpdateDisconnectTexts(), and ReplaceItemWithNewLambdaBase::WantCreateNewEntity().

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ BeautifiedToVector()

◆ Contains()

◆ Format()

◆ Get()

◆ Hash()

◆ HexToInt()

◆ IndexOf()

◆ IndexOfFrom()

◆ Insert()

◆ Join()

◆ LastIndexOf()

◆ Length()

◆ LengthUtf8()

◆ ParseString()

◆ ParseStringEx()

◆ Replace()

◆ Set()

◆ Split()

◆ Substring()

◆ SubstringInverted()

◆ SubstringUtf8()

◆ ToAscii()

◆ ToFloat()

◆ ToInt()

◆ ToLower()

◆ ToString()

◆ ToType()

◆ ToUpper()

◆ ToVector()

◆ Trim()

◆ TrimInPlace()

Variable Documentation

◆ Empty