Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-10-23 13:41:43 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #94059 from ayanchavand/fix-exclude-docs

Browse Source 
Clarify that some exclude properties of physics query parameters are copied
This commit is contained in:
Rémi Verschelde 2024-07-11 00:27:14 +02:00
commit 73422df05e
No known key found for this signature in database
GPG Key ID: C3336907360768E1
6 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/PhysicsPointQueryParameters2D.xml
View File

@ -24,6 +24,7 @@
</member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]">
The list of object [RID]s that will be excluded from collisions. Use [method CollisionObject2D.get_rid] to get the [RID] associated with a [CollisionObject2D]-derived node.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.
</member>
<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">
The position being queried for, in global coordinates.

1
doc/classes/PhysicsPointQueryParameters3D.xml
View File

@ -20,6 +20,7 @@
</member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]">
The list of object [RID]s that will be excluded from collisions. Use [method CollisionObject3D.get_rid] to get the [RID] associated with a [CollisionObject3D]-derived node.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.
</member>
<member name="position" type="Vector3" setter="set_position" getter="get_position" default="Vector3(0, 0, 0)">
The position being queried for, in global coordinates.

1
doc/classes/PhysicsRayQueryParameters2D.xml
View File

@ -36,6 +36,7 @@
</member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]">
The list of object [RID]s that will be excluded from collisions. Use [method CollisionObject2D.get_rid] to get the [RID] associated with a [CollisionObject2D]-derived node.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.
</member>
<member name="from" type="Vector2" setter="set_from" getter="get_from" default="Vector2(0, 0)">
The starting point of the ray being queried for, in global coordinates.

1
doc/classes/PhysicsRayQueryParameters3D.xml
View File

@ -36,6 +36,7 @@
</member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]">
The list of object [RID]s that will be excluded from collisions. Use [method CollisionObject3D.get_rid] to get the [RID] associated with a [CollisionObject3D]-derived node.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.
</member>
<member name="from" type="Vector3" setter="set_from" getter="get_from" default="Vector3(0, 0, 0)">
The starting point of the ray being queried for, in global coordinates.

1
doc/classes/PhysicsShapeQueryParameters2D.xml
View File

@ -20,6 +20,7 @@
</member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]">
The list of object [RID]s that will be excluded from collisions. Use [method CollisionObject2D.get_rid] to get the [RID] associated with a [CollisionObject2D]-derived node.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.
</member>
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">
The collision margin for the shape.

1
doc/classes/PhysicsShapeQueryParameters3D.xml
View File

@ -20,6 +20,7 @@
</member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]">
The list of object [RID]s that will be excluded from collisions. Use [method CollisionObject3D.get_rid] to get the [RID] associated with a [CollisionObject3D]-derived node.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.
</member>
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">
The collision margin for the shape.