mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
48 lines
1.7 KiB
ReStructuredText
48 lines
1.7 KiB
ReStructuredText
|
:github_url: hide
|
||
|
|
|
||
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
||
|
|
.. DO NOT EDIT THIS FILE, but the CircleShape2D.xml source instead.
|
||
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||
|
|
|
||
|
|
.. _class_CircleShape2D:
|
||
|
|
|
||
|
|
CircleShape2D
|
||
|
|
=============
|
||
|
|
|
||
|
|
**Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
Circular shape for 2D collisions.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
|
||
|
|
|
||
|
|
Properties
|
||
|
|
----------
|
||
|
|
|
||
|
|
+---------------------------+----------------------------------------------------+----------+
|
||
|
|
| :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` | ``10.0`` |
|
||
|
|
+---------------------------+----------------------------------------------------+----------+
|
||
|
|
|
||
|
|
Property Descriptions
|
||
|
|
---------------------
|
||
|
|
|
||
|
|
.. _class_CircleShape2D_property_radius:
|
||
|
|
|
||
|
|
- :ref:`float<class_float>` **radius**
|
||
|
|
|
||
|
|
+-----------+-------------------+
|
||
|
|
| *Default* | ``10.0`` |
|
||
|
|
+-----------+-------------------+
|
||
|
|
| *Setter* | set_radius(value) |
|
||
|
|
+-----------+-------------------+
|
||
|
|
| *Getter* | get_radius() |
|
||
|
|
+-----------+-------------------+
|
||
|
|
|
||
|
|
The circle's radius.
|
||
|
|
|
||
|
|
.. |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.)`
|