summaryrefslogtreecommitdiff
path: root/doc/classes/Array.xml
AgeCommit message (Collapse)Author
2022-01-18Merge pull request #56668 from akien-mga/array-slice-nicer-bound-checksRémi Verschelde
2022-01-17Give example of one-liner for Array natural sortLisandro Lorea
The documentation for the sort method warns the user that it doesn't do natural sort but fails to provide a solution when it's just a one liner thanks to String.naturalnocasecmp_to() and lambda support This suggests exactly the same algorithm as used by the filesystem dock for file sorting. Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-01-10`Array`: Relax `slice` bound checks to properly handle negative indicesRémi Verschelde
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.
2021-11-26PackedByteArray, Array slice end exclusive, rename subarray to sliceNathan Franke
2021-11-23Rename `remove()` to `remove_at()` when removing by indexLightning_A
2021-11-12Improve sort_custom() examplekobewi
2021-10-29Move the docs for constructors and operators out of methods sectionAaron Franke
2021-10-05doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphsRémi Verschelde
And fix up formatting not supported by makerst.
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-09-17Allow comparing equality between builtin types and nullGeorge Marques
2021-09-07Fix docs for Array's slice()Max Hilbrunner
2021-09-05Specify description of Array.slices end parameterJohannes Witt
2021-08-28Fix Array class docs after #47406Max Hilbrunner
2021-08-27Add an `Array.pop_at()` method to pop an element at an arbitrary indexHugo Locurcio
Negative indices are supported to pop an element relative from the end.
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
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-23Fix doc typosNicholas Huelin
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`, `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
2021-06-11Merge pull request #47584 from HaSa1002/docs-lang-7Rémi Verschelde
2021-06-11Port code examples to C# (V)Johannes
Includes: * Variant * Viewport and two fixes in Array that were pointed out in #40978 VisualScript classes are skipped on purpose. That is the final commit of the inital code porting to C#. :)
2021-06-03Improve sort_custom() descriptionkobewi
2021-05-20Fix typos with codespellRémi Verschelde
Using codespell 2.0.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear dof doubleclick fave findn GIRD leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2021-05-07Improve docs for filter map and reducekobewi
2021-05-05Add filter, map and reduce to ArrayTomasz Chabora
2021-04-21Add fill method to Arrays and PackedArraysMatheus Lima Cunha
2021-04-04Fix misformatted documentation from #47435, #42827, #46991Yuri Sizov
2021-03-21Rename Array.invert() to Array.reverse()Marcel Admiraal
Does the same internally for List and Vector<>, which includes all PackedArray types.
2021-03-18doc: Sync classref with current sourceRémi Verschelde
And move GLTF docs to its module folder.
2021-02-26Fixes typo in Array::bsearch_custom docHaoyu Qiu
2021-02-04Change sort_custom/bsearch_custom to use Callableskobewi
2021-01-26Merge pull request #44624 from Calinou/doc-array-hashRémi Verschelde
Improve the `Array.hash()` documentation
2021-01-26Document low performance of `Array.push_front()` and `Array.pop_front()`Hugo Locurcio
2021-01-04doc: Sync classref with current sourceRémi Verschelde
2020-12-28Rename empty() to is_empty()Marcel Admiraal
2020-12-23Improve the `Array.hash()` documentationHugo Locurcio
Co-authored-by: Laguzus <67963093+Laguzus@users.noreply.github.com>
2020-11-14Improve the Dictionary class documentationHugo Locurcio
- Mention Lua-style syntax. - Make the code samples self-contained. - Mention caveat with `const` (also in Array). - Clarify the description of `size()`. This closes https://github.com/godotengine/godot-docs/issues/4272.
2020-11-10Merge pull request #43437 from akien-mga/doc-operatorsRémi Verschelde
doc: Add template to document Variant operators, fixups to #43419
2020-11-10doc: Sync classref to add operators after #43419Rémi Verschelde
2020-11-10Merge pull request #43398 from ↵Rémi Verschelde
KoBeWi/add_an_array_to_another_array_but_with_a_method Add append_array() method to Array class
2020-11-09Variant: Sync docs with new constructors, fixups after #43403Rémi Verschelde
Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-08Add append_array() method to Array classTomasz Chabora
2020-11-04doc: Sync classref with current source + fixup some bindingsRémi Verschelde
Includes various changes triggered by the refactoring of method bindings.
2020-09-26Add C# code examples to the docsHaSa1002
Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-09-21Fix a typo in the Array class documentationHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/4049.
2020-09-09Improve documentation related to Array error handlingHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/3834.
2020-08-12Mention that Array.front/back throw error if emptyTomasz Chabora
2020-07-13Commit other files changed by file_format.shAaron Franke
2020-06-12Document the `in` operator in String, Array and Dictionary classesHugo Locurcio
This also clarifies the `in` operator behavior in Object.
2020-05-16Document that Dictionary is always passed as referenceHugo Locurcio
See #38792.
2020-03-18doc: Sync classref with current sourceRémi Verschelde
Fix wrong binding after #37111.
2020-03-09DocData: Fix serialization of Variant default valuesRémi Verschelde
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2020-02-27doc: Mention concatenation using the `+` operator in ArrayHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/2452.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-05 23:17:40 +0000