Returns a substring of the string passed. The substring starts at i. If the third argument j is not given, the substring will end at the end of the string. If the third argument is given, the substring ends at and includes j.

Syntax

string utf8.sub ( string input, [ int i = 1, int j = utf8.len( input ) ] )

Required Arguments

• input: A string character sequence.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• i (default: 1): An integer representing the beginning position (may be negative).
• j (default: utf8.len( input )): An integer representing the ending position (may be negative).

Returns

• string: substring

Returns a string substring of the original string, containing the selected range from the original string.

Code Examples

Example 1 Example 2

shared

This example shows how to extract a substring from a UTF-8 string.

local input = "Yarın Salı"

local output = utf8.sub(input, 1, 4)
outputConsole(output) -- Yarı

local output = utf8.sub(input, -4)
outputConsole(output) -- Salı

local output = utf8.sub(input, -4, -1)
outputConsole(output) -- Salı

shared

local input = "Happy Now"

local output = utf8.sub(input, 1, 5)
outputChatBox(output) -- Happy

local output = utf8.sub(input, -3)
outputChatBox(output) -- Now

local output = utf8.sub(input, -3, -1)
outputChatBox(output) -- Now

See Also

UTF8 Library Functions

• utf8.byte
• utf8.char
• utf8.charpos
• utf8.escape
• utf8.find
• utf8.fold
• utf8.gmatch
• utf8.gsub
• utf8.insert
• utf8.len
• utf8.lower
• utf8.match
• utf8.ncasecmp
• utf8.next
• utf8.remove
• utf8.reverse
• utf8.sub
• utf8.title
• utf8.upper
• utf8.width
• utf8.widthindex

Reference

• Scripting Functions