godot-docs/classes/class_prismmesh.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PrismMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_PrismMesh:

PrismMesh
=========

**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Class representing a prism-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.

Properties
----------

+-------------------------------+--------------------------------------------------------------------+--------------------+
| :ref:`float<class_float>`     | :ref:`left_to_right<class_PrismMesh_property_left_to_right>`       | 0.5                |
+-------------------------------+--------------------------------------------------------------------+--------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_PrismMesh_property_size>`                         | Vector3( 2, 2, 2 ) |
+-------------------------------+--------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>`         | :ref:`subdivide_depth<class_PrismMesh_property_subdivide_depth>`   | 0                  |
+-------------------------------+--------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>`         | :ref:`subdivide_height<class_PrismMesh_property_subdivide_height>` | 0                  |
+-------------------------------+--------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>`         | :ref:`subdivide_width<class_PrismMesh_property_subdivide_width>`   | 0                  |
+-------------------------------+--------------------------------------------------------------------+--------------------+

Description
-----------

Class representing a prism-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.

Property Descriptions
---------------------

.. _class_PrismMesh_property_left_to_right:

- :ref:`float<class_float>` **left_to_right**

+-----------+--------------------------+
| *Default* | 0.5                      |
+-----------+--------------------------+
| *Setter*  | set_left_to_right(value) |
+-----------+--------------------------+
| *Getter*  | get_left_to_right()      |
+-----------+--------------------------+

Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge.

.. _class_PrismMesh_property_size:

- :ref:`Vector3<class_Vector3>` **size**

+-----------+--------------------+
| *Default* | Vector3( 2, 2, 2 ) |
+-----------+--------------------+
| *Setter*  | set_size(value)    |
+-----------+--------------------+
| *Getter*  | get_size()         |
+-----------+--------------------+

Size of the prism.

.. _class_PrismMesh_property_subdivide_depth:

- :ref:`int<class_int>` **subdivide_depth**

+-----------+----------------------------+
| *Default* | 0                          |
+-----------+----------------------------+
| *Setter*  | set_subdivide_depth(value) |
+-----------+----------------------------+
| *Getter*  | get_subdivide_depth()      |
+-----------+----------------------------+

Number of added edge loops along the Z axis.

.. _class_PrismMesh_property_subdivide_height:

- :ref:`int<class_int>` **subdivide_height**

+-----------+-----------------------------+
| *Default* | 0                           |
+-----------+-----------------------------+
| *Setter*  | set_subdivide_height(value) |
+-----------+-----------------------------+
| *Getter*  | get_subdivide_height()      |
+-----------+-----------------------------+

Number of added edge loops along the Y axis.

.. _class_PrismMesh_property_subdivide_width:

- :ref:`int<class_int>` **subdivide_width**

+-----------+----------------------------+
| *Default* | 0                          |
+-----------+----------------------------+
| *Setter*  | set_subdivide_width(value) |
+-----------+----------------------------+
| *Getter*  | get_subdivide_width()      |
+-----------+----------------------------+

Number of added edge loops along the X axis.