diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-11-05 21:52:39 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-05 21:52:39 +0100 |
| commit | 13aaa7312427e98661dba0183cbbee6bbc8f6542 (patch) | |
| tree | 5431544904e0ced5217295f750ecabd0d24ea950 /doc/classes/PhysicsRayQueryParameters3D.xml | |
| parent | c7fefe50daebe2f3ae568baaa888ddb3cddfe5e1 (diff) | |
| parent | acbd24ea842cb90ab49cd66d5dc7220e57c73f29 (diff) | |
Merge pull request #54573 from nekomatata/query-parameters
Diffstat (limited to 'doc/classes/PhysicsRayQueryParameters3D.xml')
| -rw-r--r-- | doc/classes/PhysicsRayQueryParameters3D.xml | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/classes/PhysicsRayQueryParameters3D.xml b/doc/classes/PhysicsRayQueryParameters3D.xml new file mode 100644 index 0000000000..dbd09e5128 --- /dev/null +++ b/doc/classes/PhysicsRayQueryParameters3D.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsRayQueryParameters3D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 3D ray physics query. + </brief_description> + <description> + This class contains the ray position and other parameters to be used for [method PhysicsDirectSpaceState3D.intersect_ray]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> + If [code]true[/code], the query will take [Area3D]s into account. + </member> + <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true"> + If [code]true[/code], the query will take [PhysicsBody3D]s into account. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295"> + The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + </member> + <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[]"> + The list of objects or object [RID]s that will be excluded from collisions. + </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. + </member> + <member name="to" type="Vector3" setter="set_to" getter="get_to" default="Vector3(0, 0, 0)"> + The ending point of the ray being queried for, in global coordinates. + </member> + </members> +</class> |