init

Other members in extension

Typealiases

• typealias ContentType

Type members

• init(String)
• init(String.SubSequence)

  Creates a StringName from a Swift String.Substring

• init(alreadyOwnedContent: ContentType)
• init(content: ContentType)
• init(from: StringName)

  Constructs a StringName as a copy of the given StringName.

• init(from: String)

  Creates a new StringName from the given String. In GDScript, StringName("example") is equivalent to &"example".

• init(fromPtr: UnsafeRawPointer?)
• init(stringLiteral: String)
• static var godotType: Variant.GType
• static let zero: ContentType
• static func != (lhs: StringName, rhs: StringName) -> Bool

  Returns true if this StringName is not equivalent to the given String.

• static func != (lhs: StringName, rhs: String) -> Bool

  Returns true if this StringName is not equivalent to the given String.

• static func % (lhs: StringName, rhs: PackedStringArray) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Projection) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Quaternion) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: GDictionary) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Transform2D) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Transform3D) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedByteArray) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedColorArray) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedInt32Array) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedInt64Array) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedFloat32Array) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedFloat64Array) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedVector2Array) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: PackedVector3Array) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: AABB) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Basis) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Color) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Plane) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Rect2) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: GArray) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Object) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Rect2i) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Signal) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Vector2) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Vector3) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Vector4) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Callable) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: NodePath) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Vector2i) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Vector3i) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Vector4i) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: StringName) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: String) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Bool) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Double) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func % (lhs: StringName, rhs: Int64) -> String

  Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an GArray.

• static func + (lhs: StringName, rhs: StringName) -> String

  Appends right at the end of this StringName, returning a String. This is also known as a string concatenation.

• static func + (lhs: StringName, rhs: String) -> String

  Appends right at the end of this StringName, returning a String. This is also known as a string concatenation.

• static func < (lhs: StringName, rhs: StringName) -> Bool

  Returns true if the left StringName’s pointer comes before right. Note that this will not match their Unicode order.

• static func <= (lhs: StringName, rhs: StringName) -> Bool

  Returns true if the left StringName’s pointer comes before right or if they are the same. Note that this will not match their Unicode order.

• static func == (lhs: StringName, rhs: StringName) -> Bool

  Compares two StringNames for equality.

• static func == (lhs: StringName, rhs: String) -> Bool

  Returns true if this StringName is equivalent to the given String.

• static func > (lhs: StringName, rhs: StringName) -> Bool

  Returns true if the left StringName’s pointer comes after right. Note that this will not match their Unicode order.

• static func >= (lhs: StringName, rhs: StringName) -> Bool

  Returns true if the left StringName’s pointer comes after right or if they are the same. Note that this will not match their Unicode order.

Instance members

• var content: ContentType
• var description: String

  Returns a Swift string from the StringName

• func beginsWith(text: String) -> Bool

  Returns true if the string begins with the given text. See also endsWith(text:).

• func bigrams() -> PackedStringArray

  Returns an array containing the bigrams (pairs of consecutive characters) of this string.

• func binToInt() -> Int64

  Converts the string representing a binary number into an integer. The string may optionally be prefixed with "0b", and an additional - prefix for negative numbers.

• func cEscape() -> String

  Returns a copy of the string with special characters escaped using the C language standard.

• func cUnescape() -> String

  Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are \', \", \\, \a, \b, \f, \n, \r, \t, \v.

• func capitalize() -> String

  Changes the appearance of the string: replaces underscores (_) with spaces, adds spaces before uppercase letters in the middle of a word, converts all letters to lowercase, then converts the first one and each one following a space to uppercase.

• func casecmpTo(String) -> Int64

  Performs a case-sensitive comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. “Less than” and “greater than” are determined by the Unicode code points of each string, which roughly matches the alphabetical order.

• func contains(what: String) -> Bool

  Returns true if the string contains what. In GDScript, this corresponds to the in operator.

• func count(what: String, from: Int64, to: Int64) -> Int64

  Returns the number of occurrences of the substring what between from and to positions. If to is 0, the search continues until the end of the string.

• func countn(what: String, from: Int64, to: Int64) -> Int64

  Returns the number of occurrences of the substring what between from and to positions, ignoring case. If to is 0, the search continues until the end of the string.

• func dedent() -> String

  Returns a copy of the string with indentation (leading tabs and spaces) removed. See also indent(prefix:) to add indentation.

• func endsWith(text: String) -> Bool

  Returns true if the string ends with the given text. See also beginsWith(text:).

• func erase(position: Int64, chars: Int64) -> String

  Returns a string with chars characters erased starting from position. If chars goes beyond the string’s length given the specified position, fewer characters will be erased from the returned string. Returns an empty string if either position or chars is negative. Returns the original string unmodified if chars is 0.

• func find(what: String, from: Int64) -> Int64

  Returns the index of the first occurrence of what in this string, or -1 if there are none. The search’s start can be specified with from, continuing to the end of the string.

• func findn(what: String, from: Int64) -> Int64

  Returns the index of the first case-insensitive occurrence of what in this string, or -1 if there are none. The starting search index can be specified with from, continuing to the end of the string.

• func format(values: Variant, placeholder: String) -> String

  Formats the string by replacing all occurrences of placeholder with the elements of values.

• func getBaseDir() -> String

  If the string is a valid file path, returns the base directory name.

• func getBasename() -> String

  If the string is a valid file path, returns the full file path, without the extension.

• func getExtension() -> String

  If the string is a valid file name or path, returns the file extension without the leading period (.). Otherwise, returns an empty string.

• func getFile() -> String

  If the string is a valid file path, returns the file name, including the extension.

• func getSlice(delimiter: String, slice: Int64) -> String

  Splits the string using a delimiter and returns the substring at index slice. Returns an empty string if the slice does not exist.

• func getSliceCount(delimiter: String) -> Int64

  Returns the total number of slices when the string is split with the given delimiter (see split(delimiter:allowEmpty:maxsplit:)).

• func getSlicec(delimiter: Int64, slice: Int64) -> String

  Splits the string using a Unicode character with code delimiter and returns the substring at index slice. Returns an empty string if the slice does not exist.

• func hash() -> Int64

  Returns the 32-bit hash value representing the string’s contents.

• func hash(into: inout Hasher)
• func hexDecode() -> PackedByteArray

  Decodes a hexadecimal string as a PackedByteArray.

• func hexToInt() -> Int64

  Converts the string representing a hexadecimal number into an integer. The string may be optionally prefixed with "0x", and an additional - prefix for negative numbers.

• func indent(prefix: String) -> String

  Indents every line of the string with the given prefix. Empty lines are not indented. See also dedent to remove indentation.

• func insert(position: Int64, what: String) -> String

  Inserts what at the given position in the string.

• func isAbsolutePath() -> Bool

  Returns true if the string is a path to a file or directory, and its starting point is explicitly defined. This method is the opposite of isRelativePath.

• func isEmpty() -> Bool

  Returns true if the string’s length is 0 (""). See also length.

• func isRelativePath() -> Bool

  Returns true if the string is a path, and its starting point is dependent on context. The path could begin from the current directory, or the current Node (if the string is derived from a NodePath), and may sometimes be prefixed with "./". This method is the opposite of isAbsolutePath.

• func isSubsequenceOf(text: String) -> Bool

  Returns true if all characters of this string can be found in text in their original order.

• func isSubsequenceOfn(text: String) -> Bool

  Returns true if all characters of this string can be found in text in their original order, ignoring case.

• func isValidFilename() -> Bool

  Returns true if this string does not contain characters that are not allowed in file names (: / \ ? * " | % < >).

• func isValidFloat() -> Bool

  Returns true if this string represents a valid floating-point number. A valid float may contain only digits, one decimal point (.), and the exponent letter (e). It may also be prefixed with a positive (+) or negative (-) sign. Any valid integer is also a valid float (see isValidInt). See also toFloat.

• func isValidHexNumber(withPrefix: Bool) -> Bool

  Returns true if this string is a valid hexadecimal number. A valid hexadecimal number only contains digits or letters A to F (either uppercase or lowercase), and may be prefixed with a positive (+) or negative (-) sign.

• func isValidHtmlColor() -> Bool

  Returns true if this string is a valid color in hexadecimal HTML notation. The string must be a hexadecimal value (see isValidHexNumber(withPrefix:)) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (#). Other HTML notations for colors, such as names or hsl(), are not considered valid. See also html(rgba:).

• func isValidIdentifier() -> Bool

  Returns true if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (_), and the first character may not be a digit.

• func isValidInt() -> Bool

  Returns true if this string represents a valid integer. A valid integer only contains digits, and may be prefixed with a positive (+) or negative (-) sign. See also toInt.

• func isValidIpAddress() -> Bool

  Returns true if this string represents a well-formatted IPv4 or IPv6 address. This method considers reserved IP addresses such as "0.0.0.0" and "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff" as valid.

• func join(parts: PackedStringArray) -> String

  Returns the concatenation of parts’ elements, with each element separated by the string calling this method. This method is the opposite of split(delimiter:allowEmpty:maxsplit:).

• func jsonEscape() -> String

  Returns a copy of the string with special characters escaped using the JSON standard. Because it closely matches the C standard, it is possible to use cUnescape to unescape the string, if necessary.

• func left(length: Int64) -> String

  Returns the first length characters from the beginning of the string. If length is negative, strips the last length characters from the string’s end.

• func length() -> Int64

  Returns the number of characters in the string. Empty strings ("") always return 0. See also isEmpty.

• func lpad(minLength: Int64, character: String) -> String

  Formats the string to be at least minLength long by adding characters to the left of the string, if necessary. See also rpad(minLength:character:).

• func lstrip(chars: String) -> String

  Removes a set of characters defined in chars from the string’s beginning. See also rstrip(chars:).

• func match(expr: String) -> Bool

  Does a simple expression match (also called “glob” or “globbing”), where * matches zero or more arbitrary characters and ? matches any single character except a period (.). An empty string or empty expression always evaluates to false.

• func matchn(expr: String) -> Bool

  Does a simple case-insensitive expression match, where * matches zero or more arbitrary characters and ? matches any single character except a period (.). An empty string or empty expression always evaluates to false.

• func md5Buffer() -> PackedByteArray

  Returns the MD5 hash of the string as a PackedByteArray.

• func md5Text() -> String

  Returns the MD5 hash of the string as another String.

• func naturalcasecmpTo(String) -> Int64

  Performs a case-sensitive, natural order comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. “Less than” or “greater than” are determined by the Unicode code points of each string, which roughly matches the alphabetical order.

• func naturalnocasecmpTo(String) -> Int64

  Performs a case-insensitive, natural order comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. “Less than” or “greater than” are determined by the Unicode code points of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison.

• func nocasecmpTo(String) -> Int64

  Performs a case-insensitive comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. “Less than” or “greater than” are determined by the Unicode code points of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison.

• func padDecimals(digits: Int64) -> String

  Formats the string representing a number to have an exact number of digits after the decimal point.

• func padZeros(digits: Int64) -> String

  Formats the string representing a number to have an exact number of digits before the decimal point.

• func pathJoin(file: String) -> String

  Concatenates file at the end of the string as a subpath, adding / if necessary.

• func replace(what: String, forwhat: String) -> String

  Replaces all occurrences of what inside the string with the given forwhat.

• func replacen(what: String, forwhat: String) -> String

  Replaces all case-insensitive occurrences of what inside the string with the given forwhat.

• func reverse() -> String

  Returns the copy of this string in reverse order.

• func rfind(what: String, from: Int64) -> Int64

  Returns the index of the last occurrence of what in this string, or -1 if there are none. The search’s start can be specified with from, continuing to the beginning of the string. This method is the reverse of find(what:from:).

• func rfindn(what: String, from: Int64) -> Int64

  Returns the index of the last case-insensitive occurrence of what in this string, or -1 if there are none. The starting search index can be specified with from, continuing to the beginning of the string. This method is the reverse of findn(what:from:).

• func right(length: Int64) -> String

  Returns the last length characters from the end of the string. If length is negative, strips the first length characters from the string’s beginning.

• func rpad(minLength: Int64, character: String) -> String

  Formats the string to be at least minLength long, by adding characters to the right of the string, if necessary. See also lpad(minLength:character:).

• func rsplit(delimiter: String, allowEmpty: Bool, maxsplit: Int64) -> PackedStringArray

  Splits the string using a delimiter and returns an array of the substrings, starting from the end of the string. The splits in the returned array appear in the same order as the original string. If delimiter is an empty string, each substring will be a single character.

• func rstrip(chars: String) -> String

  Removes a set of characters defined in chars from the string’s end. See also lstrip(chars:).

• func sha1Buffer() -> PackedByteArray

  Returns the SHA-1 hash of the string as a PackedByteArray.

• func sha1Text() -> String

  Returns the SHA-1 hash of the string as another String.

• func sha256Buffer() -> PackedByteArray

  Returns the SHA-256 hash of the string as a PackedByteArray.

• func sha256Text() -> String

  Returns the SHA-256 hash of the string as another String.

• func similarity(text: String) -> Double

  Returns the similarity index (Sorensen-Dice coefficient) of this string compared to another. A result of 1.0 means totally similar, while 0.0 means totally dissimilar.

• func simplifyPath() -> String

  If the string is a valid file path, converts the string into a canonical path. This is the shortest possible path, without "./", and all the unnecessary ".." and "/".

• func split(delimiter: String, allowEmpty: Bool, maxsplit: Int64) -> PackedStringArray

  Splits the string using a delimiter and returns an array of the substrings. If delimiter is an empty string, each substring will be a single character. This method is the opposite of join(parts:).

• func splitFloats(delimiter: String, allowEmpty: Bool) -> PackedFloat64Array

  Splits the string into floats by using a delimiter and returns a PackedFloat64Array.

• func stripEdges(left: Bool, right: Bool) -> String

  Strips all non-printable characters from the beginning and the end of the string. These include spaces, tabulations (\t), and newlines (\n \r).

• func stripEscapes() -> String

  Strips all escape characters from the string. These include all non-printable control characters of the first page of the ASCII table (values from 0 to 31), such as tabulation (\t) and newline (\n, \r) characters, but not spaces.

• func substr(from: Int64, len: Int64) -> String

  Returns part of the string from the position from with length len. If len is -1 (as by default), returns the rest of the string starting from the given position.

• func toAsciiBuffer() -> PackedByteArray

  Converts the string to an ASCII/Latin-1 encoded PackedByteArray. This method is slightly faster than toUtf8Buffer, but replaces all unsupported characters with spaces.

• func toCamelCase() -> String

  Returns the string converted to camelCase.

• func toFloat() -> Double

  Converts the string representing a decimal number into a float. This method stops on the first non-number character, except the first decimal point (.) and the exponent letter (e). See also isValidFloat.

• func toInt() -> Int64

  Converts the string representing an integer number into an integer. This method removes any non-number character and stops at the first decimal point (.). See also isValidInt.

• func toLower() -> String

  Returns the string converted to lowercase.

• func toPascalCase() -> String

  Returns the string converted to PascalCase.

• func toSnakeCase() -> String

  Returns the string converted to snake_case.

• func toUpper() -> String

  Returns the string converted to uppercase.

• func toUtf16Buffer() -> PackedByteArray

  Converts the string to a UTF-16 encoded PackedByteArray.

• func toUtf32Buffer() -> PackedByteArray

  Converts the string to a UTF-32 encoded PackedByteArray.

• func toUtf8Buffer() -> PackedByteArray

  Converts the string to a UTF-8 encoded PackedByteArray. This method is slightly slower than toAsciiBuffer, but supports all UTF-8 characters. For most cases, prefer using this method.

• func toWcharBuffer() -> PackedByteArray

  Converts the string to a wide character (wchar_t, UTF-16 on Windows, UTF-32 on other platforms) encoded PackedByteArray.

• func trimPrefix(String) -> String

  Removes the given prefix from the start of the string, or returns the string unchanged.

• func trimSuffix(String) -> String

  Removes the given suffix from the end of the string, or returns the string unchanged.

• func unicodeAt(Int64) -> Int64

  Returns the character code at position at.

• func uriDecode() -> String

  Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request.

• func uriEncode() -> String

  Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request.

• func validateFilename() -> String

  Returns a copy of the string with all characters that are not allowed in isValidFilename replaced with underscores.

• func validateNodeName() -> String

  Returns a copy of the string with all characters that are not allowed in name (. : @ / " %) replaced with underscores.

• func xmlEscape(escapeQuotes: Bool) -> String

  Returns a copy of the string with special characters escaped using the XML standard. If escapeQuotes is true, the single quote (') and double quote (") characters are also escaped.

• func xmlUnescape() -> String

  Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.