FANDOM


Returns the number of characters between the first character of a value and an occurrence of a specified string.

Built-in Function handler Edit

Syntax:

offset(<charsToFind>, <stringToSearch> [, <charsToSkip>])

Examples:

offset("c","abcde") -- returns 3
offset("b","abacadabra",2) -- returns 6
offset("bark","embarking") -- returns 3

Use the offset function to find where a string occurs in another string.

The value returned by the offset function is the number of the character where charsToFind appears in stringToSearch. If the charsToFind is not in stringToSearch, the offset function returns zero.

If the charsToFind contains more than one character, and the entire charsToFind appears in the stringToSearch, the offset function returns the character number where the charsToFind starts.

If you specify how many charsToSkip, the offset function skips the specified number of characters in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.

Parameters:

  • charsToFind (string):
  • stringToSearch (string):
  • charsToSkip: A non-negative integer. If you don't specify how many charsToSkip, the offset function does not skip any items and starts at the beginning of the stringToSearch.
  • Returns: The offset function returns a non-negative integer.

See also: MatchText, wordOffset (function), itemOffset (function), length (function), lineOffset (function), begins with (operator)

Community content is available under CC-BY-SA unless otherwise noted.