Files
godot-docs-l10n/classes/zh_Hans/class_packedint32array.rst
Rémi Verschelde c3f2364c10 Sync classref with 4.6 branch
Lots of translations invalidated (fuzzied) as we just synced Weblate.
2025-12-19 16:39:51 +01:00

509 lines
26 KiB
ReStructuredText

:github_url: hide
.. _class_PackedInt32Array:
PackedInt32Array
================
32 位整数紧缩数组。
.. rst-class:: classref-introduction-group
描述
----
专门设计用于存放 32 位整数值的数组。数据是紧密存放的,因此能够在数组较大时节省内存。
\ **注意:**\ 该类型存储的是 32 位有符号整数,也就是说它可以取区间 ``[-2^31, 2^31 - 1]`` 内的值,即 ``[-2147483648, 2147483647]``\ 。超过界限时会从另一端绕回。相比之下,\ :ref:`int<class_int>` 使用带符号的 64 位整数,可以容纳更大的值。紧密存放 64 位整数见 :ref:`PackedInt64Array<class_PackedInt64Array>`\ 。
\ **注意:**\ 紧缩数组始终通过引用传递。要获取可以独立于原始数组进行修改的数组副本,请使用 :ref:`duplicate()<class_PackedInt32Array_method_duplicate>`\ 。内置属性和方法\ *并非*\ 如此,它们返回的是紧缩数组的副本,对其进行修改\ *不会*\ 影响原值。更新此类内置属性请修改返回的数组,然后将其重新赋值给该属性。
.. note::
通过 C# 使用该 API 时会有显著不同,详见 :ref:`doc_c_sharp_differences`\ 。
.. rst-class:: classref-reftable-group
构造函数
--------
.. table::
:widths: auto
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`PackedInt32Array<class_PackedInt32Array_constructor_PackedInt32Array>`\ (\ ) |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`PackedInt32Array<class_PackedInt32Array_constructor_PackedInt32Array>`\ (\ from\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`PackedInt32Array<class_PackedInt32Array_constructor_PackedInt32Array>`\ (\ from\: :ref:`Array<class_Array>`\ ) |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
方法
----
.. table::
:widths: auto
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`append<class_PackedInt32Array_method_append>`\ (\ value\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`append_array<class_PackedInt32Array_method_append_array>`\ (\ array\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`bsearch<class_PackedInt32Array_method_bsearch>`\ (\ value\: :ref:`int<class_int>`, before\: :ref:`bool<class_bool>` = true\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear<class_PackedInt32Array_method_clear>`\ (\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`count<class_PackedInt32Array_method_count>`\ (\ value\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`duplicate<class_PackedInt32Array_method_duplicate>`\ (\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`erase<class_PackedInt32Array_method_erase>`\ (\ value\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`fill<class_PackedInt32Array_method_fill>`\ (\ value\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find<class_PackedInt32Array_method_find>`\ (\ value\: :ref:`int<class_int>`, from\: :ref:`int<class_int>` = 0\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get<class_PackedInt32Array_method_get>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_PackedInt32Array_method_has>`\ (\ value\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PackedInt32Array_method_insert>`\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedInt32Array_method_is_empty>`\ (\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`push_back<class_PackedInt32Array_method_push_back>`\ (\ value\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_at<class_PackedInt32Array_method_remove_at>`\ (\ index\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`resize<class_PackedInt32Array_method_resize>`\ (\ new_size\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`reverse<class_PackedInt32Array_method_reverse>`\ (\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`rfind<class_PackedInt32Array_method_rfind>`\ (\ value\: :ref:`int<class_int>`, from\: :ref:`int<class_int>` = -1\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set<class_PackedInt32Array_method_set>`\ (\ index\: :ref:`int<class_int>`, value\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedInt32Array_method_size>`\ (\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`slice<class_PackedInt32Array_method_slice>`\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`sort<class_PackedInt32Array_method_sort>`\ (\ ) |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedInt32Array_method_to_byte_array>`\ (\ ) |const| |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
运算符
------
.. table::
:widths: auto
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedInt32Array_operator_neq_PackedInt32Array>`\ (\ right\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`operator +<class_PackedInt32Array_operator_sum_PackedInt32Array>`\ (\ right\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedInt32Array_operator_eq_PackedInt32Array>`\ (\ right\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`operator []<class_PackedInt32Array_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
构造函数说明
------------
.. _class_PackedInt32Array_constructor_PackedInt32Array:
.. rst-class:: classref-constructor
:ref:`PackedInt32Array<class_PackedInt32Array>` **PackedInt32Array**\ (\ ) :ref:`🔗<class_PackedInt32Array_constructor_PackedInt32Array>`
构造空的 **PackedInt32Array**\ 。
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
:ref:`PackedInt32Array<class_PackedInt32Array>` **PackedInt32Array**\ (\ from\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ )
构造给定 **PackedInt32Array** 的副本。
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
:ref:`PackedInt32Array<class_PackedInt32Array>` **PackedInt32Array**\ (\ from\: :ref:`Array<class_Array>`\ )
构造新 **PackedInt32Array**\ 。你还可以传入通用 :ref:`Array<class_Array>` 进行转换。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
方法说明
--------
.. _class_PackedInt32Array_method_append:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **append**\ (\ value\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_append>`
向数组末尾追加一个元素(\ :ref:`push_back()<class_PackedInt32Array_method_push_back>` 的别名)。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_append_array:
.. rst-class:: classref-method
|void| **append_array**\ (\ array\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_PackedInt32Array_method_append_array>`
在该数组的末尾追加一个 **PackedInt32Array**\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_bsearch:
.. rst-class:: classref-method
:ref:`int<class_int>` **bsearch**\ (\ value\: :ref:`int<class_int>`, before\: :ref:`bool<class_bool>` = true\ ) |const| :ref:`🔗<class_PackedInt32Array_method_bsearch>`
使用二进法查找已有值的索引(如果该值尚未存在于数组中,则为保持排序顺序的插入索引)。传递 ``before`` 说明符是可选的。如果该参数为 ``false``\ ,则返回的索引位于数组中该值的所有已有的条目之后。
\ **注意:**\ 在未排序的数组上调用 :ref:`bsearch()<class_PackedInt32Array_method_bsearch>` 会产生预料之外的行为。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_clear:
.. rst-class:: classref-method
|void| **clear**\ (\ ) :ref:`🔗<class_PackedInt32Array_method_clear>`
清空数组。相当于调用 :ref:`resize()<class_PackedInt32Array_method_resize>` 时指定大小为 ``0``\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **count**\ (\ value\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PackedInt32Array_method_count>`
返回元素在数组中出现的次数。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_duplicate:
.. rst-class:: classref-method
:ref:`PackedInt32Array<class_PackedInt32Array>` **duplicate**\ (\ ) |const| :ref:`🔗<class_PackedInt32Array_method_duplicate>`
创建该数组的副本,并将该副本返回。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_erase:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **erase**\ (\ value\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_erase>`
在数组中移除首次出现的某个值并返回 ``true``\ 。如果数组中不存在该值,则不会发生任何事情,返回 ``false``\ 。要按照索引移除元素,请改用 :ref:`remove_at()<class_PackedInt32Array_method_remove_at>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_fill:
.. rst-class:: classref-method
|void| **fill**\ (\ value\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_fill>`
将数组中的所有元素都设为给定的值。通常与 :ref:`resize()<class_PackedInt32Array_method_resize>` 一起使用,创建给定大小的数组并初始化元素。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_find:
.. rst-class:: classref-method
:ref:`int<class_int>` **find**\ (\ value\: :ref:`int<class_int>`, from\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_PackedInt32Array_method_find>`
在数组中搜索值并返回其索引,如果未找到则返回 ``-1`` 。可选地,可以传递起始搜索索引。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_get:
.. rst-class:: classref-method
:ref:`int<class_int>` **get**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PackedInt32Array_method_get>`
Returns the 32-bit integer at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``0``.
This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_has:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has**\ (\ value\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PackedInt32Array_method_has>`
如果该数组包含 ``value``\ ,则返回 ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_insert:
.. rst-class:: classref-method
:ref:`int<class_int>` **insert**\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_insert>`
在数组中的给定位置插入新的整数。位置必须有效,或者位于数组末尾(\ ``idx == size()``\ )。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_is_empty:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_empty**\ (\ ) |const| :ref:`🔗<class_PackedInt32Array_method_is_empty>`
该数组为空时,返回 ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_push_back:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **push_back**\ (\ value\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_push_back>`
将一个值添加到数组中。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_remove_at:
.. rst-class:: classref-method
|void| **remove_at**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_remove_at>`
从数组中删除位于索引的元素。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_resize:
.. rst-class:: classref-method
:ref:`int<class_int>` **resize**\ (\ new_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_resize>`
设置数组的大小。如果数组增大,则预留数组末端的元素。如果数组缩小,则将数组截断到新的大小。调用一次 :ref:`resize()<class_PackedInt32Array_method_resize>` 然后赋值比逐个添加新元素要快。
成功时返回 :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`\ ,失败时返回下列 :ref:`Error<enum_@GlobalScope_Error>` 常量:大小为负数则返回 :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>`\ ,分配失败则返回 :ref:`@GlobalScope.ERR_OUT_OF_MEMORY<class_@GlobalScope_constant_ERR_OUT_OF_MEMORY>`\ 。请使用 :ref:`size()<class_PackedInt32Array_method_size>` 获取调整后的实际大小。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_reverse:
.. rst-class:: classref-method
|void| **reverse**\ (\ ) :ref:`🔗<class_PackedInt32Array_method_reverse>`
将数组中的元素逆序排列。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_rfind:
.. rst-class:: classref-method
:ref:`int<class_int>` **rfind**\ (\ value\: :ref:`int<class_int>`, from\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_PackedInt32Array_method_rfind>`
逆序搜索数组。还可以传递起始搜索位置索引。如果为负,则起始索引被视为相对于数组的结尾。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_set:
.. rst-class:: classref-method
|void| **set**\ (\ index\: :ref:`int<class_int>`, value\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_method_set>`
更改给定索引处的整数。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_size:
.. rst-class:: classref-method
:ref:`int<class_int>` **size**\ (\ ) |const| :ref:`🔗<class_PackedInt32Array_method_size>`
返回数组中元素的个数。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_slice:
.. rst-class:: classref-method
:ref:`PackedInt32Array<class_PackedInt32Array>` **slice**\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| :ref:`🔗<class_PackedInt32Array_method_slice>`
返回该 **PackedInt32Array** 的切片,是从 ``begin``\ (含)到 ``end``\ (不含)的全新 **PackedInt32Array**\ 。
\ ``begin````end`` 的绝对值会按数组大小进行限制,所以 ``end`` 的默认值会切到数组大小为止(即 ``arr.slice(1)````arr.slice(1, arr.size())`` 的简写)。
如果 ``begin````end`` 为负,则表示相对于数组的末尾(即 ``arr.slice(0, -2)````arr.slice(0, arr.size() - 2)`` 的简写)。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_sort:
.. rst-class:: classref-method
|void| **sort**\ (\ ) :ref:`🔗<class_PackedInt32Array_method_sort>`
将该数组中的元素按升序排列。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_method_to_byte_array:
.. rst-class:: classref-method
:ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const| :ref:`🔗<class_PackedInt32Array_method_to_byte_array>`
返回数据的副本,将其中的每个元素都编码为 4 个字节,放入 :ref:`PackedByteArray<class_PackedByteArray>` 中。
新数组的大小为 ``int32_array.size() * 4``\ 。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
运算符说明
----------
.. _class_PackedInt32Array_operator_neq_PackedInt32Array:
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_PackedInt32Array_operator_neq_PackedInt32Array>`
如果数组内容不同,则返回 ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_operator_sum_PackedInt32Array:
.. rst-class:: classref-operator
:ref:`PackedInt32Array<class_PackedInt32Array>` **operator +**\ (\ right\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_PackedInt32Array_operator_sum_PackedInt32Array>`
返回新的 **PackedInt32Array**\ ,新数组的内容为此数组在末尾加上 ``right``\ 。为了提高性能,请考虑改用 :ref:`append_array()<class_PackedInt32Array_method_append_array>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_operator_eq_PackedInt32Array:
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_PackedInt32Array_operator_eq_PackedInt32Array>`
如果两个数组的内容相同,即对应索引号的整数相等,则返回 ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_PackedInt32Array_operator_idx_int:
.. rst-class:: classref-operator
:ref:`int<class_int>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedInt32Array_operator_idx_int>`
返回索引 ``index`` 处的 :ref:`int<class_int>`\ 。负数索引可以从末尾开始访问元素。使用超出数组范围的索引会导致出错。
注意,\ :ref:`int<class_int>` 类型为 64 位,与该数组中所存储的值不同。
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (本方法无副作用,不会修改该实例的任何成员变量。)`
.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。)`
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
.. |static| replace:: :abbr:`static (调用本方法无需实例,可直接使用类名进行调用。)`
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)`
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)`
.. |void| replace:: :abbr:`void (无返回值。)`