Palota: 1 revision imported

2023-02-13T07:02:34Z

1 revision imported

← Older revision	Revision as of 07:02, 13 February 2023
(No difference)

Palota: 1 revision imported

2021-07-13T19:06:38Z

1 revision imported

New page

{{process header
| title = String Library
| section =
| previous = [[Omni-bot_Script_Reference | Script Reference]]
| next =
| shortcut =
| notes =
}}
{{TOCright}}
===IsEmpty===
Determines whether a string is empty.

'''Parameters:''' none

'''Returns:''' true or false

'''Example:''' <syntaxhighlight lang="java">
mystring = "";
print(mystring.IsEmpty());</syntaxhighlight>

----

===Length===
Determines the length of a string.

'''Parameters:''' none

'''Returns:''' the string's length

'''Example:''' <syntaxhighlight lang="java">
mystring = "";
print(mystring.Length());</syntaxhighlight>

----

===Left===
Returns the left count charaters of the string.

'''Parameters:''' count

'''Returns:''' the left count charaters of the string

'''Example:''' <syntaxhighlight lang="java">
mystring = "Test me";
print(mystring.Left(4));</syntaxhighlight>

----

===Right===
Returns the right count charaters of the string.

'''Parameters:''' count

'''Returns:''' the right count charaters of the string

'''Example:''' <syntaxhighlight lang="java">
mystring = "Test me";
print(mystring.Right(2));</syntaxhighlight>

----

===RightAt===
Returns the charaters right of and including the given index.

'''Parameters:''' index

'''Returns:''' the charaters right of and including the given index

'''Example:''' <syntaxhighlight lang="java">
print("Test me".RightAt(5));</syntaxhighlight>

----

===Mid===
Mid will return count characters from the start index.

'''Parameters:''' startIndex, count

'''Returns:''' count characters from startIndex

'''Example:''' <syntaxhighlight lang="java">
mystring = "Test me";
print(mystring.Mid(2,2));</syntaxhighlight>

----

===Compare===
Performs a string comparison.

'''Parameters:''' string to compare

'''Returns:''' -1 if the this < compare string, 0 if the strings are equal, 1 otherwise

'''Example:''' <syntaxhighlight lang="java">
mystring = "Test me";
print(mystring.Compare("test Me"));</syntaxhighlight>

----

===CompareNoCase===
Performs a string comparison (case insensitive).

'''Parameters:''' string to compare

'''Returns:''' negative integer if the this < compare string, 0 if the strings are equal, positive integer otherwise

'''Example:''' <syntaxhighlight lang="java">
print("Test me".CompareNoCase("test ME"));</syntaxhighlight>

----

===Upper===
Converts a string to upper case.

'''Parameters:''' none

'''Returns:''' converted string

'''Example:''' <syntaxhighlight lang="java">
print("Test me".Upper());</syntaxhighlight>

----

===Lower===
Converts a string to lower case.

'''Parameters:''' none

'''Returns:''' converted string

'''Example:''' <syntaxhighlight lang="java">
print("Test me".Lower());</syntaxhighlight>

----

===SpanIncluding===
Return this string while characters are within the passed string.

'''Parameters:''' string charset

'''Returns:''' the left part of the string

'''Example:''' <syntaxhighlight lang="java">
print("Test me".SpanIncluding("esTt"));</syntaxhighlight>

----

===SpanExcluding===
Return this string while characters are not within the passed string.

'''Parameters:''' string charset

'''Returns:''' the left part of the string

'''Example:''' <syntaxhighlight lang="java">
print("Test me".SpanExcluding("acfmx"));</syntaxhighlight>

----

===ReplaceCharsInSet===
ReplaceCharsInSet will replace all chars in this that are within the charset with the given int char.

'''Parameters:''' (char to replace with, string of chars to replace)

'''Returns:''' string

'''Example:''' <syntaxhighlight lang="java">
print("Test me".ReplaceCharsInSet('x',"et"));</syntaxhighlight>

----

===Find===
Find will find the first occurrence of the passed string within this string.

'''Parameters:''' string to find

'''Returns:''' index of first occurrence, or -1 if the string was not found

'''Example:''' <syntaxhighlight lang="java">
mystring = "Test me";
print(mystring.Find("Me"));</syntaxhighlight>

----

===ReverseFind===
ReverseFind will find the first occurance of the passed string within this string starting from the right.

'''Parameters:''' string to find

'''Returns:''' index of first occurrence, or -1 if the string was not found

'''Example:''' <syntaxhighlight lang="java">
print("Test me".ReverseFind("me"));</syntaxhighlight>

----

===Reverse===
Reverses the characters of a string.

'''Parameters:''' none

'''Returns:''' inverted string

'''Example:''' <syntaxhighlight lang="java">
mystring = "tset";
print(mystring.Reverse());</syntaxhighlight>

----

===GetAt===
GetAt will return the char at the given index.

'''Parameters:''' index

'''Returns:''' char number

'''Example:''' <syntaxhighlight lang="java">
mystring = "Test";
print(mystring.GetAt(0)); //prints 84, the char # of "T"</syntaxhighlight>

----

===SetAt===
Returns string with modified character at offset, or original string if index out of range.

'''Parameters:''' (index, char)

'''Returns:''' string

'''Example:''' <syntaxhighlight lang="java">
print("Test me".SetAt(2,'x'));</syntaxhighlight>

----

===TrimLeft===
TrimLeft will return the string with the chars from the passed char set trimmed from the left.

'''Parameters:''' charset; optional (default " \r\n\v\t")

'''Returns:''' trimmed string

'''Example:''' <syntaxhighlight lang="java">
mystring = " Test";
print(mystring.TrimLeft());</syntaxhighlight>

----

===TrimRight===
TrimRight will return the string with the chars from the passed char set trimmed from the right.

'''Parameters:''' charset; optional (default " \r\n\v\t")

'''Returns:''' trimmed string

'''Example:''' <syntaxhighlight lang="java">
mystring = "Test ";
print(mystring.TrimRight());</syntaxhighlight>

----

===GetFilename===
GetFilename will return the filename part of a path string incl. extension.

'''Parameters:''' none

'''Returns:''' filename

'''Example:''' <syntaxhighlight lang="java">
mystring = "C:\\Program Files\\Omni-Bot\\et\\nav\\test.gm";
print(mystring.GetFilename());</syntaxhighlight>

----

===GetFilenameNoExt===
GetFilenameNoExt will return the filename part of a path string without extension.

'''Parameters:''' none

'''Returns:''' filename

'''Example:''' <syntaxhighlight lang="java">
mystring = "C:\\Program Files\\Omni-Bot\\et\\nav\\test.gm";
print(mystring.GetFilenameNoExt());</syntaxhighlight>

----

===GetExtension===
GetExtension will return the extension part of a path string.

'''Parameters:''' none

'''Returns:''' extension

'''Example:''' <syntaxhighlight lang="java">
mystring = "C:\\Program Files\\Omni-Bot\\et\\nav\\test.gm";
print(mystring.GetExtension());</syntaxhighlight>

----

===SetExtension===
SetExtension returns a string with the extension changed to the given one.

'''Parameters:''' The new extension, with or without the dot. null to remove extension.

'''Returns:''' path with new extension

'''Example:''' <syntaxhighlight lang="java">
mystring = "C:\\Program Files\\Omni-Bot\\et\\nav\\test.gm";
mystring = mystring.SetExtension(".way");
print("mystring:",mystring);</syntaxhighlight>

----

===GetPath===
GetPath will return the file path from a path string.

'''Parameters:''' includeSlash (optional, default false)

'''Returns:''' path with new extension

'''Example:''' <syntaxhighlight lang="java">
mystring = "C:\\Program Files\\Omni-Bot\\et\\nav\\test.gm";
print(mystring.GetPath());
print(mystring.GetPath(true));</syntaxhighlight>

----

===Tokenize===
Splits a string into substrings (tokens) at occurrences of the string passed as parameter.

'''Parameters:''' String.

'''Returns:''' Table of tokens.

'''Example:''' <syntaxhighlight lang="java">
tokens = "bla, blu, bli".Tokenize(", ");
foreach (t in tokens)
{
print(t);
}</syntaxhighlight>

String Library - Revision history

Palota: 1 revision imported

Palota: 1 revision imported