mirror of
https://github.com/godotengine/godot.git
synced 2024-11-29 23:53:08 +00:00
7adf4cc9b5
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.
60 lines
2.0 KiB
XML
60 lines
2.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="StringName" version="4.0">
|
|
<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. [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.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="StringName" qualifiers="constructor">
|
|
<return type="StringName" />
|
|
<description>
|
|
Constructs an empty [StringName].
|
|
</description>
|
|
</method>
|
|
<method name="StringName" qualifiers="constructor">
|
|
<return type="StringName" />
|
|
<argument index="0" name="from" type="StringName" />
|
|
<description>
|
|
Constructs a [StringName] as a copy of the given [StringName].
|
|
</description>
|
|
</method>
|
|
<method name="StringName" qualifiers="constructor">
|
|
<return type="StringName" />
|
|
<argument index="0" name="from" type="String" />
|
|
<description>
|
|
Creates a new [StringName] from the given [String].
|
|
</description>
|
|
</method>
|
|
<method name="operator !=" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator !=" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="StringName" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator ==" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="operator ==" qualifiers="operator">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="StringName" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|