Difference between revisions of "String.sub"
From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| Line 5: | Line 5: | ||
=== Description === | === Description === | ||
Returns the substring of s that starts at i and continues until j; i and j can be negative. If j is absent, then it is assumed to be equal to -1 (which is the same as the string length). In particular, the call string.sub(s,1,j) returns a prefix of s with length j, and string.sub(s, -i) returns a suffix of s with length i. | Returns the substring of s that starts at i and continues until j; i and j can be negative. If j is absent, then it is assumed to be equal to -1 (which is the same as the string length). In particular, the call string.sub(s,1,j) returns a prefix of s with length j, and string.sub(s, -i) returns a suffix of s with length i. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
(string) = string.sub(s,i,j) | (string) = string.sub(s,i,j) | ||
</source> | </source> | ||
| Line 18: | Line 18: | ||
=== Example === | === Example === | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local mynme = "nme01" | local mynme = "nme01" | ||
print(string.sub(mynme, 1, 3)) -- nme | print(string.sub(mynme, 1, 3)) -- nme | ||
Revision as of 15:31, 13 July 2023
Available since: Gideros 2011.6
Class: string
Description
Returns the substring of s that starts at i and continues until j; i and j can be negative. If j is absent, then it is assumed to be equal to -1 (which is the same as the string length). In particular, the call string.sub(s,1,j) returns a prefix of s with length j, and string.sub(s, -i) returns a suffix of s with length i. <syntaxhighlight lang="lua"> (string) = string.sub(s,i,j) </source>
Parameters
s: (string) string to get substring from
i: (number) start index of substring
j: (number) index of the last character of substring optional
Return values
Returns (string) substring
Example
<syntaxhighlight lang="lua"> local mynme = "nme01" print(string.sub(mynme, 1, 3)) -- nme -- or this print(mynme:sub(1, 3)) -- nme </source>
