mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
105 lines
4.4 KiB
ReStructuredText
105 lines
4.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CollisionPolygon.xml.
|
|
|
|
.. _class_CollisionPolygon:
|
|
|
|
CollisionPolygon
|
|
================
|
|
|
|
**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Editor-only class for defining a collision polygon in 3D space.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at run-time. Creates a :ref:`Shape<class_Shape>` for gameplay. Properties modified during gameplay will have no effect.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
|
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_property_depth>` | ``1.0`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_property_disabled>` | ``false`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
|
| :ref:`float<class_float>` | :ref:`margin<class_CollisionPolygon_property_margin>` | ``0.04`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
|
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>` | ``PoolVector2Array( )`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CollisionPolygon_property_depth:
|
|
|
|
- :ref:`float<class_float>` **depth**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+------------------+
|
|
| *Setter* | set_depth(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_depth() |
|
|
+-----------+------------------+
|
|
|
|
Length that the resulting collision extends in either direction perpendicular to its polygon.
|
|
|
|
----
|
|
|
|
.. _class_CollisionPolygon_property_disabled:
|
|
|
|
- :ref:`bool<class_bool>` **disabled**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_disabled(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | is_disabled() |
|
|
+-----------+---------------------+
|
|
|
|
If ``true``, no collision will be produced.
|
|
|
|
----
|
|
|
|
.. _class_CollisionPolygon_property_margin:
|
|
|
|
- :ref:`float<class_float>` **margin**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``0.04`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_margin(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_margin() |
|
|
+-----------+-------------------+
|
|
|
|
The collision margin for the generated :ref:`Shape<class_Shape>`. See :ref:`Shape.margin<class_Shape_property_margin>` for more details.
|
|
|
|
----
|
|
|
|
.. _class_CollisionPolygon_property_polygon:
|
|
|
|
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
|
|
|
+-----------+--------------------------+
|
|
| *Default* | ``PoolVector2Array( )`` |
|
|
+-----------+--------------------------+
|
|
| *Setter* | set_polygon(value) |
|
|
+-----------+--------------------------+
|
|
| *Getter* | get_polygon() |
|
|
+-----------+--------------------------+
|
|
|
|
Array of vertices which define the polygon.
|
|
|
|
\ **Note:** The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the ``polygon`` member.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|