Clarify that some exclude properties of physics query parameters are copied

This commit is contained in:
ayanchavand 2024-07-08 10:34:25 +05:30
parent 42e5b3ac2d
commit 34e2159d34
6 changed files with 6 additions and 0 deletions

View File

@ -24,6 +24,7 @@
</member> </member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]"> <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. 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>
<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)"> <member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">
The position being queried for, in global coordinates. The position being queried for, in global coordinates.

View File

@ -20,6 +20,7 @@
</member> </member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]"> <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. 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>
<member name="position" type="Vector3" setter="set_position" getter="get_position" default="Vector3(0, 0, 0)"> <member name="position" type="Vector3" setter="set_position" getter="get_position" default="Vector3(0, 0, 0)">
The position being queried for, in global coordinates. The position being queried for, in global coordinates.

View File

@ -36,6 +36,7 @@
</member> </member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]"> <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. 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>
<member name="from" type="Vector2" setter="set_from" getter="get_from" default="Vector2(0, 0)"> <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. The starting point of the ray being queried for, in global coordinates.

View File

@ -36,6 +36,7 @@
</member> </member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]"> <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. 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>
<member name="from" type="Vector3" setter="set_from" getter="get_from" default="Vector3(0, 0, 0)"> <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. The starting point of the ray being queried for, in global coordinates.

View File

@ -20,6 +20,7 @@
</member> </member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]"> <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. 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>
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0"> <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">
The collision margin for the shape. The collision margin for the shape.

View File

@ -20,6 +20,7 @@
</member> </member>
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]"> <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. 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>
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0"> <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">
The collision margin for the shape. The collision margin for the shape.