summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThaddeus Crews <repiteo@outlook.com>2024-11-14 14:51:55 -0600
committerThaddeus Crews <repiteo@outlook.com>2024-11-14 14:51:55 -0600
commit059731554a6783f99c343c91b379d7564b9f6812 (patch)
tree2701711d53b3bba2ac3b76fbca134a0ed74c7235
parent9b3063b6631ae586680e9751d6ba06f4ffaf1c23 (diff)
parentaf76a896ef58033e9649a943bc50cabf39abf522 (diff)
downloadredot-engine-059731554a6783f99c343c91b379d7564b9f6812.tar.gz
Merge pull request #98478 from Calinou/doc-globalscope-property-usage-script-variable
Improve documentation on `@GlobalScope.PROPERTY_USAGE_SCRIPT_VARIABLE`
-rw-r--r--doc/classes/@GlobalScope.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index ce64bcc17c..1721134d08 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -2981,7 +2981,7 @@
Editing the property prompts the user for restarting the editor.
</constant>
<constant name="PROPERTY_USAGE_SCRIPT_VARIABLE" value="4096" enum="PropertyUsageFlags" is_bitfield="true">
- The property is a script variable which should be serialized and saved in the scene file.
+ The property is a script variable. [constant PROPERTY_USAGE_SCRIPT_VARIABLE] can be used to distinguish between exported script variables from built-in variables (which don't have this usage flag). By default, [constant PROPERTY_USAGE_SCRIPT_VARIABLE] is [b]not[/b] applied to variables that are created by overriding [method Object._get_property_list] in a script.
</constant>
<constant name="PROPERTY_USAGE_STORE_IF_NULL" value="8192" enum="PropertyUsageFlags" is_bitfield="true">
The property value of type [Object] will be stored even if its value is [code]null[/code].