godot/doc/classes/StringName.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="StringName" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		An optimized string type for unique names.
	</brief_description>
	<description>
		[StringName]s are immutable strings designed for general-purpose representation of unique names (also called "string interning"). [StringName] ensures that only one instance of a given name exists (so two [StringName]s with the same value are the same object). Comparing them is much faster than with regular [String]s, because only the pointers are compared, not the whole strings.
		You will usually just pass a [String] to methods expecting a [StringName] and it will be automatically converted, but you may occasionally want to construct a [StringName] ahead of time with [StringName] or the literal syntax [code]&amp;"example"[/code].
		See also [NodePath], which is a similar concept specifically designed to store pre-parsed node paths.
	</description>
	<tutorials>
	</tutorials>
	<constructors>
		<constructor name="StringName">
			<return type="StringName" />
			<description>
				Constructs an empty [StringName].
			</description>
		</constructor>
		<constructor name="StringName">
			<return type="StringName" />
			<param index="0" name="from" type="StringName" />
			<description>
				Constructs a [StringName] as a copy of the given [StringName].
			</description>
		</constructor>
		<constructor name="StringName">
			<return type="StringName" />
			<param index="0" name="from" type="String" />
			<description>
				Creates a new [StringName] from the given [String]. [code]StringName("example")[/code] is equivalent to [code]&amp;"example"[/code].
			</description>
		</constructor>
	</constructors>
	<methods>
		<method name="hash" qualifiers="const">
			<return type="int" />
			<description>
				Returns the 32-bit hash value representing the [StringName]'s contents.
			</description>
		</method>
	</methods>
	<operators>
		<operator name="operator !=">
			<return type="bool" />
			<param index="0" name="right" type="String" />
			<description>
			</description>
		</operator>
		<operator name="operator !=">
			<return type="bool" />
			<param index="0" name="right" type="StringName" />
			<description>
			</description>
		</operator>
		<operator name="operator &lt;">
			<return type="bool" />
			<param index="0" name="right" type="StringName" />
			<description>
			</description>
		</operator>
		<operator name="operator &lt;=">
			<return type="bool" />
			<param index="0" name="right" type="StringName" />
			<description>
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<param index="0" name="right" type="String" />
			<description>
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<param index="0" name="right" type="StringName" />
			<description>
			</description>
		</operator>
		<operator name="operator &gt;">
			<return type="bool" />
			<param index="0" name="right" type="StringName" />
			<description>
			</description>
		</operator>
		<operator name="operator &gt;=">
			<return type="bool" />
			<param index="0" name="right" type="StringName" />
			<description>
			</description>
		</operator>
	</operators>
</class>
doc: Sync classref with StringName/Callable changes 2020-02-22 13:59:09 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="StringName" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with StringName/Callable changes 2020-02-22 13:59:09 +00:00			`<brief_description>`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`An optimized string type for unique names.`
doc: Sync classref with StringName/Callable changes 2020-02-22 13:59:09 +00:00			`</brief_description>`
			`<description>`
Improve documentation for NodePath and StringName - Update the NodePath shorthand prefix for `master`. - Document the StringName construction shorthand (`&"example"`). - Cross-link between NodePath and StringName, as these are related concepts. 2022-03-13 00:04:51 +00:00			`[StringName]s are immutable strings designed for general-purpose representation of unique names (also called "string interning"). [StringName] ensures that only one instance of a given name exists (so two [StringName]s with the same value are the same object). Comparing them is much faster than with regular [String]s, because only the pointers are compared, not the whole strings.`
			`You will usually just pass a [String] to methods expecting a [StringName] and it will be automatically converted, but you may occasionally want to construct a [StringName] ahead of time with [StringName] or the literal syntax [code]&"example"[/code].`
			`See also [NodePath], which is a similar concept specifically designed to store pre-parsed node paths.`
doc: Sync classref with StringName/Callable changes 2020-02-22 13:59:09 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`<constructors>`
			`<constructor name="StringName">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="StringName" />`
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors. 2020-11-09 16:46:03 +00:00			`<description>`
			`Constructs an empty [StringName].`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</constructor>`
			`<constructor name="StringName">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="StringName" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="from" type="StringName" />`
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors. 2020-11-09 16:46:03 +00:00			`<description>`
			`Constructs a [StringName] as a copy of the given [StringName].`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</constructor>`
			`<constructor name="StringName">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="StringName" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="from" type="String" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 13:59:09 +00:00			`<description>`
Improve documentation for NodePath and StringName - Update the NodePath shorthand prefix for `master`. - Document the StringName construction shorthand (`&"example"`). - Cross-link between NodePath and StringName, as these are related concepts. 2022-03-13 00:04:51 +00:00			`Creates a new [StringName] from the given [String]. [code]StringName("example")[/code] is equivalent to [code]&"example"[/code].`
doc: Sync classref with StringName/Callable changes 2020-02-22 13:59:09 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</constructor>`
			`</constructors>`
[GDExtension] Expose Variant, NodePath and StringName hash functions. 2022-06-06 09:19:56 +00:00			`<methods>`
			`<method name="hash" qualifiers="const">`
			`<return type="int" />`
			`<description>`
			`Returns the 32-bit hash value representing the [StringName]'s contents.`
			`</description>`
			`</method>`
			`</methods>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`<operators>`
			`<operator name="operator !=">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="String" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`<operator name="operator !=">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="StringName" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`<operator name="operator <">`
			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="StringName" />`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`<description>`
			`</description>`
			`</operator>`
			`<operator name="operator <=">`
			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="StringName" />`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`<description>`
			`</description>`
			`</operator>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`<operator name="operator ==">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="String" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`<operator name="operator ==">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="StringName" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`<operator name="operator >">`
			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="StringName" />`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`<description>`
			`</description>`
			`</operator>`
			`<operator name="operator >=">`
			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="StringName" />`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`<description>`
			`</description>`
			`</operator>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operators>`
doc: Sync classref with StringName/Callable changes 2020-02-22 13:59:09 +00:00			`</class>`