From 8d6f80d3677a31aee13e7f531b46ada0b6ef8bf3 Mon Sep 17 00:00:00 2001
From: "Pedro J. Estébanez" <pedrojrulez@gmail.com>
Date: Tue, 26 Oct 2021 21:12:25 +0200
Subject: Add property value pinning

---
 doc/classes/EditorProperty.xml | 10 +++++++++-
 doc/classes/PackedScene.xml    |  4 ++++
 doc/classes/SceneState.xml     |  4 ++++
 3 files changed, 17 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml
index 5f342e6dc2..5ae034c3ba 100644
--- a/doc/classes/EditorProperty.xml
+++ b/doc/classes/EditorProperty.xml
@@ -110,7 +110,7 @@
 		</signal>
 		<signal name="property_checked">
 			<argument index="0" name="property" type="StringName" />
-			<argument index="1" name="bool" type="String" />
+			<argument index="1" name="checked" type="bool" />
 			<description>
 				Emitted when a property was checked. Used internally.
 			</description>
@@ -134,6 +134,14 @@
 				Emit it if you want to key a property with a single value.
 			</description>
 		</signal>
+		<signal name="property_pinned">
+			<argument index="0" name="property" type="StringName" />
+			<argument index="1" name="pinned" type="bool" />
+			<description>
+				Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value.
+				The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instancing chain, a script or a builtin class.
+			</description>
+		</signal>
 		<signal name="resource_selected">
 			<argument index="0" name="path" type="String" />
 			<argument index="1" name="resource" type="Resource" />
diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml
index 618123855f..d0579c6f6f 100644
--- a/doc/classes/PackedScene.xml
+++ b/doc/classes/PackedScene.xml
@@ -121,5 +121,9 @@
 			If passed to [method instantiate], provides local scene resources to the local scene. Only the main scene should receive the main edit state.
 			[b]Note:[/b] Only available in editor builds.
 		</constant>
+		<constant name="GEN_EDIT_STATE_MAIN_INHERITED" value="3" enum="GenEditState">
+			It's similar to [constant GEN_EDIT_STATE_MAIN], but for the case where the scene is being instantiated to be the base of another one.
+			[b]Note:[/b] Only available in editor builds.
+		</constant>
 	</constants>
 </class>
diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml
index 1c3bac9270..9a22b24825 100644
--- a/doc/classes/SceneState.xml
+++ b/doc/classes/SceneState.xml
@@ -168,5 +168,9 @@
 			If passed to [method PackedScene.instantiate], provides local scene resources to the local scene. Only the main scene should receive the main edit state.
 			[b]Note:[/b] Only available in editor builds.
 		</constant>
+		<constant name="GEN_EDIT_STATE_MAIN_INHERITED" value="3" enum="GenEditState">
+			If passed to [method PackedScene.instantiate], it's similar to [constant GEN_EDIT_STATE_MAIN], but for the case where the scene is being instantiated to be the base of another one.
+			[b]Note:[/b] Only available in editor builds.
+		</constant>
 	</constants>
 </class>
-- 
cgit v1.2.3