Skip to content

Commit 05d9587

Browse files
committed
Merge pull request #112318 from timothyqiu/string-name-enum
Fix `StringName` not documented for enum hint
2 parents 158d178 + 86bf1d9 commit 05d9587

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

doc/classes/@GlobalScope.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2780,11 +2780,11 @@
27802780
Additionally, other keywords can be included: [code]"exp"[/code] for exponential range editing, [code]"radians_as_degrees"[/code] for editing radian angles in degrees (the range values are also in degrees), [code]"degrees"[/code] to hint at an angle, [code]"prefer_slider"[/code] to show the slider for integers, and [code]"hide_control"[/code] to hide the slider or up-down arrows.
27812781
</constant>
27822782
<constant name="PROPERTY_HINT_ENUM" value="2" enum="PropertyHint">
2783-
Hints that an [int] or [String] property is an enumerated value to pick in a list specified via a hint string.
2784-
The hint string is a comma separated list of names such as [code]"Hello,Something,Else"[/code]. Whitespaces are [b]not[/b] removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"Zero,One,Three:3,Four,Six:6"[/code].
2783+
Hints that an [int], [String], or [StringName] property is an enumerated value to pick in a list specified via a hint string.
2784+
The hint string is a comma separated list of names such as [code]"Hello,Something,Else"[/code]. Whitespace is [b]not[/b] removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"Zero,One,Three:3,Four,Six:6"[/code].
27852785
</constant>
27862786
<constant name="PROPERTY_HINT_ENUM_SUGGESTION" value="3" enum="PropertyHint">
2787-
Hints that a [String] property can be an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code].
2787+
Hints that a [String] or [StringName] property can be an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code]. See [constant PROPERTY_HINT_ENUM] for details.
27882788
Unlike [constant PROPERTY_HINT_ENUM], a property with this hint still accepts arbitrary values and can be empty. The list of values serves to suggest possible values.
27892789
</constant>
27902790
<constant name="PROPERTY_HINT_EXP_EASING" value="4" enum="PropertyHint">
@@ -2795,7 +2795,7 @@
27952795
</constant>
27962796
<constant name="PROPERTY_HINT_FLAGS" value="6" enum="PropertyHint">
27972797
Hints that an [int] property is a bitmask with named bit flags.
2798-
The hint string is a comma separated list of names such as [code]"Bit0,Bit1,Bit2,Bit3"[/code]. Whitespaces are [b]not[/b] removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"A:4,B:8,C:16"[/code]. You can also combine several flags ([code]"A:4,B:8,AB:12,C:16"[/code]).
2798+
The hint string is a comma separated list of names such as [code]"Bit0,Bit1,Bit2,Bit3"[/code]. Whitespace is [b]not[/b] removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"A:4,B:8,C:16"[/code]. You can also combine several flags ([code]"A:4,B:8,AB:12,C:16"[/code]).
27992799
[b]Note:[/b] A flag value must be at least [code]1[/code] and at most [code]2 ** 32 - 1[/code].
28002800
[b]Note:[/b] Unlike [constant PROPERTY_HINT_ENUM], the previous explicit value is not taken into account. For the hint [code]"A:16,B,C"[/code], A is 16, B is 2, C is 4.
28012801
</constant>

editor/inspector/editor_properties.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3863,6 +3863,7 @@ EditorProperty *EditorInspectorDefaultPlugin::get_editor_for_property(Object *p_
38633863
Vector<String> options;
38643864
Vector<String> option_names;
38653865
if (p_hint_text.begins_with(";")) {
3866+
// This is not supported officially. Only for `interface/editor/editor_language`.
38663867
for (const String &option : p_hint_text.split(";", false)) {
38673868
options.append(option.get_slicec('/', 0));
38683869
option_names.append(option.get_slicec('/', 1));

0 commit comments

Comments
 (0)