String.find

Available since: Gideros 2011.6
Class: string

Description

Looks for the first match of pattern in the string s. If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered "magic". Note that if plain is given, then init must be given as well.

If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.

(numbers) = string.find(s,pattern,init,plain)

Parameters

s: (string) string where to find a pattern
pattern: (string) pattern to find
init: (number) index where to start searching for pattern optional
plain: (bool) if true, then it simply matches substring without any special symbols (default = false) optional

Return values

Returns (numbers) indexes of occurrence of the pattern or nil

---

• String
• String.byte
• String.char
• String.dump
• String.find
• String.format
• String.gmatch
• String.gsub
• String.len
• String.lower
• String.match
• String.pack
• String.packsize
• String.rep
• String.reverse
• String.split
• String.sub
• String.unpack
• String.upper

---

---

• Main Page
• Lua API
• Main API
• Plugins