Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
PackedByteArray
Un array empaquetado de bytes.
Descripción
An array specifically designed to hold bytes. Packs data tightly, so it saves memory for large array sizes.
PackedByteArray also provides methods to encode/decode various types to/from bytes. The way values are encoded is an implementation detail and shouldn't be relied upon when interacting with external apps.
Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use duplicate(). This is not the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will not affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again.
Note: In a boolean context, a packed array will evaluate to false if it's empty. Otherwise, a packed array will always evaluate to true.
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 |
|
duplicate() 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) const 🔗
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() const 🔗
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.
Returns the byte 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.
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 🔗
Convierte un array codificado en UTF-8 a String. Más lento que get_string_from_ascii() pero soporta datos codificados en UTF-8. Usa esta función si no estás seguro del origen de los datos. Para la entrada del usuario, esta función siempre debería ser preferida. Devuelve una string vacía si el array de origen no es una string UTF-8 válida. Es el inverso de String.to_utf8_buffer().
String get_string_from_utf16() const 🔗
Convierte un array codificado en UTF-16 a String. Si falta el BOM, se asume little-endian. Devuelve una string vacía si el array de origen no es una string UTF-16 válida. Es el inverso de String.to_utf16_buffer().
String get_string_from_utf32() const 🔗
Convierte un array codificado en UTF-32 a String. Devuelve una string vacía si el array de origen no es una string UTF-32 válida. Es el inverso de String.to_utf32_buffer().
String get_string_from_wchar() const 🔗
Convierte un array codificado con caracteres anchos (wchar_t, UTF-16 en Windows, UTF-32 en otras plataformas) a String. Devuelve una string vacía si el array de origen no es una string ancha válida. Esto es lo inverso de String.to_wchar_buffer().
Devuelve true si el array contiene value.
bool has_encoded_var(byte_offset: int, allow_objects: bool = false) const 🔗
Devuelve true si un valor Variant válido puede ser decodificado en el byte_offset. Devuelve false en caso contrario o cuando el valor es derivado de Object y allow_objects es false.
Devuelve una representación hexadecimal de este array como una String.
var array = PackedByteArray([11, 46, 255])
print(array.hex_encode()) # Imprime "0b2eff"
byte[] array = [11, 46, 255];
GD.Print(array.HexEncode()); // Imprime "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.
Establece el tamaño del array. Si el array aumenta de tamaño, reserva elementos al final del array. Si el array se encoge, trunca el array al nuevo tamaño. Llamar a resize() una vez y asignar los nuevos valores es más rápido que añadir nuevos elementos uno por uno.
Devuelve @GlobalScope.OK si tiene éxito, o una de las siguientes constantes Error si este método falla: @GlobalScope.ERR_INVALID_PARAMETER si el tamaño es negativo, o @GlobalScope.ERR_OUT_OF_MEMORY si las asignaciones fallan. Usa size() para encontrar el tamaño real del array después del redimensionamiento.
void reverse() 🔗
Invierte el orden de los elementos en el array.
int rfind(value: int, from: int = -1) const 🔗
Busca el array en orden inverso. Opcionalmente, se puede pasar un índice de búsqueda inicial. Si es negativo, el índice inicial se considera relativo al final del 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 🔗
Devuelve la porción de PackedByteArray, desde begin (inclusivo) hasta end (exclusive), como un nuevo PackedByteArray.
El valor absoluto de begin y end se ajustará al tamaño del array, por lo que el valor predeterminado para end hace que corte hasta el tamaño del array por defecto (es decir, arr.slice(1) es una abreviatura de arr.slice(1, arr.size())).
Si begin o end son negativos, serán relativos al final del array (es decir, arr.slice(0, -2) es una abreviatura de arr.slice(0, arr.size() - 2)).
void sort() 🔗
Ordena los elementos del array en orden ascendente.
PackedColorArray to_color_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedColorArray, donde cada bloque de 16 bytes ha sido convertido a una variante Color.
Nota: El tamaño del array de entrada debe ser un múltiplo de 16 (tamaño de cuatro variables floats de 32 bits). El tamaño del nuevo array será byte_array.size() / 16. Si los datos originales no pueden ser convertidos a variantes Color, los datos resultantes son indefinidos.
PackedFloat32Array to_float32_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedFloat32Array, donde cada bloque de 4 bytes ha sido convertido a un float de 32 bits (C++ float).
El tamaño del array de entrada debe ser un múltiplo de 4 (tamaño de un float de 32 bits). El tamaño del nuevo array será byte_array.size() / 4.
Si los datos originales no pueden ser convertidos a floats de 32 bits, los datos resultantes son indefinidos.
PackedFloat64Array to_float64_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedFloat64Array, donde cada bloque de 8 bytes ha sido convertido a un float de 64 bits (C++ double, Godot float).
El tamaño del array de entrada debe ser un múltiplo de 8 (tamaño de un doble de 64 bits). El tamaño del nuevo array será byte_array.size() / 8.
Si los datos originales no pueden ser convertidos a floats de 64 bits, los datos resultantes son indefinidos.
PackedInt32Array to_int32_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedInt32Array, donde cada bloque de 4 bytes ha sido convertido a un entero de 32 bits con signo (C++ int32_t).
El tamaño del array de entrada debe ser un múltiplo de 4 (tamaño de un entero de 32 bits). El tamaño del nuevo array será byte_array.size() / 4.
Si los datos originales no pueden ser convertidos a enteros de 32 bits con signo, los datos resultantes son indefinidos.
PackedInt64Array to_int64_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedInt64Array, donde cada bloque de 8 bytes ha sido convertido a un entero de 64 bits con signo (C++ int64_t, Godot int).
El tamaño del array de entrada debe ser un múltiplo de 8 (tamaño de un entero de 64 bits). El tamaño del nuevo array será byte_array.size() / 8.
Si los datos originales no pueden ser convertidos a enteros de 64 bits con signo, los datos resultantes son indefinidos.
PackedVector2Array to_vector2_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedVector2Array, donde cada bloque de 8 o 16 bytes (32 bits o 64 bits) ha sido convertido a una variante Vector2.
Nota: El tamaño del array de entrada debe ser un múltiplo de 8 o 16 (dependiendo de la configuración de compilación, véase Vector2 para más detalles). El tamaño del nuevo array será byte_array.size() / (8 o 16). Si los datos originales no pueden ser convertidos a variantes Vector2, los datos resultantes son indefinidos.
PackedVector3Array to_vector3_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedVector3Array, donde cada bloque de 12 o 24 bytes (32-bit o 64-bit) ha sido convertido a una variante Vector3.
Nota: El tamaño del array de entrada debe ser un múltiplo de 12 o 24 (dependiendo de la configuración de compilación, véase Vector3 para más detalles). El tamaño del nuevo array será byte_array.size() / (12 o 24). Si los datos originales no pueden ser convertidos a variantes Vector3, los datos resultantes son indefinidos.
PackedVector4Array to_vector4_array() const 🔗
Devuelve una copia de los datos convertidos a un PackedVector4Array, donde cada bloque de 16 o 32 bytes (32-bit o 64-bit) ha sido convertido a una variante Vector4.
Nota: El tamaño del array de entrada debe ser un múltiplo de 16 o 32 (dependiendo de la configuración de compilación, véase Vector4 para más detalles). El tamaño del nuevo array será byte_array.size() / (16 o 32). Si los datos originales no pueden ser convertidos a variantes Vector4, los datos resultantes son indefinidos.
Descripciones de Operadores
bool operator !=(right: PackedByteArray) 🔗
Devuelve true si los contenidos de los arrays difieren.
PackedByteArray operator +(right: PackedByteArray) 🔗
Devuelve un nuevo PackedByteArray con el contenido de right añadido al final de este array. Para un mejor rendimiento, considera usar append_array() en su lugar.
bool operator ==(right: PackedByteArray) 🔗
Devuelve true si el contenido de ambos arrays es el mismo, es decir, si tienen todos los bytes iguales en los índices correspondientes.
Devuelve el byte en el índice index. Se pueden usar índices negativos para acceder a los elementos desde el final. Usar un índice fuera de los límites del array resultará en un error.
Ten en cuenta que el byte se devuelve como un int de 64 bits.