Checks if a string starts with a specified substring.

Syntax

String.StartsWith( input, substring, [ comparisonType ] )

Arguments

• input (string): The string to be checked.
• substring (string): The substring to check for at the start of the string.
• comparisonType (String.StringComparison, optional): The type of string comparison to perform. Defaults to Ordinal.

Return Values

• (boolean): true if the string starts with the specified substring, false otherwise.

Examples

local result = String.StartsWith("Hello, world!", "hello", String.StringComparison.OrdinalIgnoreCase)
if result then
    print("The string starts with 'Hello'")
else
    print("The string does not start with 'Hello'")
end