Substring - StringUtil: Difference between revisions
Jump to navigation
Jump to search
imported>JohnB m (→See Also) |
m (Correct Parameter Name (str --> s)) |
||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
string Function Substring(string | string Function Substring(string s, int startIndex, int len = 0) global native | ||
</source> | </source> | ||
== Parameters == | == Parameters == | ||
* | *s: The string from which to retrieve the substring. | ||
*startIndex: Starting character position of a substring. | *startIndex: Starting character position of a substring. | ||
*len: An optional length of the substring. Default of 0 means for the entire string. | *len: An optional length of the substring. Default of 0 means for the entire string. | ||
Revision as of 22:09, 21 April 2025
SKSE Member of: StringUtil Script
Returns a portion of the string starting at given index, optionally with specified amount of characters. (This function requires SKSE)
Syntax
string Function Substring(string s, int startIndex, int len = 0) global nativeParameters
- s: The string from which to retrieve the substring.
- startIndex: Starting character position of a substring.
- len: An optional length of the substring. Default of 0 means for the entire string.
- Default: 0
Return Value
Portion from the given string. Returns none if the given startIndex was invalid.
Examples
Import StringUtil
string ss = "Sample string"
string s1 = Substring(ss, 5)
;"e string"
string s2 = Substring(ss, 2, 4)
;"mple"
string s3 = Substring(ss, 20)
;none
string s4 = Substring(ss, 0, -1)
;"sample string"Notes
Invalid len value will work as if 0 was given.
This function is case-insensitive (like all SKSE string functions right now).