Marcel Admiraal
755c70b871
Rename Array.invert() to Array.reverse()
...
Does the same internally for List and Vector<>, which includes all
PackedArray types.
2021-03-21 10:20:08 +00:00
Rémi Verschelde
4ca1e73ff9
doc: Sync classref with current source
...
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +01:00
Haoyu Qiu
31243e377f
Fixes typo in Array::bsearch_custom doc
2021-02-26 18:01:08 +08:00
kobewi
fb83d905da
Change sort_custom/bsearch_custom to use Callables
2021-02-04 14:37:52 +01:00
Rémi Verschelde
34eb5638d3
Merge pull request #44624 from Calinou/doc-array-hash
...
Improve the `Array.hash()` documentation
2021-01-26 15:53:35 +01:00
Hugo Locurcio
7ce3cc0478
Document low performance of Array.push_front()
and Array.pop_front()
2021-01-26 00:02:55 +01:00
Rémi Verschelde
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
Marcel Admiraal
5b937d493f
Rename empty() to is_empty()
2020-12-28 10:39:56 +00:00
Hugo Locurcio
435848192e
Improve the Array.hash()
documentation
...
Co-authored-by: Laguzus <67963093+Laguzus@users.noreply.github.com>
2020-12-23 19:13:10 +01:00
Hugo Locurcio
5325de4e6b
Improve the Dictionary class documentation
...
- 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-14 22:05:53 +01:00
Rémi Verschelde
9397a5a272
Merge pull request #43437 from akien-mga/doc-operators
...
doc: Add template to document Variant operators, fixups to #43419
2020-11-10 15:58:36 +01:00
Rémi Verschelde
64e893deac
doc: Sync classref to add operators after #43419
2020-11-10 15:00:50 +01:00
Rémi Verschelde
03ae26bb74
Merge pull request #43398 from KoBeWi/add_an_array_to_another_array_but_with_a_method
...
Add append_array() method to Array class
2020-11-10 13:53:58 +01:00
Rémi Verschelde
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403
...
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
2020-11-09 23:39:53 +01:00
Tomasz Chabora
9f23a94b8a
Add append_array() method to Array class
2020-11-08 21:09:45 +01:00
Rémi Verschelde
424cd00f8b
doc: Sync classref with current source + fixup some bindings
...
Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
HaSa1002
c5aded55df
Add C# code examples to the docs
...
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-26 12:29:55 +02:00
Hugo Locurcio
603eddce86
Fix a typo in the Array class documentation
...
This closes https://github.com/godotengine/godot-docs/issues/4049 .
2020-09-21 17:03:14 +02:00
Hugo Locurcio
263f620421
Improve documentation related to Array error handling
...
This closes https://github.com/godotengine/godot-docs/issues/3834 .
2020-09-09 14:57:02 +02:00
Tomasz Chabora
4ff1a34171
Mention that Array.front/back throw error if empty
2020-08-12 17:53:18 +02:00
Aaron Franke
9986439352
Commit other files changed by file_format.sh
2020-07-13 14:14:11 -04:00
Hugo Locurcio
7f01f68226
Document the in
operator in String, Array and Dictionary classes
...
This also clarifies the `in` operator behavior in Object.
2020-06-12 19:22:35 +02:00
Hugo Locurcio
675fea1648
Document that Dictionary is always passed as reference
...
See #38792 .
2020-05-16 23:52:40 +02:00
Rémi Verschelde
a2d3ba3372
doc: Sync classref with current source
...
Fix wrong binding after #37111 .
2020-03-18 09:14:57 +01:00
Rémi Verschelde
788765709d
DocData: Fix serialization of Variant default values
...
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2020-03-09 10:52:44 +01:00
Hugo Locurcio
8d53562954
doc: Mention concatenation using the +
operator in Array
...
This closes https://github.com/godotengine/godot-docs/issues/2452 .
2020-02-27 23:34:16 +01:00
Rémi Verschelde
a7e1df4b1d
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 22:02:36 +01:00
Rémi Verschelde
048f4f8305
doc: Sync classref with apparent Variant return type changes
...
Part of those seem bogus, methods like Array.back()/front()
should return a Variant and not void.
2020-02-22 15:16:32 +01:00
Rémi Verschelde
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +01:00
Rémi Verschelde
0edcb8ed58
Merge pull request #35809 from clayjohn/DOCS-update-version
...
Update docs to version 4.0
2020-02-01 19:42:31 +01:00
clayjohn
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
Hugo Locurcio
1de9118c5f
doc: Add an example for Array.sort()
...
This may help people understand the difference between alphabetical
and natural order more quickly.
2020-01-31 21:23:09 +01:00
Rémi Verschelde
2d20fc39aa
doc: Drop unused 'category' property from header
...
We already removed it from the online docs with #35132 .
Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.
We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
Michael Alexsander
c4745c96d7
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 14:41:49 -03:00
cajallen
05bbbb1225
sort_custom description and example updated
2020-01-10 12:24:49 -06:00
Ryan Roden-Corrent
e002044761
Be more specific about array return values.
...
The prior docs weren't clear if {pop_,}{front,back} would fail or return
`null` on an empty array.
2019-12-22 14:38:10 -05:00
PouleyKetchoupp
52e799b6d4
Code format for true/false/null to make documentation consistent
2019-11-02 12:14:15 +01:00
Rémi Verschelde
4f294b958f
doc: Sync classref with current source
...
Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:52:06 +02:00
Cameron Reikes
757c509437
Add array slice method
2019-09-14 13:08:28 -07:00
Hugo Locurcio
f7f6115f76
Proofread and improve the whole class reference
...
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
hbina085
d02ecd5a18
updated description of Array.shuffle to properly describe that it uses the same common seed at every runtime, thus being reproducible in general
2019-05-11 18:04:47 -04:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Chris Bradfield
08c3a2241d
[DOCS] Minor classref updates.
2019-02-24 20:30:26 -08:00
Rémi Verschelde
e588c24168
doc: Fix formatting in code blocks
2018-12-14 09:37:19 +01:00
LikeLakers2
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
VirtualBox
cfb54df986
Fix mistake in Array.xml
2018-09-10 13:42:45 +02:00
Rémi Verschelde
f92b87e5f8
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:41:14 +02:00