:github_url: hide

.. DO NOT EDIT THIS FILE!!!

.. Generated automatically from Godot engine sources.
.. Generator:
https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source:
https://github.com/godotengine/godot/tree/master/doc/classes/ArrayMesh.xml.

.. _class_ArrayMesh:

ArrayMesh
=========

**Inherits:** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>`

**<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

:ref:`Mesh<class_Mesh>` type that provides utility for constructing a surface from

arrays.

.. rst-class:: classref-introduction-group

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

The **ArrayMesh** is used to construct a :ref:`Mesh<class_Mesh>` by specifying the

attributes as arrays.

The most basic example is the creation of a single triangle:

.. tabs::

.. code-tab:: gdscript

var vertices = PackedVector3Array()

vertices.push_back(Vector3(0, 1, 0))
vertices.push_back(Vector3(1, 0, 0))
vertices.push_back(Vector3(0, 0, 1))

# Initialize the ArrayMesh.

var arr_mesh = ArrayMesh.new()
var arrays = []
arrays.resize(Mesh.ARRAY_MAX)
arrays[Mesh.ARRAY_VERTEX] = vertices

# Create the Mesh.

arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays)
var m = MeshInstance3D.new()
m.mesh = arr_mesh

.. code-tab:: csharp

var vertices = new Vector3[]

{
new Vector3(0, 1, 0),
new Vector3(1, 0, 0),
new Vector3(0, 0, 1),
};
 // Initialize the ArrayMesh.
var arrMesh = new ArrayMesh();
var arrays = new Godot.Collections.Array();
arrays.Resize((int)Mesh.ArrayType.Max);
arrays[(int)Mesh.ArrayType.Vertex] = vertices;

// Create the Mesh.

arrMesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, arrays);
var m = new MeshInstance3D();
m.Mesh = arrMesh;

The :ref:`MeshInstance3D<class_MeshInstance3D>` is ready to be added to

the :ref:`SceneTree<class_SceneTree>` to be shown.

See
also :ref:`ImmediateMesh<class_ImmediateMesh>`, :ref:`MeshDataTool<class_MeshDataTo
ol>` and :ref:`SurfaceTool<class_SurfaceTool>` for procedural geometry generation.

\ **Note:** Godot uses clockwise `winding order <https://learnopengl.com/Advanced-

OpenGL/Face-culling>`__ for front faces of triangle primitive modes.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`Procedural geometry using the ArrayMesh

<../tutorials/3d/procedural_geometry/arraymesh>`

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
:widths: auto

+-------------------------------------------------
+--------------------------------------------------------------------
+----------------------------+
| :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>`
| :ref:`blend_shape_mode<class_ArrayMesh_property_blend_shape_mode>` | ``1``
|
+-------------------------------------------------
+--------------------------------------------------------------------
+----------------------------+
| :ref:`AABB<class_AABB>`
| :ref:`custom_aabb<class_ArrayMesh_property_custom_aabb>` | ``AABB(0, 0,
0, 0, 0, 0)`` |
+-------------------------------------------------
+--------------------------------------------------------------------
+----------------------------+
| :ref:`ArrayMesh<class_ArrayMesh>`
| :ref:`shadow_mesh<class_ArrayMesh_property_shadow_mesh>` |
|
+-------------------------------------------------
+--------------------------------------------------------------------
+----------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
:widths: auto

+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`add_blend_shape<class_ArrayMesh_method_add_blend_shape>`\ (\
name\: :ref:`StringName<class_StringName>`\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`\
(\ primitive\: :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`,
arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>`\
[:ref:`Array<class_Array>`\] = [], lods\: :ref:`Dictionary<class_Dictionary>` = {},
flags\: |bitfield|\[:ref:`ArrayFormat<enum_Mesh_ArrayFormat>`\] = 0\ ) |
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`clear_blend_shapes<class_ArrayMesh_method_clear_blend_shapes>`\ (\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`clear_surfaces<class_ArrayMesh_method_clear_surfaces>`\ (\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`int<class_int>`
| :ref:`get_blend_shape_count<class_ArrayMesh_method_get_blend_shape_count>`\ (\ )
|const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`StringName<class_StringName>`
| :ref:`get_blend_shape_name<class_ArrayMesh_method_get_blend_shape_name>`\ (\
index\: :ref:`int<class_int>`\ ) |const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>`
| :ref:`lightmap_unwrap<class_ArrayMesh_method_lightmap_unwrap>`\ (\
transform\: :ref:`Transform3D<class_Transform3D>`,
texel_size\: :ref:`float<class_float>`\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`regen_normal_maps<class_ArrayMesh_method_regen_normal_maps>`\ (\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`set_blend_shape_name<class_ArrayMesh_method_set_blend_shape_name>`\ (\
index\: :ref:`int<class_int>`, name\: :ref:`StringName<class_StringName>`\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`int<class_int>`
| :ref:`surface_find_by_name<class_ArrayMesh_method_surface_find_by_name>`\ (\
name\: :ref:`String<class_String>`\ ) |const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`int<class_int>`
| :ref:`surface_get_array_index_len<class_ArrayMesh_method_surface_get_array_index_
len>`\ (\ surf_idx\: :ref:`int<class_int>`\ ) |const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`int<class_int>`
| :ref:`surface_get_array_len<class_ArrayMesh_method_surface_get_array_len>`\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |bitfield|\[:ref:`ArrayFormat<enum_Mesh_ArrayFormat>`\]
| :ref:`surface_get_format<class_ArrayMesh_method_surface_get_format>`\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`String<class_String>`
| :ref:`surface_get_name<class_ArrayMesh_method_surface_get_name>`\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`
| :ref:`surface_get_primitive_type<class_ArrayMesh_method_surface_get_primitive_typ
e>`\ (\ surf_idx\: :ref:`int<class_int>`\ ) |const|
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`surface_set_name<class_ArrayMesh_method_surface_set_name>`\ (\
surf_idx\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
 | |void|
| :ref:`surface_update_attribute_region<class_ArrayMesh_method_surface_update_attri
bute_region>`\ (\ surf_idx\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`,
data\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`surface_update_skin_region<class_ArrayMesh_method_surface_update_skin_regio
n>`\ (\ surf_idx\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`,
data\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+
| |void|
| :ref:`surface_update_vertex_region<class_ArrayMesh_method_surface_update_vertex_r
egion>`\ (\ surf_idx\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`,
data\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
|
+---------------------------------------------------------
+----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
--------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

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

.. _class_ArrayMesh_property_blend_shape_mode:

.. rst-class:: classref-property

:ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` **blend_shape_mode** = ``1``

.. rst-class:: classref-property-setget

- |void| **set_blend_shape_mode**\ (\
value\: :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>`\ )
- :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` **get_blend_shape_mode**\ (\ )

Sets the blend shape mode to one

of :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>`.

.. rst-class:: classref-item-separator
----

.. _class_ArrayMesh_property_custom_aabb:

.. rst-class:: classref-property

:ref:`AABB<class_AABB>` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)``

.. rst-class:: classref-property-setget

- |void| **set_custom_aabb**\ (\ value\: :ref:`AABB<class_AABB>`\ )

- :ref:`AABB<class_AABB>` **get_custom_aabb**\ (\ )

Overrides the :ref:`AABB<class_AABB>` with one defined by user for use with frustum
culling. Especially useful to avoid unexpected culling when using a shader to
offset vertices.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_property_shadow_mesh:

.. rst-class:: classref-property

:ref:`ArrayMesh<class_ArrayMesh>` **shadow_mesh**

.. rst-class:: classref-property-setget

- |void| **set_shadow_mesh**\ (\ value\: :ref:`ArrayMesh<class_ArrayMesh>`\ )

- :ref:`ArrayMesh<class_ArrayMesh>` **get_shadow_mesh**\ (\ )

An optional mesh which is used for rendering shadows and can be used for the depth
prepass. Can be used to increase performance of shadow rendering by using a mesh
that only contains vertex position data (without normals, UVs, colors, etc.).

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_ArrayMesh_method_add_blend_shape:

.. rst-class:: classref-method

|void| **add_blend_shape**\ (\ name\: :ref:`StringName<class_StringName>`\ )

Adds name for a blend shape that will be added

with :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`
. Must be called before surface is added.

.. rst-class:: classref-item-separator

----
.. _class_ArrayMesh_method_add_surface_from_arrays:

.. rst-class:: classref-method

|void| **add_surface_from_arrays**\ (\
primitive\: :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`,
arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>`\
[:ref:`Array<class_Array>`\] = [], lods\: :ref:`Dictionary<class_Dictionary>` = {},
flags\: |bitfield|\[:ref:`ArrayFormat<enum_Mesh_ArrayFormat>`\] = 0\ )

Creates a new
surface. :ref:`Mesh.get_surface_count<class_Mesh_method_get_surface_count>` will
become the ``surf_idx`` for this new surface.

Surfaces are created to be rendered using a ``primitive``, which may be any of the
values defined in :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`.

The ``arrays`` argument is an array of arrays. Each of

the :ref:`Mesh.ARRAY_MAX<class_Mesh_constant_ARRAY_MAX>` elements contains an array
with some of the mesh data for this surface as described by the corresponding
member of :ref:`ArrayType<enum_Mesh_ArrayType>` or ``null`` if it is not used by
the surface. For example, ``arrays[0]`` is the array of vertices. That first vertex
sub-array is always required; the others are optional. Adding an index array puts
this surface into "index mode" where the vertex and other arrays become the sources
of data and the index array defines the vertex order. All sub-arrays must have the
same length as the vertex array (or be an exact multiple of the vertex array's
length, when multiple elements of a sub-array correspond to a single vertex) or be
empty, except for :ref:`Mesh.ARRAY_INDEX<class_Mesh_constant_ARRAY_INDEX>` if it is
used.

The ``blend_shapes`` argument is an array of vertex data for each blend shape. Each
element is an array of the same structure as ``arrays``,
but :ref:`Mesh.ARRAY_VERTEX<class_Mesh_constant_ARRAY_VERTEX>`, :ref:`Mesh.ARRAY_NO
RMAL<class_Mesh_constant_ARRAY_NORMAL>`,
and :ref:`Mesh.ARRAY_TANGENT<class_Mesh_constant_ARRAY_TANGENT>` are set if and
only if they are set in ``arrays`` and all other entries are ``null``.

The ``lods`` argument is a dictionary with :ref:`float<class_float>` keys

and :ref:`PackedInt32Array<class_PackedInt32Array>` values. Each entry in the
dictionary represents an LOD level of the surface, where the value is
the :ref:`Mesh.ARRAY_INDEX<class_Mesh_constant_ARRAY_INDEX>` array to use for the
LOD level and the key is roughly proportional to the distance at which the LOD
stats being used. I.e., increasing the key of an LOD also increases the distance
that the objects has to be from the camera before the LOD is used.

The ``flags`` argument is the bitwise or of, as required: One value

of :ref:`ArrayCustomFormat<enum_Mesh_ArrayCustomFormat>` left shifted by
``ARRAY_FORMAT_CUSTOMn_SHIFT`` for each custom channel in
use, :ref:`Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE<class_Mesh_constant_ARRAY_FLAG_USE_DY
NAMIC_UPDATE>`, :ref:`Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS<class_Mesh_constant_ARRAY_
FLAG_USE_8_BONE_WEIGHTS>`,
or :ref:`Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY<class_Mesh_constant_ARRAY_FLAG_USE
S_EMPTY_VERTEX_ARRAY>`.

\ **Note:** When using indices, it is recommended to only use points, lines, or

triangles.

.. rst-class:: classref-item-separator
----

.. _class_ArrayMesh_method_clear_blend_shapes:

.. rst-class:: classref-method

|void| **clear_blend_shapes**\ (\ )

Removes all blend shapes from this **ArrayMesh**.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_clear_surfaces:

.. rst-class:: classref-method

|void| **clear_surfaces**\ (\ )

Removes all surfaces from this **ArrayMesh**.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_get_blend_shape_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_blend_shape_count**\ (\ ) |const|

Returns the number of blend shapes that the **ArrayMesh** holds.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_get_blend_shape_name:

.. rst-class:: classref-method

:ref:`StringName<class_StringName>` **get_blend_shape_name**\ (\
index\: :ref:`int<class_int>`\ ) |const|

Returns the name of the blend shape at this index.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_lightmap_unwrap:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **lightmap_unwrap**\ (\
transform\: :ref:`Transform3D<class_Transform3D>`,
texel_size\: :ref:`float<class_float>`\ )
Performs a UV unwrap on the **ArrayMesh** to prepare the mesh for lightmapping.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_regen_normal_maps:

.. rst-class:: classref-method

|void| **regen_normal_maps**\ (\ )

Regenerates tangents for each of the **ArrayMesh**'s surfaces.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_set_blend_shape_name:

.. rst-class:: classref-method

|void| **set_blend_shape_name**\ (\ index\: :ref:`int<class_int>`,

name\: :ref:`StringName<class_StringName>`\ )

Sets the name of the blend shape at this index.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_find_by_name:

.. rst-class:: classref-method

:ref:`int<class_int>` **surface_find_by_name**\ (\
name\: :ref:`String<class_String>`\ ) |const|

Returns the index of the first surface with this name held within this
**ArrayMesh**. If none are found, -1 is returned.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_get_array_index_len:

.. rst-class:: classref-method

:ref:`int<class_int>` **surface_get_array_index_len**\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|

Returns the length in indices of the index array in the requested surface
(see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`
).

.. rst-class:: classref-item-separator
----

.. _class_ArrayMesh_method_surface_get_array_len:

.. rst-class:: classref-method

:ref:`int<class_int>` **surface_get_array_len**\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|

Returns the length in vertices of the vertex array in the requested surface
(see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`
).

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_get_format:

.. rst-class:: classref-method

|bitfield|\[:ref:`ArrayFormat<enum_Mesh_ArrayFormat>`\] **surface_get_format**\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|

Returns the format mask of the requested surface

(see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`
).

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_get_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **surface_get_name**\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|

Gets the name assigned to this surface.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_get_primitive_type:

.. rst-class:: classref-method

:ref:`PrimitiveType<enum_Mesh_PrimitiveType>` **surface_get_primitive_type**\ (\
surf_idx\: :ref:`int<class_int>`\ ) |const|

Returns the primitive type of the requested surface

(see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`
).

.. rst-class:: classref-item-separator

----
.. _class_ArrayMesh_method_surface_set_name:

.. rst-class:: classref-method

|void| **surface_set_name**\ (\ surf_idx\: :ref:`int<class_int>`,

name\: :ref:`String<class_String>`\ )

Sets a name for a given surface.

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_update_attribute_region:

.. rst-class:: classref-method

|void| **surface_update_attribute_region**\ (\ surf_idx\: :ref:`int<class_int>`,

offset\: :ref:`int<class_int>`,
data\: :ref:`PackedByteArray<class_PackedByteArray>`\ )

.. container:: contribute

There is currently no description for this method. Please help us

by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_update_skin_region:

.. rst-class:: classref-method

|void| **surface_update_skin_region**\ (\ surf_idx\: :ref:`int<class_int>`,

offset\: :ref:`int<class_int>`,
data\: :ref:`PackedByteArray<class_PackedByteArray>`\ )

.. container:: contribute

There is currently no description for this method. Please help us

by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_ArrayMesh_method_surface_update_vertex_region:

.. rst-class:: classref-method

|void| **surface_update_vertex_region**\ (\ surf_idx\: :ref:`int<class_int>`,

offset\: :ref:`int<class_int>`,
data\: :ref:`PackedByteArray<class_PackedByteArray>`\ )

.. container:: contribute

There is currently no description for this method. Please help us

by :ref:`contributing one <doc_updating_the_class_reference>`!

.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a
bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`