1
0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00

70 Commits

Author SHA1 Message Date
OsakiTsukiko
805ad87340 Add PackedByteArray conversion to PackedVector2Array, PackedVector3Array, PackedVector4Array and PackedColorArray 2025-06-12 17:05:57 +02:00
Hugo Locurcio
59a75babf8 Improve documentation for Array.get() and Packed*Array.get() methods 2025-05-20 23:47:04 +02:00
Thaddeus Crews
215acd52e8 Merge pull request #105054 from Mickeon/documentation-typo-packed-arrays
Fix typo in common note for packed arrays
2025-04-11 13:29:14 -05:00
Pāvels Nadtočajevs
7c4d45ba3b Add bswap methods to the PackedByteArray bindings. 2025-04-09 18:51:50 +03:00
Pāvels Nadtočajevs
bd98aad3fa Remove misleading and incorrect notes about endianness. Fix FileAccess and StreamPeer not doing what name suggests. 2025-04-09 11:01:25 +03:00
Micky
86787aeca6 Fix typo in common note for packed arrays 2025-04-05 13:46:00 +02:00
bruvzg
48bfe13e4f Add methods to decode/encode multibyte encodings. 2025-03-28 17:32:34 +02:00
Max Chacon
44d10c576e Improve documentation for return value of Packed*Array.resize
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2025-03-20 16:21:01 +01:00
A Thousand Ships
46b6acdabb [Core] Expose Packed*Array::erase 2025-02-03 19:25:09 +01:00
Micky
ca4b29b18d Standardize all "Prints" comments in documentation 2024-12-23 21:26:00 +01:00
Raul Santos
072ff85f82 [.NET] Use collection expressions in docs
As of C# 12 we can now use collection expressions to reduce some boilerplate when initializing collections.
2024-12-21 02:28:59 +01:00
Aaron Franke
cc9f2b58a0 Bind Array get and set functions 2024-09-26 13:00:17 -07:00
A Thousand Ships
23782b898b Add further details on properties returning Packed*Array 2024-04-08 11:35:27 +02:00
Micky
c54e09a5a3 Overhaul some "uncommon" wording in class reference 2024-03-01 15:32:38 +01:00
A Thousand Ships
4850b866e8 Clarify PackedByteArray.decompress* limitations with external data 2024-01-07 13:34:39 +01:00
MewPurPur
80b636069a Add performance note to Array.resize() 2023-11-10 00:41:39 +02:00
Yuri Sizov
cc0eebd9d8 Validate code tags for class and member references
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.

Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00
Aaron Franke
7e3e13fc66 Doc: Reference String <-> PackedByteArray conversions from each other 2023-09-12 03:43:01 -05:00
Septian
2857b91385 Fix many typos in documentation 2023-07-19 19:56:06 +07:00
Rémi Verschelde
81064cc239 Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
Rémi Verschelde
346f1ab86b Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
Ninni Pipping
6bccdec7a1 Make documentation sorting use natural order 2023-05-09 17:47:52 +02:00
bruvzg
0e4bd964cc Expose brotli decompression to the scripting API. 2023-03-29 22:43:36 +03:00
bruvzg
d72b563250 Add GDScript to_wchar_buffer and get_string_from_wchar functions. 2023-03-21 15:39:54 +02:00
Rémi Verschelde
1c1524a651 Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
Haoyu Qiu
0c92c92891 Various classref typo fixes 2023-02-20 14:47:37 +08:00
kobewi
9f2dc68279 Replace File/Directory with FileAccess/DirAccess 2022-09-19 11:03:31 +02:00
kobewi
b099a8570c Complete documentation of packed arrays 2022-08-19 00:43:29 +02:00
Andy Maloney
1df86ecea5 [doc] Use "param" instead of "code" to refer to parameters (4) 2022-08-11 13:52:19 -04:00
Haoyu Qiu
9c4ad8191b Expose clear method for packed arrays 2022-08-10 17:12:20 +08:00
Yuri Sizov
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
Lyuma
33fd7c63e1 Prevent out-of-bounds write in array conversion; avoid logspam on empty arrays. 2022-06-30 18:04:33 -07:00
Haoyu Qiu
380a53f02f Add search methods for packed arrays
* count()
* find()
* rfind()
2022-05-07 20:16:11 +08:00
Haoyu Qiu
24febff2dc Remove Array link in description of PackedArrays 2022-04-23 11:06:02 +08:00
Yuri Roubinsky
32f2c47356 Remove generating of null comparison operators from documentation 2022-03-14 22:35:23 +03:00
Hugo Locurcio
b68dd2e189 Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
Rémi Verschelde
c6cefb1b79 Array: Relax slice bound checks to properly handle negative indices
The same is done for `Vector` (and thus `Packed*Array`).

`begin` and `end` can now take any value and will be clamped to
`[-size(), size()]`. Negative values are a shorthand for indexing the array
from the last element upward.

`end` is given a default `INT_MAX` value (which will be clamped to `size()`)
so that the `end` parameter can be omitted to go from `begin` to the max size
of the array.

This makes `slice` works similarly to numpy's and JavaScript's.
2022-01-10 22:42:03 +01:00
Haoyu Qiu
3d08becd06 Unify similar method descriptions
Notably:

* `Packed*Array.size()` and `Array.size()`.
* Shared methods of `Transform2D` and `Transform3D`.
* Shared methods of `Vector2`, `Vector3`, and `Vector2i`.

This reduces the Deja Vu when translating the class reference :)
2022-01-06 19:50:57 +08:00
Nathan Franke
dd30253cdc PackedByteArray, Array slice end exclusive, rename subarray to slice 2021-11-26 22:13:12 -06:00
Lightning_A
e078f970db Rename remove() to remove_at() when removing by index 2021-11-23 18:58:57 -07:00
Aaron Franke
6772ebcea0 Move the docs for constructors and operators out of methods section 2021-10-29 12:34:57 -05:00
Rémi Verschelde
b32f84d473 Merge pull request #52850 from mashumafi/vector-bsearch 2021-10-01 07:52:51 +02:00
mashumafi
214bbfbefe Implement bsearch for Vector and Packed*Array 2021-09-30 23:57:26 +00:00
Aaron Franke
d54f2ad7ca Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
George Marques
455e142d37 Allow comparing equality between builtin types and null 2021-09-17 12:33:52 -03:00
Ellen Poe
f5d9c7b487 Replace stb_vorbis with libogg+libvorbis 2021-09-09 19:39:04 -07:00
Rémi Verschelde
7adf4cc9b5 doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
ChristopheClaustre
20818c12b7 New to_***_array method to decode PackedByteArray to Packed***Array
Documentation for new PackedByteArray::to_***_array methods
Documentation for to_byte_array method for PackedInt32/Int64/Float32/Float64Array
2021-07-24 21:06:47 +02:00
Matheus Lima Cunha
efd27a63c1 Add fill method to Arrays and PackedArrays 2021-04-21 11:33:53 -03:00
Rémi Verschelde
29775a1714 doc: Sync classref with current source 2021-04-19 12:26:37 +02:00