Skip to content

string⚓︎

This library provides generic functions for string manipulation, such as finding and extracting substrings, and pattern matching. When indexing a string in Lua, the first character is at position 1 (not at 0, as in C). Indices are allowed to be negative and are interpreted as indexing backwards, from the end of the string. Thus, the last character is at position -1, and so on.

Functions⚓︎

string.endswith⚓︎

Returns true if a string ends with a given pattern.

local result = string.endswith(s, pattern)

Parameters:

  • s (string)
  • pattern (string)

Returns:

  • result (boolean)

string.format⚓︎

This function creates a string, given various values. The first parameter follows the printf format, with the additional option of %q to automatically quote a string.

Specifier Output Example
%d Signed decimal integer. -392
%i Same as %d. -392
%u Unsigned decimal integer. 7235
%o Unsigned octal. 610
%x Unsigned hexadecimal integer. 7fa
%X As %x, but uppercase. 7FA
%f Decimal floating point, lowercase. 392.65
%F Decimal floating point, uppercase. 392.65
%e Scientific notation (mantissa/exponent), lowercase. 3.9265e+2
%E Scientific notation (mantissa/exponent), uppercase. 3.9265E+2
%g Use the shortest representation: %e or %f. 392.65
%G Use the shortest representation: %E or %F. 392.65
%a Hexadecimal floating point, lowercase. -0xc.90fep-2
%A Hexadecimal floating point, uppercase. -0XC.90FEP-2
%c Character. a
%s String of characters. sample
%q Quoted string of characters. "sample"
%p Pointer address. b8000000
%% The literal % character. % 
local result = string.format(format, values)

Parameters:

  • format (string): The format string to use for the output.
  • values (any): Optional. Values to format into the given string.

Returns:

  • result (string)

string.insert⚓︎

Returns a string where one string has been inserted into another at a given position.

local inserted = string.insert(s1, s2, position)

Parameters:

  • s1 (string): The string to insert into.
  • s2 (string): The string to insert.
  • position (number): The position to insert s2 into s1.

Returns:

  • inserted (string): A copy of s1 with s2 inserted into it.

string.multifind⚓︎

Performs the logic of find, using a table of patterns.

If any of the available patterns match, the matching pattern is returned followed by the normal results of the find.

string.multifind(s, pattern, index, plain)

Parameters:

  • s (string): The string to perform finds on.
  • pattern (table): An array-style table that contains pattern strings.
  • index (number): Default: 1. Start index of the find.
  • plain (boolean): Default: false. If true, a normal search instead of a pattern search will be performed.

string.split⚓︎

Returns an array-style table with str split by sep. The seperator is not part of the results. By default the seperator is %s, splitting the given string by spaces.

local split = string.split(str, sep)

Parameters:

  • str (string): The string to split.
  • sep (string): Default: "%s". The token to split the string by.

Returns:

  • split (string[])

string.startswith⚓︎

Returns true if a string begins with a given pattern.

local result = string.startswith(s, pattern)

Parameters:

  • s (string)
  • pattern (string)

Returns:

  • result (boolean)

string.trim⚓︎

Returns a copy of the string, with whitespace removed from the start and end.

local trimmed = string.trim(s)

Parameters:

  • s (string)

Returns:

  • trimmed (string)