| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the CollisionPolygon2D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_CollisionPolygon2D:
- CollisionPolygon2D
- ==================
- **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- **Category:** Core
- Brief Description
- -----------------
- Defines a 2D collision polygon.
- Properties
- ----------
- +-----------------------------------------------------+----------------------------------------------------------------------+
- | :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_build_mode>` |
- +-----------------------------------------------------+----------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_disabled>` |
- +-----------------------------------------------------+----------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_one_way_collision>` |
- +-----------------------------------------------------+----------------------------------------------------------------------+
- | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_polygon>` |
- +-----------------------------------------------------+----------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_CollisionPolygon2D_BuildMode:
- enum **BuildMode**:
- - **BUILD_SOLIDS** = **0** --- Collisions will include the polygon and its contained area.
- - **BUILD_SEGMENTS** = **1** --- Collisions will only include the polygon edges.
- Description
- -----------
- Provides a 2D collision polygon to a :ref:`CollisionObject2D<class_CollisionObject2D>` parent. Polygon can be drawn in the editor or specified by a list of vertices.
- Property Descriptions
- ---------------------
- .. _class_CollisionPolygon2D_build_mode:
- - :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` **build_mode**
- +----------+-----------------------+
- | *Setter* | set_build_mode(value) |
- +----------+-----------------------+
- | *Getter* | get_build_mode() |
- +----------+-----------------------+
- Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``.
- .. _class_CollisionPolygon2D_disabled:
- - :ref:`bool<class_bool>` **disabled**
- +----------+---------------------+
- | *Setter* | set_disabled(value) |
- +----------+---------------------+
- | *Getter* | is_disabled() |
- +----------+---------------------+
- If ``true`` no collisions will be detected.
- .. _class_CollisionPolygon2D_one_way_collision:
- - :ref:`bool<class_bool>` **one_way_collision**
- +----------+--------------------------------+
- | *Setter* | set_one_way_collision(value) |
- +----------+--------------------------------+
- | *Getter* | is_one_way_collision_enabled() |
- +----------+--------------------------------+
- If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
- .. _class_CollisionPolygon2D_polygon:
- - :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
- +----------+--------------------+
- | *Setter* | set_polygon(value) |
- +----------+--------------------+
- | *Getter* | get_polygon() |
- +----------+--------------------+
- The polygon's list of vertices. The final point will be connected to the first.
|
