Add info about set_deferred for setting CollisionShape3D disabled pro…

…perty
godotengine · Feb 9, 2025 · b76b949 · b76b949
1 parent f0f5319
commit b76b949
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml
@@ -14,7 +14,7 @@
 			Collision build mode. Use one of the [enum BuildMode] constants.
 		</member>
 		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled">
-			If [code]true[/code], no collisions will be detected.
+			If [code]true[/code], no collisions will be detected. This property should be changed with [method Object.set_deferred].
 		</member>
 		<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">
 			If [code]true[/code], only edges that face up, relative to [CollisionPolygon2D]'s rotation, will collide with other objects.

diff --git a/doc/classes/CollisionPolygon3D.xml b/doc/classes/CollisionPolygon3D.xml
@@ -21,7 +21,7 @@
 			Length that the resulting collision extends in either direction perpendicular to its 2D polygon.
 		</member>
 		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled">
-			If [code]true[/code], no collision will be produced.
+			If [code]true[/code], no collision will be produced. This property should be changed with [method Object.set_deferred].
 		</member>
 		<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
 			The collision margin for the generated [Shape3D]. See [member Shape3D.margin] for more details.

diff --git a/doc/classes/CollisionShape3D.xml b/doc/classes/CollisionShape3D.xml
@@ -37,7 +37,7 @@
 			If [code]true[/code], when the shape is displayed, it will show a solid fill color in addition to its wireframe.
 		</member>
 		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled">
-			A disabled collision shape has no effect in the world.
+			A disabled collision shape has no effect in the world. This property should be changed with [method Object.set_deferred].
 		</member>
 		<member name="shape" type="Shape3D" setter="set_shape" getter="get_shape">
 			The actual shape owned by this collision shape.