godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current upstream master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-09-23 11:01:36 +02:00
parent 5e952ae7d5
commit 0cc4b36524
467 changed files with 5484 additions and 2561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
classes/class_collisionshape2d.rst
View File

@@ -1,5 +1,6 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. 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:
@@ -13,7 +14,7 @@ CollisionShape2D
Brief Description
-----------------
Editor-only class for easy editing of shapes.
Node that represents collision shape data in 2D space.
Member Functions
----------------
@@ -35,14 +36,14 @@ Member Functions
Member Variables
----------------
- :ref:`bool<class_bool>` **disabled**
- :ref:`bool<class_bool>` **one_way_collision**
- :ref:`Shape2D<class_shape2d>` **shape**
- :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-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in :ref:`CollisionObject2D<class_collisionobject2d>`. This is not accessible from regular code.
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
---------------------------
@@ -51,8 +52,6 @@ Member Function Description
- :ref:`Shape2D<class_shape2d>` **get_shape** **(** **)** const
Return this shape's :ref:`Shape2D<class_shape2d>`.
.. _class_CollisionShape2D_is_disabled:
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
@@ -73,6 +72,4 @@ Return this shape's :ref:`Shape2D<class_shape2d>`.
- void **set_shape** **(** :ref:`Shape2D<class_shape2d>` shape **)**
Set this shape's :ref:`Shape2D<class_shape2d>`. This will not appear as a node, but can be directly edited as a property.