| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the WorldBoundaryShape2D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_WorldBoundaryShape2D:
- WorldBoundaryShape2D
- ====================
- **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- World boundary shape for 2D collisions.
- Description
- -----------
- World boundary shape for 2D collisions. It works like a 2D plane and will not allow any physics body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
- Properties
- ----------
- +-------------------------------+---------------------------------------------------------------+--------------------+
- | :ref:`float<class_float>` | :ref:`distance<class_WorldBoundaryShape2D_property_distance>` | ``0.0`` |
- +-------------------------------+---------------------------------------------------------------+--------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`normal<class_WorldBoundaryShape2D_property_normal>` | ``Vector2(0, -1)`` |
- +-------------------------------+---------------------------------------------------------------+--------------------+
- Property Descriptions
- ---------------------
- .. _class_WorldBoundaryShape2D_property_distance:
- - :ref:`float<class_float>` **distance**
- +-----------+---------------------+
- | *Default* | ``0.0`` |
- +-----------+---------------------+
- | *Setter* | set_distance(value) |
- +-----------+---------------------+
- | *Getter* | get_distance() |
- +-----------+---------------------+
- The line's distance from the origin.
- ----
- .. _class_WorldBoundaryShape2D_property_normal:
- - :ref:`Vector2<class_Vector2>` **normal**
- +-----------+--------------------+
- | *Default* | ``Vector2(0, -1)`` |
- +-----------+--------------------+
- | *Setter* | set_normal(value) |
- +-----------+--------------------+
- | *Getter* | get_normal() |
- +-----------+--------------------+
- The line's normal. Defaults to ``Vector2.UP``.
- .. |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.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
