Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-03 17:39:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added docs for StringName.

Browse Source
This commit is contained in:
Relintai 2023-09-06 20:49:07 +02:00
parent 7fab5e4c25
commit 8ff20ba6e3
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/StringName.xml
View File

@ -1,8 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="StringName" version="4.1"> <class name="StringName" version="4.1">
<brief_description> <brief_description>
A built-in type for unique strings.
</brief_description> </brief_description>
<description> <description>
[StringName]s are immutable strings designed for general-purpose representation of unique names (also called "string interning"). Two [StringName]s with the same value are the same object. Comparing them is extremely fast compared to regular [String]s.
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 the [StringName] constructor or, in GDScript, the literal syntax [code]@"example"[/code].
See also [NodePath], which is a similar concept specifically designed to store pre-parsed scene tree paths.
</description>
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -11,6 +16,7 @@
<return type="StringName" /> <return type="StringName" />
<argument index="0" name="from" type="String" /> <argument index="0" name="from" type="String" />
<description> <description>
Constructs a [StringName] as a copy of the given [StringName].
</description> </description>
</method> </method>
</methods> </methods>