| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- .. 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>`
- **Category:** Core
- Brief Description
- -----------------
- Node that represents collision shape data in 2D space.
- Member Functions
- ----------------
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Shape2D<class_shape2d>` | :ref:`get_shape<class_CollisionShape2D_get_shape>` **(** **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionShape2D_is_disabled>` **(** **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_one_way_collision_enabled<class_CollisionShape2D_is_one_way_collision_enabled>` **(** **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_disabled<class_CollisionShape2D_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_one_way_collision<class_CollisionShape2D_set_one_way_collision>` **(** :ref:`bool<class_bool>` enabled **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_shape<class_CollisionShape2D_set_shape>` **(** :ref:`Shape2D<class_shape2d>` shape **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`bool<class_bool>` **disabled** - A disabled collision shape has no effect in the world.
- - :ref:`bool<class_bool>` **one_way_collision** - Sets whether this collision shape should only detect collision on one side (top or bottom).
- - :ref:`Shape2D<class_shape2d>` **shape** - The actual shape owned by this collision shape.
- 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 give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape2D_get_shape>` to get the actual shape.
- Member Function Description
- ---------------------------
- .. _class_CollisionShape2D_get_shape:
- - :ref:`Shape2D<class_shape2d>` **get_shape** **(** **)** const
- .. _class_CollisionShape2D_is_disabled:
- - :ref:`bool<class_bool>` **is_disabled** **(** **)** const
- .. _class_CollisionShape2D_is_one_way_collision_enabled:
- - :ref:`bool<class_bool>` **is_one_way_collision_enabled** **(** **)** const
- .. _class_CollisionShape2D_set_disabled:
- - void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
- .. _class_CollisionShape2D_set_one_way_collision:
- - void **set_one_way_collision** **(** :ref:`bool<class_bool>` enabled **)**
- .. _class_CollisionShape2D_set_shape:
- - void **set_shape** **(** :ref:`Shape2D<class_shape2d>` shape **)**
|
