Utf8.sub

From GiderosMobile
Revision as of 14:32, 13 July 2023 by Hgy29 (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")


Available since: Gideros 2016.06
Class: utf8

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. If, after the translation of negative indices, i is less than 1, it is corrected to 1. If j is greater than the string length, it is corrected to that length. If, after these corrections, i is greater than j, the function returns the empty string. <syntaxhighlight lang="lua"> (string) = utf8.sub(s,i,j) </source>

Parameters

s: (string)
i: (number)
j: (number) optional

Return values

Returns (string) substring of s that starts at i and continues until j