godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
29,789 Commits 15 Branches 59 Tags 2.2 GiB
Commit Graph

61 Commits

Author SHA1 Message Date
kobewi e5dc7a06a9
Improve sort_custom() description 
(cherry picked from commit 48f0368ddc)
 2021-06-07 22:49:37 +02:00
Rémi Verschelde 1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Haoyu Qiu 2003a41f0f Fixes typo in Array::bsearch_custom doc 
(cherry picked from commit 31243e377f)
 2021-02-26 11:29:35 +01:00
hungrymonkey 1716423c97 Added sample code to the bsearch_custom function 
bsearch_custom arguments

name - type - description
value - Variant - bisection search value
obj - Any object instance - Location of the 2 argument comparison function
func - String - Name of the function declared in obj
before - boolean - first and second resolver

Fixes https://github.com/godotengine/godot-docs/issues/4564
 2021-02-22 15:55:33 +01:00
Hugo Locurcio 1c9ee4baa2
Improve the `Array.hash()` documentation 
Co-authored-by: Laguzus <67963093+Laguzus@users.noreply.github.com>
(cherry picked from commit 435848192e)
 2021-01-26 22:10:30 +01:00
Hugo Locurcio e2a2005a48
Document low performance of `Array.push_front()` and `Array.pop_front()` 
(cherry picked from commit 7ce3cc0478)
 2021-01-26 17:00:16 +01:00
Hugo Locurcio e53a5f6be5
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.

(cherry picked from commit 5325de4e6b)
 2020-11-17 12:07:02 +01:00
Rémi Verschelde a57b6eb211
doc: Sync classref with current source 
Move EditorSceneImporterFBX doc to its module folder.
 2020-11-11 17:00:41 +01:00
Tomasz Chabora 98774000e2
Add append_array() method to Array class 
(cherry picked from commit 9f23a94b8a)
 2020-11-11 15:44:14 +01:00
Hugo Locurcio e07ac3d77e
Fix a typo in the Array class documentation 
This closes https://github.com/godotengine/godot-docs/issues/4049.

(cherry picked from commit 603eddce86)
 2020-09-24 14:43:07 +02:00
Hugo Locurcio 74952764f3
Improve documentation related to Array error handling 
This closes https://github.com/godotengine/godot-docs/issues/3834.

(cherry picked from commit 263f620421)
 2020-09-10 12:04:07 +02:00
Tomasz Chabora f592600ee8 Mention that Array.front/back throw error if empty 
(cherry picked from commit 4ff1a34171)
 2020-08-14 00:32:05 +02:00
Rémi Verschelde b40f3f9740 Style: Sync other changes from new fix_style.sh and clang_format.sh 2020-07-24 10:39:18 +02:00
Hugo Locurcio 5a1f94ba47 Document the `in` operator in String, Array and Dictionary classes 
This also clarifies the `in` operator behavior in Object.

(cherry picked from commit 7f01f68226)
 2020-06-15 14:34:34 +02:00
Hugo Locurcio 8ebcdeb3d7 Document that Dictionary is always passed as reference 
See #38792.

(cherry picked from commit 675fea1648)
 2020-05-18 16:40:33 +02:00
Rémi Verschelde df2a2ae0fc DocData: Fix serialization of Variant default values 
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
(cherry picked from commit 788765709d)
 2020-03-09 11:36:57 +01:00
Hugo Locurcio 1191766609 doc: Mention concatenation using the `+` operator in Array 
This closes https://github.com/godotengine/godot-docs/issues/2452.

(cherry picked from commit 8d53562954)
 2020-03-04 12:40:15 +01:00
Hugo Locurcio 47368f2b7c doc: Add an example for `Array.sort()` 
This may help people understand the difference between alphabetical
and natural order more quickly.

(cherry picked from commit 1de9118c5f)
 2020-02-06 13:02:08 +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
Rémi Verschelde 5267099a87 doc: Sync classref with current source 2018-08-29 22:25:11 +02:00
Michael Alexsander Silva Dias 79ab43299a Small doc formating changes and Linux cursor theme note 2018-08-05 04:07:04 -03:00
Rémi Verschelde adb16be6b9 Doc: Add example for array indexing 
Supersedes and closes #20180.
 2018-07-17 11:47:27 +02:00
Max Hilbrunner 9115d84913
[DOCS] Array sort 2018-05-25 16:55:56 +02:00
Rémi Verschelde cb7fe2c793 doc: Sync classref with current source 2018-04-10 10:12:42 +02:00
Rémi Verschelde 3fa77b3172 doc: Remove status from hardcoded version string 
It has no practical use case and just generates noise for each alpha, beta, etc.
 2018-02-27 13:40:49 +01:00
Poommetee Ketson eb63f7b071 [DOCS] Sync classref with current source 2018-02-25 15:14:25 +07:00
Rémi Verschelde 37a6ce5a42
Merge pull request #15563 from poke1024/gdscript-shuffle 
Add shuffle() method to Array
 2018-02-19 21:53:08 +01:00
Rémi Verschelde 3c7a39b40c doc: Update version string in header 2018-02-19 10:46:33 +01:00
Rémi Verschelde d516aab8fa doc: Sync with current source 
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
 2018-01-25 08:50:56 +01:00
Rémi Verschelde e28cdc4654 doc: Update version string in XML 2018-01-13 11:43:42 +01:00
poke1024 75d69fb4ec Add shuffle() method to Array 2018-01-10 19:36:53 +01:00
Ralph Minderhoud 9ab59343f4 Added example for Array sort_custom function 2017-12-08 18:06:45 -06:00
Rémi Verschelde bc75fae579 doc: Update header version for 3.0-beta 2017-11-24 09:16:52 +01:00