summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHaoyu Qiu <timothyqiu32@gmail.com>2022-03-23 16:19:22 +0800
committerHaoyu Qiu <timothyqiu32@gmail.com>2022-03-23 17:05:49 +0800
commit405bc96a1e191cb65fa5db65ae03546c653d8b8a (patch)
tree988a021b11be84eefa277b10c25f56c5ba3739ce /doc
parentc530a9bffb8eb906fce54768e737ea03c1fbccf0 (diff)
Document how to specify explicit value for `PROPERTY_HINT_ENUM` names
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/@GlobalScope.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index f692a49ba1..a2b310ca82 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -2405,7 +2405,8 @@
Additionally, other keywords can be included: "exp" for exponential range editing, "radians" for editing radian angles in degrees, "degrees" to hint at an angle and "noslider" to hide the slider.
</constant>
<constant name="PROPERTY_HINT_ENUM" value="2" enum="PropertyHint">
- Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code].
+ Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string.
+ The hint string is a comma separated list of names such as [code]"Hello,Something,Else"[/code]. For integer and float 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].
</constant>
<constant name="PROPERTY_HINT_ENUM_SUGGESTION" value="3" enum="PropertyHint">
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].