mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
55 lines
1.7 KiB
ReStructuredText
55 lines
1.7 KiB
ReStructuredText
.. 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.
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_CollisionPolygon2D_build_mode:
|
|
|
|
- :ref:`BuildMode<enum_collisionpolygon2d_buildmode>` **build_mode** - Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``.
|
|
|
|
.. _class_CollisionPolygon2D_disabled:
|
|
|
|
- :ref:`bool<class_bool>` **disabled** - If ``true`` no collisions will be detected.
|
|
|
|
.. _class_CollisionPolygon2D_one_way_collision:
|
|
|
|
- :ref:`bool<class_bool>` **one_way_collision** - 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** - The polygon's list of vertices. The final point will be connected to the first.
|
|
|
|
|
|
Enums
|
|
-----
|
|
|
|
.. _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.
|
|
|