2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-03-31 00:22:57 +08:00
<class name= "PhysicsShapeQueryParameters3D" inherits= "Reference" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2019-12-09 22:16:28 +08:00
Parameters to be sent to a 3D shape physics query.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2020-03-31 00:22:57 +08:00
This class contains the shape and other parameters for 3D intersection/collision queries. See also [PhysicsShapeQueryResult3D].
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
2018-01-12 06:38:35 +08:00
<members >
2019-06-29 18:38:01 +08:00
<member name= "collide_with_areas" type= "bool" setter= "set_collide_with_areas" getter= "is_collide_with_areas_enabled" default= "false" >
2020-03-31 00:22:57 +08:00
If [code]true[/code], the query will take [Area3D]s into account.
2018-08-30 04:25:11 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "collide_with_bodies" type= "bool" setter= "set_collide_with_bodies" getter= "is_collide_with_bodies_enabled" default= "true" >
2020-03-31 00:22:57 +08:00
If [code]true[/code], the query will take [PhysicsBody3D]s into account.
2018-08-30 04:25:11 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "collision_mask" type= "int" setter= "set_collision_mask" getter= "get_collision_mask" default= "2147483647" >
2019-12-09 22:16:28 +08:00
The physics layer(s) the query will take into account (as a bitmask).
2018-01-12 06:38:35 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "exclude" type= "Array" setter= "set_exclude" getter= "get_exclude" default= "[ ]" >
2019-12-09 22:16:28 +08:00
The list of objects or object [RID]s that will be excluded from collisions.
2018-01-12 06:38:35 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "margin" type= "float" setter= "set_margin" getter= "get_margin" default= "0.0" >
2019-12-09 22:16:28 +08:00
The collision margin for the shape.
2018-01-12 06:38:35 +08:00
</member>
2020-01-28 03:04:16 +08:00
<member name= "shape" type= "Resource" setter= "set_shape" getter= "get_shape" >
The [Shape3D] that will be used for collision/intersection queries. This stores the actual reference which avoids the shape to be released while being used for queries, so always prefer using this over [member shape_rid].
</member>
2018-01-12 06:38:35 +08:00
<member name= "shape_rid" type= "RID" setter= "set_shape_rid" getter= "get_shape_rid" >
2020-01-28 03:04:16 +08:00
The queried shape's [RID] that will be used for collision/intersection queries. Use this over [member shape] if you want to optimize for performance using the Servers API:
[codeblock]
var shape_rid = PhysicsServer3D.shape_create(PhysicsServer3D.SHAPE_SPHERE)
var radius = 2.0
PhysicsServer3D.shape_set_data(shape_rid, radius)
var params = PhysicsShapeQueryParameters3D.new()
params.shape_rid = shape_rid
# Execute physics queries here...
# Release the shape when done with physics queries.
PhysicsServer3D.free_rid(shape_rid)
[/codeblock]
2018-01-12 06:38:35 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "transform" type= "Transform" setter= "set_transform" getter= "get_transform" default= "Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )" >
2019-12-09 22:16:28 +08:00
The queried shape's transform matrix.
2018-01-12 06:38:35 +08:00
</member>
</members>
2017-09-13 04:42:36 +08:00
<constants >
</constants>
</class>