Class StringName

StringName metatype, wrapper for godot_string_name.

Construct using the idiom StringName(name), which calls __new.

Methods

StringName:get_data_unique_pointer () Returns this StringName's data pointer (const void *)
StringName:get_hash () Returns this StringName's 32-bit hash value.
StringName:get_name () Returns this StringName as a String.

Metamethods

StringName:__concat (a, b) Concatenates values.
StringName:__len () Return this StringName's amount of characters.
StringName:__new ([name=""]) StringName constructor, called by the idiom StringName(name).
StringName:__tostring () Returns a Lua string representation of this StringName.


Methods

StringName:get_data_unique_pointer ()
Returns this StringName's data pointer (const void *)

Returns:

    const void *
StringName:get_hash ()
Returns this StringName's 32-bit hash value.

Returns:

    uint32_t
StringName:get_name ()
Returns this StringName as a String.

Returns:

    String

Metamethods

StringName:__concat (a, b)
Concatenates values.

Parameters:

  • a First value, stringified with GD.str
  • b First value, stringified with GD.str

Returns:

    String
StringName:__len ()
Return this StringName's amount of characters.

Returns:

    int
StringName:__new ([name=""])
StringName constructor, called by the idiom StringName(name).

Parameters:

  • name Name, stringified with GD.str (default "")

Returns:

    StringName
StringName:__tostring ()
Returns a Lua string representation of this StringName.

Returns:

    string

See also:

generated by LDoc 1.4.6 Last updated 2023-01-04 08:52:34