UnicodeTrimLeft and UnicodeTrimRight (Unicode functions)
Trim characters from left or right of string (Unicode class)
[Introduced in Sirius Mods 7.9]
UnicodeTrimLeft and UnicodeTrimRight remove a specified number of characters from the left or right end of a string.
Syntax
%outUnicode = unicode:UnicodeTrimLeft( amount)
%outUnicode = unicode:UnicodeTrimRight( amount)
Syntax terms
| %outUnicode | Is the unicode string that results from removing amount characters from the left or right of unicode. |
|---|---|
| unicode | The method unicode object from which characters are removed. |
| amount | The number of characters to remove from the left or right of unicode. |
Usage notes
- An amount of 0 results in the output %outunicode string being set equal to the value of input unicode object.
- A negative amount or an amount greater than 231 results in request cancellation.
- An amount greater than or equal to the length of unicode results in the output string being set to a null string.
- UnicodeTrimLeft accomplishes the same thing as UnicodeSubString when used with just the starting position and without a length. While it might be a little bit more efficient than UnicodeSubString, it's mainly available for completeness.
- UnicodeTrimRight functionality can be achieved by using the UnicodeLeft and UnicodeLength functions but it is considerably more efficient and convenient.