Danil Alexeev
bf96056ad0
Several edits to the GDScript docs
2020-12-01 16:05:10 +03:00
Rémi Verschelde
68067b8d97
Merge pull request #43423 from Calinou/doc-assert-avoid-side-effects
...
Clarify that code in `assert()` should avoid side effects
2020-11-10 11:31:28 +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
Hugo Locurcio
d6c7073bd7
Clarify that code in assert() should avoid side effects
2020-11-09 21:48:24 +01:00
Yuri Roubinsky
38fb26794b
Exposed randi_range to global funcs + renamed rand_range to randf_range
2020-11-06 17:06:26 +03:00
Hugo Locurcio
802c1e4df1
Link the Random number generation tutorial in the class reference
2020-10-14 18:03:29 +02:00
Rémi Verschelde
3556bc48a1
Merge pull request #42439 from Xrayez/doc-gdscript-load-and-resloader-xref
...
Cross-reference GDScript `load` and `ResourceLoader.load` in classref
2020-10-04 20:48:07 +02:00
Serhat
9f2cdfea82
Fixed padding bug of sprintf function
2020-10-02 00:25:42 +03:00
Andrii Doroshenko (Xrayez)
a8404cf56c
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.
2020-09-30 23:03:36 +03:00
Hugo Locurcio
50f3a8e312
Improve documentation related to printing error/warning messages
2020-09-24 14:23:53 +02:00
Danil Alexeev
a4c5790350
Several documentation improvements
2020-09-14 20:02:19 +03:00
Hugo Locurcio
20d0f5bbd7
Cross-reference GDScript built-in rounding methods to ease discovery
...
This closes #19315 .
2020-08-28 17:04:22 +02:00
Rémi Verschelde
ba853f86af
Merge pull request #40903 from Calinou/doc-json
...
Improve JSON-related documentation
2020-07-31 10:39:56 +02:00
Hugo Locurcio
930e10ffff
Improve JSON-related documentation
...
This closes https://github.com/godotengine/godot-docs/issues/3848 .
2020-07-31 09:56:11 +02:00
Rémi Verschelde
9833f9cc11
doc: Fix typo in BBcode tag
2020-07-30 16:24:37 +02:00
Rémi Verschelde
932b75e247
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
Meriipu
7f9bfee0ac
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.
2020-07-25 20:26:02 +02:00
Aaron Franke
83e324d670
Update core documentation to match recent C# changes
...
Also a few minor API changes like adding AABB.abs()
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com >
2020-07-21 14:44:53 -04:00
Tomasz Chabora
13298ed873
Improve the preload and load descriptions
2020-06-28 20:51:46 +02:00
Aaron Franke
540156b387
[Core] Rename linear_interpolate to lerp
2020-04-29 04:02:49 -04:00
Thomas ten Cate
4c3c73ef9c
Add missing docs for assert message in GDScript
...
Seems like this was overlooked in PR #31142 . See also issue #17082 .
2020-03-31 19:56:44 +02:00
Rémi Verschelde
eaaee63b62
doc: Update classref with node renames
...
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
Rémi Verschelde
807b511125
Merge pull request #36620 from Calinou/doc-linear2db-example
...
Add a practical example for `@GDScript.linear2db()`
2020-02-28 07:03:35 +01:00
Hugo Locurcio
a6fd6b78dd
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.
2020-02-27 22:52:21 +01:00
Hugo Locurcio
6b5573700b
Improve the @GDScript.inverse_lerp() documentation
...
This closes https://github.com/godotengine/godot-docs/issues/2589 .
2020-02-27 22:49:05 +01:00