mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
54f2916cf1
godot/doc/classes/PhysicsRayQueryParameters2D.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

51 lines
3.1 KiB
XML
Raw Normal View History

Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 16:08:05 +08:00
<class name="PhysicsRayQueryParameters2D" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
<brief_description>
Overhaul the top sections of the class reference (Physics classes)
2023-04-29 04:59:03 +08:00
Provides parameters for [method PhysicsDirectSpaceState2D.intersect_ray].
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
</brief_description>
<description>
Overhaul the top sections of the class reference (Physics classes)
2023-04-29 04:59:03 +08:00
By changing various properties of this object, such as the ray position, you can configure the parameters for [method PhysicsDirectSpaceState2D.intersect_ray].
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
</description>
<tutorials>
</tutorials>
Add static methods to create RayQueryParameters
2022-06-11 05:37:04 +08:00
<methods>
<method name="create" qualifiers="static">
<return type="PhysicsRayQueryParameters2D" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="from" type="Vector2" />
<param index="1" name="to" type="Vector2" />
<param index="2" name="collision_mask" type="int" default="4294967295" />
Change Array arguments to TypedArray
2022-09-01 01:24:04 +08:00
<param index="3" name="exclude" type="RID[]" default="[]" />
Add static methods to create RayQueryParameters
2022-06-11 05:37:04 +08:00
<description>
Returns a new, pre-configured [PhysicsRayQueryParameters2D] object. Use it to quickly create query parameters using the most common options.
[codeblock]
var query = PhysicsRayQueryParameters2D.create(global_position, global_position + Vector2(0, 100))
var collision = get_world_2d().direct_space_state.intersect_ray(query)
[/codeblock]
</description>
</method>
</methods>
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
<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 [Area2D]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 [PhysicsBody2D]s into account.
</member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295">
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:43:07 +08:00
The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
</member>
Change Array arguments to TypedArray
2022-09-01 01:24:04 +08:00
<member name="exclude" type="RID[]" setter="set_exclude" getter="get_exclude" default="[]">
Update remaining physics exclude parameters to use TypedArray Also update the documentation to refer to the get_rid() method.
2022-11-24 01:32:30 +08:00
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.
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
</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.
</member>
Add raycast options to hit when starting inside / hit back faces Makes the results consistent for all shape types with options to set the desired behavior.
2021-11-11 06:57:11 +08:00
<member name="hit_from_inside" type="bool" setter="set_hit_from_inside" getter="is_hit_from_inside_enabled" default="false">
If [code]true[/code], the query will detect a hit when starting inside shapes. In this case the collision normal will be [code]Vector2(0, 0)[/code]. Does not affect concave polygon shapes.
</member>
Use parameter classes instead of arguments for all physics queries Same as what is already done for shape queries, applied to point and ray queries. Easier to document and more flexible to add more parameters. Also expose intersect_point method to script in 3D. Remove intersect_point_on_canvas in 2D, replaced with a parameter.
2021-11-02 09:00:58 +08:00
<member name="to" type="Vector2" setter="set_to" getter="get_to" default="Vector2(0, 0)">
The ending point of the ray being queried for, in global coordinates.
</member>
</members>
</class>
Reference in New Issue Copy Permalink