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

90 Commits

Author SHA1 Message Date
Haoyu Qiu
b43fdea0d5 Classref typo fixes and improvements 2022-06-17 15:19:31 +08:00
Eduardo Rodrigues
2398db0f34 Improve description for GDScript built-in range 
Rewrites the definition of how the function works.
Reworks the style of the examples and adds a negative range example.
Changes the while loop to a range loop in the array backwards example.

(cherry picked from commit b2841ce194)
 2022-05-16 17:14:43 +02:00
Rémi Verschelde
c3065e2186
Merge pull request #60773 from timothyqiu/rand-doc 2022-05-05 18:10:14 +02:00
Haoyu Qiu
84cc0c9c47 Improve documentation of rand_range 2022-05-05 21:52:30 +08:00
Haoyu Qiu
86b14496b1 Document lerp_angle behavior when angles are approximately PI apart 
(cherry picked from commit 492903a0b2)
 2022-05-05 13:45:29 +02:00
Hugo Locurcio
b087538119
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-03-16 23:01:02 +01:00
Max Hilbrunner
717801c9cb Fix docs links in 3.x after docs reorg 2022-01-05 11:54:52 +01:00
Hugo Locurcio
a6db1c758a
Improve lerp(), lerp_angle() and inverse_lerp() documentation 
This clarifies that `lerp()` can be used both for interpolation
and extrapolation.
 2022-01-04 00:41:37 +01:00
kobewi
5caab0a8ef
Correct the doc about ease() 
(cherry picked from commit 44e6655924)
 2021-11-25 22:23:53 +01:00
Rémi Verschelde
3ac2999f22
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
Pedro J. Estébanez
a7aad78fd0 Add recursive comparison to Array and Dictionary 
...and expose it to GDScript.

Co-authored-by: Emmanuel Leblond <emmanuel.leblond@gmail.com>
 2021-11-09 15:08:22 +01:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
Rémi Verschelde
db0370cab5
Merge pull request #51086 from aaronfranke/3.x-warn-dectime 2021-10-05 12:06:03 +02:00
Hugo Locurcio
48e0212497
Add an example on iterating an array backwards 
This closes https://github.com/godotengine/godot-docs/issues/3472.

(cherry picked from commit 810d8f06b7)
 2021-10-04 15:15:27 +02:00
Hugo Locurcio
fe2f24c47c
Improve the documentation for ease() and smoothstep() 
This adds a cheatsheet for `ease()` and a comparison graph for
`smoothstep()`, among other things.

(cherry picked from commit 567b6436c9)
 2021-10-01 08:04:20 +02:00
Aaron Franke
a5543bc35e
[3.x] Warn when using the dectime method 
dectime has been removed in the master branch (what will be Godot 4.0)
 2021-09-21 10:03:42 -05:00
Rémi Verschelde
f0b37b1519
doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
Rémi Verschelde
f5836b40d4
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.

(cherry picked from commit 7adf4cc9b5)
 2021-08-03 10:20:19 +02:00
Hugo Locurcio
069281d58f
Improve documentation for GDScript constants 
(cherry picked from commit 8ff8c1e5f8)
 2021-07-24 00:59:35 +02:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde
ed44e2806f
doc: Fix markup issues in classref 2021-04-07 11:52:44 +02:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
Paul Joannon
596169d7df
class reference proofreading 
(cherry picked from commit 8455e901f3)
 2021-03-26 09:49:07 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Hugo Locurcio
ee8661158c
Document the valid input range for acos() and atan() 
(cherry picked from commit d359e159da)
 2021-03-16 11:37:26 +01:00
Angad Kambli
327586f582 fix minor issue in smooth step function's documentation 
(cherry picked from commit 892060fa47)
 2021-02-22 14:16:42 +01:00
Meriipu
347a9df0a1
GDScript: Clarified/fixed inaccuracies in the built-in function docs. 
The input to smoothstep is not actually a weight, and the decscription
of smoothstep was pretty hard to understand and easy to misinterpret.

Clarified what it means to be approximately equal.

nearest_po2 does not do what the descriptions says it does. For one,
it returns the same power if the input is a power of 2. Second, it
returns 0 if the input is negative or 0, while the smallest possible
integral power of 2 actually is 1 (2^0 = 1). Due to the implementation
and how it is used in a lot of places, it does not seem wise to change
such a core function however, and I decided it is better to alter the
description of the built-in.

Added a few examples/clarifications/edge-cases.

(cherry picked from commit 7f9bfee0ac)
 2021-02-11 13:12:06 +01:00
Rémi Verschelde
3d31433229
doc: Remove links to RNG tutorial, not yet in 3.2 branch 2021-01-07 14:33:36 +01:00
LoipesMas
0fc433d046
More explicit wording for str() and print() functions 
(cherry picked from commit 9c65927aeb)
 2021-01-05 21:33:34 +01:00
skyace65
e072b3db82
Pow method doc fix 
(cherry picked from commit 4fd20015f3)
 2020-12-29 16:01:59 +01:00
Danil Alexeev
6c3a0e3a5a
Several edits to the GDScript docs 
(cherry picked from commit bf96056ad0)
 2020-12-09 11:22:03 +01:00
Hugo Locurcio
913afd843b
Clarify that code in assert() should avoid side effects 
(cherry picked from commit d6c7073bd7)
 2020-11-11 15:44:18 +01:00
Rémi Verschelde
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
Hugo Locurcio
8d445f3f9f
Link the Random number generation tutorial in the class reference 
(cherry picked from commit 802c1e4df1)
 2020-10-19 16:10:00 +02:00
Serhat
09a8dd7b3b
Fixed padding bug of sprintf function 
(cherry picked from commit 9f2cdfea82)
 2020-10-04 20:51:58 +02:00
Andrii Doroshenko (Xrayez)
1a71792655
Cross-reference GDScript load and ResourceLoader.load in classref 
The GDScript `load` mention is moved from the class `ResourceLoader`
description to the `ResourceLoader.load` method description instead,
where it is more likely to be found.

(cherry picked from commit a8404cf56c)
 2020-10-04 20:51:40 +02:00
Hugo Locurcio
880ab559ec
Improve documentation related to printing error/warning messages 
(cherry picked from commit 50f3a8e312)
 2020-09-29 08:54:45 +02:00
Danil Alexeev
06f3cd8bd8
Several documentation improvements 
(cherry picked from commit a4c5790350)
 2020-09-15 19:26:40 +02:00
Hugo Locurcio
afef89014b
Cross-reference GDScript built-in rounding methods to ease discovery 
This closes #19315.

(cherry picked from commit 20d0f5bbd7)
 2020-08-31 15:29:42 +02:00
Hugo Locurcio
fc7451204e Improve JSON-related documentation 
This closes https://github.com/godotengine/godot-docs/issues/3848.

(cherry picked from commit 930e10ffff)
 2020-07-31 13:09:21 +02:00
Rémi Verschelde
6d2f8dd827 doc: Sync classref with current source 2020-07-30 16:26:45 +02:00
Aaron Franke
3ab5183ffa
[3.2] Backport core documentation changes to 3.2 
Also add AABB.abs()
 2020-07-21 21:22:54 -04:00
Tomasz Chabora
5b7eb3fd3f Improve the preload and load descriptions 
(cherry picked from commit 13298ed873)
 2020-06-29 10:58:25 +02:00
Rémi Verschelde
253fc093b8 DocData: Skip unexposed classes 
Properly expose classes that we actually want accessible.

(cherry picked from commit 0ef8bcac4d)
 2020-04-21 14:15:34 +02:00
Thomas ten Cate
c2469d0c6d Add missing docs for assert message in GDScript 
Seems like this was overlooked in PR #31142. See also issue #17082.

(cherry picked from commit 4c3c73ef9c)
 2020-04-06 18:17:59 +02:00
Hugo Locurcio
d679edfa7f Add a practical example for @GDScript.linear2db() 
One of its most common applications in games is for volume sliders.

See https://www.dr-lex.be/info-stuff/volumecontrols.html for
more information.

(cherry picked from commit a6fd6b78dd)
 2020-03-04 12:40:14 +01:00
Hugo Locurcio
21a45dda7a Improve the @GDScript.inverse_lerp() documentation 
This closes https://github.com/godotengine/godot-docs/issues/2589.

(cherry picked from commit 6b5573700b)
 2020-03-04 12:40:14 +01:00
Rémi Verschelde
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property 
doc: Drop unused 'category' property from header
 2020-01-26 16:34:13 +01:00
Rémi Verschelde
09ced94dd4 doc: Do not expose Variant::NIL as a type in the class reference 
Fix signals Variant arguments incorrectly listed as Nil.

Fixes #12520.
 2020-01-26 16:08:11 +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