mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
102 lines
4.2 KiB
ReStructuredText
102 lines
4.2 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the CollisionShape2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_CollisionShape2D:
|
|
|
|
CollisionShape2D
|
|
================
|
|
|
|
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Node that represents collision shape data in 2D space.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D<class_Area2D>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_PhysicsBody2D>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject2D.shape_owner_get_shape<class_CollisionObject2D_method_shape_owner_get_shape>` to get the actual shape.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/physics/physics_introduction`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape2D_property_disabled>` | ``false`` |
|
|
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionShape2D_property_one_way_collision>` | ``false`` |
|
|
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionShape2D_property_one_way_collision_margin>` | ``1.0`` |
|
|
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_property_shape>` | |
|
|
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CollisionShape2D_property_disabled:
|
|
|
|
- :ref:`bool<class_bool>` **disabled**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_disabled(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | is_disabled() |
|
|
+-----------+---------------------+
|
|
|
|
A disabled collision shape has no effect in the world.
|
|
|
|
----
|
|
|
|
.. _class_CollisionShape2D_property_one_way_collision:
|
|
|
|
- :ref:`bool<class_bool>` **one_way_collision**
|
|
|
|
+-----------+--------------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------------------+
|
|
| *Setter* | set_one_way_collision(value) |
|
|
+-----------+--------------------------------+
|
|
| *Getter* | is_one_way_collision_enabled() |
|
|
+-----------+--------------------------------+
|
|
|
|
Sets whether this collision shape should only detect collision on one side (top or bottom).
|
|
|
|
----
|
|
|
|
.. _class_CollisionShape2D_property_one_way_collision_margin:
|
|
|
|
- :ref:`float<class_float>` **one_way_collision_margin**
|
|
|
|
+-----------+-------------------------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+-------------------------------------+
|
|
| *Setter* | set_one_way_collision_margin(value) |
|
|
+-----------+-------------------------------------+
|
|
| *Getter* | get_one_way_collision_margin() |
|
|
+-----------+-------------------------------------+
|
|
|
|
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity.
|
|
|
|
----
|
|
|
|
.. _class_CollisionShape2D_property_shape:
|
|
|
|
- :ref:`Shape2D<class_Shape2D>` **shape**
|
|
|
|
+----------+------------------+
|
|
| *Setter* | set_shape(value) |
|
|
+----------+------------------+
|
|
| *Getter* | get_shape() |
|
|
+----------+------------------+
|
|
|
|
The actual shape owned by this collision shape.
|
|
|