Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Merge pull request #107062 from KoBeWi/ultimate_initial_clarification

Browse source 
Clarify `set_initial_value()`
This commit is contained in:
Thaddeus Crews 2025-06-02 18:51:39 -05:00
commit 67d5d4b790
No known key found for this signature in database
GPG key ID: 8C6E5FEB5FC03CCC
1 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/classes/ProjectSettings.xml
View file

@ -205,7 +205,20 @@
<param index="0" name="name" type="String" />
<param index="1" name="value" type="Variant" />
<description>
Sets the specified setting's initial value. This is the value the setting reverts to.
Sets the specified setting's initial value. This is the value the setting reverts to. The setting should already exist before calling this method. Note that project settings equal to their default value are not saved, so your code needs to account for that.
[codeblock]
extends EditorPlugin
const SETTING_NAME = "addons/my_setting"
const SETTING_DEFAULT = 10.0
func _enter_tree():
if not ProjectSettings.has_setting(SETTING_NAME):
ProjectSettings.set_setting(SETTING_NAME, SETTING_DEFAULT)
ProjectSettings.set_initial_value(SETTING_NAME, SETTING_DEFAULT)
[/codeblock]
If you have a project setting defined by an [EditorPlugin], but want to use it in a running project, you will need a similar code at runtime.
</description>
</method>
<method name="set_order">