Substring - StringUtil: Difference between revisions

From the CreationKit Wiki
Jump to navigation Jump to search
m (Correct Parameter Name (str --> s))
m (Convert source tags to syntaxhighlight)
 
Line 7: Line 7:


== Syntax ==
== Syntax ==
<source lang="papyrus">
<syntaxhighlight lang="papyrus">
string Function Substring(string s, int startIndex, int len = 0) global native
string Function Substring(string s, int startIndex, int len = 0) global native
</source>
</syntaxhighlight>


== Parameters ==
== Parameters ==
Line 22: Line 22:


== Examples ==
== Examples ==
<source lang="papyrus">
<syntaxhighlight lang="papyrus">
Import StringUtil
Import StringUtil


Line 34: Line 34:
string s4 = Substring(ss, 0, -1)  
string s4 = Substring(ss, 0, -1)  
;"sample string"
;"sample string"
</source>
</syntaxhighlight>


== Notes ==
== Notes ==

Latest revision as of 20:23, 5 September 2026

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[edit | edit source]

string Function Substring(string s, int startIndex, int len = 0) global native

Parameters[edit | edit source]

  • 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[edit | edit source]

Portion from the given string. Returns none if the given startIndex was invalid.

Examples[edit | edit source]

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[edit | edit source]

Invalid len value will work as if 0 was given.
This function is case-insensitive (like all SKSE string functions right now).

See Also[edit | edit source]