mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
143 lines
7.1 KiB
ReStructuredText
143 lines
7.1 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the PhysicsTestMotionParameters2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_PhysicsTestMotionParameters2D:
|
|
|
|
PhysicsTestMotionParameters2D
|
|
=============================
|
|
|
|
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Parameters to be sent to a 2D body motion test.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This class contains parameters used in :ref:`PhysicsServer2D.body_test_motion<class_PhysicsServer2D_method_body_test_motion>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`collide_separation_ray<class_PhysicsTestMotionParameters2D_property_collide_separation_ray>` | ``false`` |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`exclude_bodies<class_PhysicsTestMotionParameters2D_property_exclude_bodies>` | ``[]`` |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`exclude_objects<class_PhysicsTestMotionParameters2D_property_exclude_objects>` | ``[]`` |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Transform2D<class_Transform2D>` | :ref:`from<class_PhysicsTestMotionParameters2D_property_from>` | ``Transform2D(1, 0, 0, 1, 0, 0)`` |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`margin<class_PhysicsTestMotionParameters2D_property_margin>` | ``0.08`` |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`motion<class_PhysicsTestMotionParameters2D_property_motion>` | ``Vector2(0, 0)`` |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PhysicsTestMotionParameters2D_property_collide_separation_ray:
|
|
|
|
- :ref:`bool<class_bool>` **collide_separation_ray**
|
|
|
|
+-----------+-------------------------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+-------------------------------------------+
|
|
| *Setter* | set_collide_separation_ray_enabled(value) |
|
|
+-----------+-------------------------------------------+
|
|
| *Getter* | is_collide_separation_ray_enabled() |
|
|
+-----------+-------------------------------------------+
|
|
|
|
If set to ``true``, shapes of type :ref:`PhysicsServer2D.SHAPE_SEPARATION_RAY<class_PhysicsServer2D_constant_SHAPE_SEPARATION_RAY>` are used to detect collisions and can stop the motion. Can be useful when snapping to the ground.
|
|
|
|
If set to ``false``, shapes of type :ref:`PhysicsServer2D.SHAPE_SEPARATION_RAY<class_PhysicsServer2D_constant_SHAPE_SEPARATION_RAY>` are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsTestMotionParameters2D_property_exclude_bodies:
|
|
|
|
- :ref:`Array<class_Array>` **exclude_bodies**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``[]`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_exclude_bodies(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | get_exclude_bodies() |
|
|
+-----------+---------------------------+
|
|
|
|
Optional array of body :ref:`RID<class_RID>` to exclude from collision.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsTestMotionParameters2D_property_exclude_objects:
|
|
|
|
- :ref:`Array<class_Array>` **exclude_objects**
|
|
|
|
+-----------+----------------------------+
|
|
| *Default* | ``[]`` |
|
|
+-----------+----------------------------+
|
|
| *Setter* | set_exclude_objects(value) |
|
|
+-----------+----------------------------+
|
|
| *Getter* | get_exclude_objects() |
|
|
+-----------+----------------------------+
|
|
|
|
Optional array of object unique instance ID to exclude from collision. See :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsTestMotionParameters2D_property_from:
|
|
|
|
- :ref:`Transform2D<class_Transform2D>` **from**
|
|
|
|
+-----------+-----------------------------------+
|
|
| *Default* | ``Transform2D(1, 0, 0, 1, 0, 0)`` |
|
|
+-----------+-----------------------------------+
|
|
| *Setter* | set_from(value) |
|
|
+-----------+-----------------------------------+
|
|
| *Getter* | get_from() |
|
|
+-----------+-----------------------------------+
|
|
|
|
Transform in global space where the motion should start. Usually set to :ref:`Node2D.global_transform<class_Node2D_property_global_transform>` for the current body's transform.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsTestMotionParameters2D_property_margin:
|
|
|
|
- :ref:`float<class_float>` **margin**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``0.08`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_margin(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_margin() |
|
|
+-----------+-------------------+
|
|
|
|
Increases the size of the shapes involved in the collision detection.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsTestMotionParameters2D_property_motion:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **motion**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``Vector2(0, 0)`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_motion(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_motion() |
|
|
+-----------+-------------------+
|
|
|
|
Motion vector to define the length and direction of the motion to test.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|