PackedByteArray
Un array empaquetado de bytes.
Descripción
Un array diseñado específicamente para contener bytes. Empaqueta los datos de forma compacta, por lo que ahorra memoria para arrays de gran tamaño.
PackedByteArray también proporciona métodos para codificar/decodificar varios tipos a/desde bytes. La forma en que se codifican los valores es un detalle de implementación y no se debe confiar en ella cuando se interactúa con aplicaciones externas.
Nota: Los arrays empaquetados siempre se pasan por referencia. Para obtener una copia de un array que pueda modificarse independientemente del array original, utiliza duplicate(). Este no es el caso de las propiedades y métodos integrados. En estos casos, el array empaquetado devuelto es una copia, y al cambiarlo no afectará el valor original. Para actualizar una propiedad integrada de este tipo, modifica el array devuelto y luego asígnalo nuevamente a la propiedad.
Nota
Hay diferencias notables cuando usa esta API con C#. Véase Diferencias de la API de C# con GDScript para más información.
Constructores
PackedByteArray(from: PackedByteArray) |
|
PackedByteArray(from: Array) |
Métodos
void |
append_array(array: PackedByteArray) |
void |
|
void |
|
void |
|
void |
clear() |
decode_double(byte_offset: int) const |
|
decode_float(byte_offset: int) const |
|
decode_half(byte_offset: int) const |
|
decode_s16(byte_offset: int) const |
|
decode_s32(byte_offset: int) const |
|
decode_s64(byte_offset: int) const |
|
decode_u16(byte_offset: int) const |
|
decode_u32(byte_offset: int) const |
|
decode_u64(byte_offset: int) const |
|
decode_var(byte_offset: int, allow_objects: bool = false) const |
|
decode_var_size(byte_offset: int, allow_objects: bool = false) const |
|
decompress(buffer_size: int, compression_mode: int = 0) const |
|
decompress_dynamic(max_output_size: int, compression_mode: int = 0) const |
|
void |
encode_double(byte_offset: int, value: float) |
void |
encode_float(byte_offset: int, value: float) |
void |
encode_half(byte_offset: int, value: float) |
void |
|
void |
encode_s16(byte_offset: int, value: int) |
void |
encode_s32(byte_offset: int, value: int) |
void |
encode_s64(byte_offset: int, value: int) |
void |
|
void |
encode_u16(byte_offset: int, value: int) |
void |
encode_u32(byte_offset: int, value: int) |
void |
encode_u64(byte_offset: int, value: int) |
encode_var(byte_offset: int, value: Variant, allow_objects: bool = false) |
|
void |
|
get_string_from_ascii() const |
|
get_string_from_multibyte_char(encoding: String = "") const |
|
get_string_from_utf8() const |
|
get_string_from_utf16() const |
|
get_string_from_utf32() const |
|
get_string_from_wchar() const |
|
has_encoded_var(byte_offset: int, allow_objects: bool = false) const |
|
hex_encode() const |
|
is_empty() const |
|
void |
|
void |
reverse() |
void |
|
size() const |
|
void |
sort() |
to_color_array() const |
|
to_float32_array() const |
|
to_float64_array() const |
|
to_int32_array() const |
|
to_int64_array() const |
|
to_vector2_array() const |
|
to_vector3_array() const |
|
to_vector4_array() const |
Operadores
operator !=(right: PackedByteArray) |
|
operator +(right: PackedByteArray) |
|
operator ==(right: PackedByteArray) |
|
operator [](index: int) |
Descripciones de Constructores
PackedByteArray PackedByteArray() 🔗
Construye un PackedByteArray vacío.
PackedByteArray PackedByteArray(from: PackedByteArray)
Construye un PackedByteArray como una copia del PackedByteArray dado.
PackedByteArray PackedByteArray(from: Array)
Construye un nuevo PackedByteArray. Opcionalmente, puedes pasarle un Array genérico que se convertirá.
Descripciones de Métodos
Concatena un elemento al final del array (alias de push_back()).
void append_array(array: PackedByteArray) 🔗
Añade un PackedByteArray al final de este array.
int bsearch(value: int, before: bool = true) 🔗
Encuentra el índice de un valor existente (o el índice de inserción que mantiene el orden de clasificación, si el valor aún no está presente en el array) utilizando la búsqueda binaria. Opcionalmente, se puede pasar un especificador before. Si es false, el índice devuelto viene después de todas las entradas existentes del valor en el array.
Nota: Llamar a bsearch() en un array sin ordenar da como resultado un comportamiento inesperado.
void bswap16(offset: int = 0, count: int = -1) 🔗
Intercambia el orden de bytes de count segmentos de 16 bits del array comenzando en offset. El intercambio se realiza en el lugar. Si count es menor que cero, se procesan todos los segmentos hasta el final del array. Si el tamaño de los datos procesados no es múltiplo de 2, el byte posterior al último segmento de 16 bits procesado no se modifica.
void bswap32(offset: int = 0, count: int = -1) 🔗
Intercambia el orden de bytes de count segmentos de 32 bits del array comenzando en offset. El intercambio se realiza en el lugar. Si count es menor que cero, se procesan todos los segmentos hasta el final del array. Si el tamaño de los datos procesados no es múltiplo de 4, los bytes posteriores al último segmento de 32 bits procesado no se modifican.
void bswap64(offset: int = 0, count: int = -1) 🔗
Intercambia el orden de bytes de count segmentos de 64 bits del array comenzando en offset. El intercambio se realiza en el lugar. Si count es menor que cero, se procesan todos los segmentos hasta el final del array. Si el tamaño de los datos procesados no es múltiplo de 8, los bytes posteriores al último segmento de 64 bits procesado no se modifican.
void clear() 🔗
Limpia el array. Esto es equivalente a usar resize() con un tamaño de 0.
PackedByteArray compress(compression_mode: int = 0) const 🔗
Returns a new PackedByteArray with the data compressed. Set the compression mode using one of CompressionMode's constants.
Devuelve el numer de veces que un elemento es encuentra en el array.
float decode_double(byte_offset: int) const 🔗
Decodifica un número de punto flotante de 64 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0.0 si no se puede decodificar un número válido.
float decode_float(byte_offset: int) const 🔗
Decodifica un número de punto flotante de 32 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0.0 si no se puede decodificar un número válido.
float decode_half(byte_offset: int) const 🔗
Decodifica un número de punto flotante de 16 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0.0 si no se puede decodificar un número válido.
int decode_s8(byte_offset: int) const 🔗
Decodifica un número entero con signo de 8 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
int decode_s16(byte_offset: int) const 🔗
Decodifica un número entero con signo de 16 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
int decode_s32(byte_offset: int) const 🔗
Decodifica un número entero con signo de 32 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
int decode_s64(byte_offset: int) const 🔗
Decodifica un número entero con signo de 64 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
int decode_u8(byte_offset: int) const 🔗
Decodifica un número entero sin signo de 8 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
int decode_u16(byte_offset: int) const 🔗
Decodifica un número entero sin signo de 16 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
int decode_u32(byte_offset: int) const 🔗
Decodifica un número entero sin signo de 32 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
int decode_u64(byte_offset: int) const 🔗
Decodifica un número entero sin signo de 64 bits de los bytes que empiezan en byte_offset. Falla si el recuento de bytes es insuficiente. Devuelve 0 si no se puede decodificar un número válido.
Variant decode_var(byte_offset: int, allow_objects: bool = false) const 🔗
Decodifica un Variant de los bytes que comienzan en byte_offset. Devuelve null si no se puede decodificar un Variant válido o si el valor deriva de Object y allow_objects es false.
int decode_var_size(byte_offset: int, allow_objects: bool = false) const 🔗
Decodifica el tamaño de un Variant de los bytes que empiezan en byte_offset. Requiere al menos 4 bytes de datos a partir del desplazamiento, de lo contrario, falla.
PackedByteArray decompress(buffer_size: int, compression_mode: int = 0) const 🔗
Devuelve un nuevo PackedByteArray con los datos descomprimidos. Establece buffer_size al tamaño de los datos descomprimidos. Establece el modo de compresión utilizando una de las constantes de CompressionMode.
Nota: No se garantiza que la descompresión funcione con datos no comprimidos por Godot; por ejemplo, si los datos comprimidos con el modo de compresión deflate carecen de una suma de comprobación o encabezado.
PackedByteArray decompress_dynamic(max_output_size: int, compression_mode: int = 0) const 🔗
Returns a new PackedByteArray with the data decompressed. Set the compression mode using one of CompressionMode's constants. This method only accepts brotli, gzip, and deflate compression modes.
This method is potentially slower than decompress(), as it may have to re-allocate its output buffer multiple times while decompressing, whereas decompress() knows it's output buffer size from the beginning.
GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via max_output_size. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that amount in bytes, then an error will be returned.
Note: Decompression is not guaranteed to work with data not compressed by Godot, for example if data compressed with the deflate compression mode lacks a checksum or header.
PackedByteArray duplicate() 🔗
Creates a copy of the array, and returns it.
void encode_double(byte_offset: int, value: float) 🔗
Codifica un número de punto flotante de 64 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 8 bytes de espacio asignado, empezando en el desplazamiento.
void encode_float(byte_offset: int, value: float) 🔗
Codifica un número de punto flotante de 32 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 4 bytes de espacio, empezando en el desplazamiento.
void encode_half(byte_offset: int, value: float) 🔗
Codifica un número de punto flotante de 16 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 2 bytes de espacio, empezando en el desplazamiento.
void encode_s8(byte_offset: int, value: int) 🔗
Codifica un número entero con signo de 8 bits (byte con signo) como bytes en el índice de byte_offset bytes. El array debe tener al menos 1 byte de espacio, empezando en el desplazamiento.
void encode_s16(byte_offset: int, value: int) 🔗
Codifica un número entero con signo de 16 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 2 bytes de espacio, empezando en el desplazamiento.
void encode_s32(byte_offset: int, value: int) 🔗
Codifica un número entero con signo de 32 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 4 bytes de espacio, empezando en el desplazamiento.
void encode_s64(byte_offset: int, value: int) 🔗
Codifica un número entero con signo de 64 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 8 bytes de espacio, empezando en el desplazamiento.
void encode_u8(byte_offset: int, value: int) 🔗
Codifica un número entero sin signo de 8 bits (byte) como bytes en el índice de byte_offset bytes. El array debe tener al menos 1 byte de espacio, empezando en el desplazamiento.
void encode_u16(byte_offset: int, value: int) 🔗
Codifica un número entero sin signo de 16 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 2 bytes de espacio, empezando en el desplazamiento.
void encode_u32(byte_offset: int, value: int) 🔗
Codifica un número entero sin signo de 32 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 4 bytes de espacio, empezando en el desplazamiento.
void encode_u64(byte_offset: int, value: int) 🔗
Codifica un número entero sin signo de 64 bits como bytes en el índice de byte_offset bytes. El array debe tener al menos 8 bytes de espacio, empezando en el desplazamiento.
int encode_var(byte_offset: int, value: Variant, allow_objects: bool = false) 🔗
Codifica un Variant en el índice de byte_offset bytes. Se debe asignar un espacio suficiente, dependiendo del tamaño del variant codificado. Si allow_objects es false, los valores derivados de Object no están permitidos y, en su lugar, se serializarán como ID-only.
Elimina la primera aparición de un valor del array y devuelve true. Si el valor no existe en el array, no sucede nada y se devuelve false. Para eliminar un elemento por índice, usa remove_at() en su lugar.
Asigna el valor dado a todos los elementos del array. Esto normalmente se puede usar junto con resize() para crear un array con un tamaño dado y elementos inicializados.
int find(value: int, from: int = 0) const 🔗
Busca un valor en el array y devuelve su índice o -1 si no lo encuentra. Opcionalmente, se puede pasar el índice de búsqueda inicial.
Devuelve el byte en el index dado en el array. Si index está fuera de los límites o es negativo, este método falla y devuelve 0.
Este método es similar (pero no idéntico) al operador []. Principalmente, cuando este método falla, no pausa la ejecución del proyecto si se ejecuta desde el editor.
String get_string_from_ascii() const 🔗
Converts ASCII/Latin-1 encoded array to String. Fast alternative to get_string_from_utf8() if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use get_string_from_utf8(). This is the inverse of String.to_ascii_buffer().
String get_string_from_multibyte_char(encoding: String = "") const 🔗
Converts system multibyte code page encoded array to String. If conversion fails, empty string is returned. This is the inverse of String.to_multibyte_char_buffer().
The values permitted for encoding are system dependent. If encoding is empty string, system default encoding is used.
For Windows, see Code Page Identifiers .NET names.
For macOS and Linux/BSD, see
libiconvlibrary documentation andiconv --listfor a list of supported encodings.
String get_string_from_utf8() const 🔗
Converts UTF-8 encoded array to String. Slower than get_string_from_ascii() but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string. This is the inverse of String.to_utf8_buffer().
String get_string_from_utf16() const 🔗
Converts UTF-16 encoded array to String. If the BOM is missing, little-endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of String.to_utf16_buffer().
String get_string_from_utf32() const 🔗
Converts UTF-32 encoded array to String. Returns empty string if source array is not valid UTF-32 string. This is the inverse of String.to_utf32_buffer().
String get_string_from_wchar() const 🔗
Converts wide character (wchar_t, UTF-16 on Windows, UTF-32 on other platforms) encoded array to String. Returns empty string if source array is not valid wide string. This is the inverse of String.to_wchar_buffer().
Returns true if the array contains value.
bool has_encoded_var(byte_offset: int, allow_objects: bool = false) const 🔗
Returns true if a valid Variant value can be decoded at the byte_offset. Returns false otherwise or when the value is Object-derived and allow_objects is false.
Returns a hexadecimal representation of this array as a String.
var array = PackedByteArray([11, 46, 255])
print(array.hex_encode()) # Prints "0b2eff"
byte[] array = [11, 46, 255];
GD.Print(array.HexEncode()); // Prints "0b2eff"
int insert(at_index: int, value: int) 🔗
Inserta un nuevo elemento en una posición determinada del array. La posición debe ser válida, o al final del array (idx == size()).
Devuelve true si el array es vacio.
Concatena un elemen al final del array.
Elimina un elemento del array por indice.
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling resize() once and assigning the new values is faster than adding new elements one by one.
Returns @GlobalScope.OK on success, or one of the following Error constants if this method fails: @GlobalScope.ERR_INVALID_PARAMETER if the size is negative, or @GlobalScope.ERR_OUT_OF_MEMORY if allocations fail. Use size() to find the actual size of the array after resize.
void reverse() 🔗
Invierte el orden de los elementos en el array.
int rfind(value: int, from: int = -1) const 🔗
Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
void set(index: int, value: int) 🔗
Cambia el byte en el índice dado.
Devuelve el numer de elementos en el array.
PackedByteArray slice(begin: int, end: int = 2147483647) const 🔗
Returns the slice of the PackedByteArray, from begin (inclusive) to end (exclusive), as a new PackedByteArray.
The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).
If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).
void sort() 🔗
Sorts the elements of the array in ascending order.
PackedColorArray to_color_array() const 🔗
Returns a copy of the data converted to a PackedColorArray, where each block of 16 bytes has been converted to a Color variant.
Note: The size of the input array must be a multiple of 16 (size of four 32-bit float variables). The size of the new array will be byte_array.size() / 16. If the original data can't be converted to Color variants, the resulting data is undefined.
PackedFloat32Array to_float32_array() const 🔗
Returns a copy of the data converted to a PackedFloat32Array, where each block of 4 bytes has been converted to a 32-bit float (C++ float).
The size of the input array must be a multiple of 4 (size of 32-bit float). The size of the new array will be byte_array.size() / 4.
If the original data can't be converted to 32-bit floats, the resulting data is undefined.
PackedFloat64Array to_float64_array() const 🔗
Returns a copy of the data converted to a PackedFloat64Array, where each block of 8 bytes has been converted to a 64-bit float (C++ double, Godot float).
The size of the input array must be a multiple of 8 (size of 64-bit double). The size of the new array will be byte_array.size() / 8.
If the original data can't be converted to 64-bit floats, the resulting data is undefined.
PackedInt32Array to_int32_array() const 🔗
Returns a copy of the data converted to a PackedInt32Array, where each block of 4 bytes has been converted to a signed 32-bit integer (C++ int32_t).
The size of the input array must be a multiple of 4 (size of 32-bit integer). The size of the new array will be byte_array.size() / 4.
If the original data can't be converted to signed 32-bit integers, the resulting data is undefined.
PackedInt64Array to_int64_array() const 🔗
Returns a copy of the data converted to a PackedInt64Array, where each block of 8 bytes has been converted to a signed 64-bit integer (C++ int64_t, Godot int).
The size of the input array must be a multiple of 8 (size of 64-bit integer). The size of the new array will be byte_array.size() / 8.
If the original data can't be converted to signed 64-bit integers, the resulting data is undefined.
PackedVector2Array to_vector2_array() const 🔗
Returns a copy of the data converted to a PackedVector2Array, where each block of 8 bytes or 16 bytes (32-bit or 64-bit) has been converted to a Vector2 variant.
Note: The size of the input array must be a multiple of 8 or 16 (depending on the build settings, see Vector2 for more details). The size of the new array will be byte_array.size() / (8 or 16). If the original data can't be converted to Vector2 variants, the resulting data is undefined.
PackedVector3Array to_vector3_array() const 🔗
Returns a copy of the data converted to a PackedVector3Array, where each block of 12 or 24 bytes (32-bit or 64-bit) has been converted to a Vector3 variant.
Note: The size of the input array must be a multiple of 12 or 24 (depending on the build settings, see Vector3 for more details). The size of the new array will be byte_array.size() / (12 or 24). If the original data can't be converted to Vector3 variants, the resulting data is undefined.
PackedVector4Array to_vector4_array() const 🔗
Returns a copy of the data converted to a PackedVector4Array, where each block of 16 or 32 bytes (32-bit or 64-bit) has been converted to a Vector4 variant.
Note: The size of the input array must be a multiple of 16 or 32 (depending on the build settings, see Vector4 for more details). The size of the new array will be byte_array.size() / (16 or 32). If the original data can't be converted to Vector4 variants, the resulting data is undefined.
Descripciones de Operadores
bool operator !=(right: PackedByteArray) 🔗
Returns true if contents of the arrays differ.
PackedByteArray operator +(right: PackedByteArray) 🔗
Returns a new PackedByteArray with contents of right added at the end of this array. For better performance, consider using append_array() instead.
bool operator ==(right: PackedByteArray) 🔗
Returns true if contents of both arrays are the same, i.e. they have all equal bytes at the corresponding indices.
Returns the byte at index index. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error.
Note that the byte is returned as a 64-bit int.