880ab559ec
Improve documentation related to printing error/warning messages
...
(cherry picked from commit 50f3a8e312
2020-09-29 08:54:45 +02:00
06f3cd8bd8
Several documentation improvements
...
(cherry picked from commit a4c5790350
2020-09-15 19:26:40 +02:00
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
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
6d2f8dd827
doc: Sync classref with current source
2020-07-30 16:26:45 +02:00
3ab5183ffa
[3.2] Backport core documentation changes to 3.2
...
Also add AABB.abs()
2020-07-21 21:22:54 -04:00
5b7eb3fd3f
Improve the preload and load descriptions
...
(cherry picked from commit 13298ed873
2020-06-29 10:58:25 +02:00
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
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
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
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
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
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
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
cbdbfb00ca
doc: Document named color constants
...
Busywork but it's good for our completion rate :)
2020-01-26 12:08:16 +01:00
74977277fa
Merge pull request #34280 from zaksnet/fix-yield-documentation
...
Fix documentation for yield
2019-12-16 08:49:32 +01:00
468fcd80bb
Updates docs for GDScript built-in functions
...
* Adds description for `ord()`
* Adds relationship description between `char()` and `ord()`
* Describes the argument of `char()` as Unicode code point instead of ASCII code
* Fixes wrong interval notation in `randi()` description
2019-12-15 19:06:29 +08:00
0fd7186971
Fix documentation for yield
...
#33872 PR was misleading as i though inheritance from GDScriptFunctionState was optional.
2019-12-13 11:17:12 +02:00
6cc3bb2d9b
Add note in 'load()' docs that the path must be absolute
2019-12-11 17:14:58 -03:00
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
1fcdeaee39
Mention that `int()` can be used as an alternative to `floor()`
2019-12-03 08:43:24 +01:00
3231fca934
Add docs for is_equal_approx on structures
2019-11-30 16:52:27 -05:00
d747c61187
Fixed typo in docs for Script and GDScript classes ("exends" -> "extends")
2019-11-30 21:16:11 +03:00
4f14a1f59c
Remove type hint from the @GDScript class documentation
...
The current consensus in the Godot documentation is to avoid using
type hints unless they're relevant to the behavior explained.
2019-11-26 19:13:55 +01:00
5cfff77ca6
Added missing documentation for yield()
...
Added some missing documentation about yield() being able to wait for a function also. I cant believe something like that was missing from the docs, it would have saved me so much time (and others i assume).
2019-11-25 18:08:18 +02:00
91518defa5
Merge pull request #33257 from aaronfranke/printraw
...
Document behavior of GDScript printraw
2019-11-07 13:21:09 +01:00
c4e46b8800
Document behavior of printraw
2019-11-02 04:55:39 -04:00
b67f252016
Fix Color8 GDScript documentation
2019-11-02 04:48:08 -04:00
d4a55fb639
Print errors when tab indent found in [codeblock]
2019-10-01 23:39:45 +09:00
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
65d61d0360
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
02ed79f7f7
Updated description for "stepify"
...
Mentioned the possibility to use stepify as a rounding function; +code examples
2019-08-29 14:03:18 +02:00
a2c81a7455
Add a reference to pow to the description of exp.
...
This might be especially usefull since godot script doesn't support ** or ^ as operators, so beginners might search for the exponential function, when what they really need is the pow function.
This is exactly what happened to me and since I couldn't find helpfull information in the documentation I had to look it up online, where I found the answer on a helpfull [reddit thread](https://www.reddit.com/r/godot/comments/3mvwz0/how_do_i_do_exponents_in_godot/ ).
@akien-mga told me how to reference methods here:
godotengine#30909
2019-07-29 18:17:52 +02:00
d844e30614
Inspector: Make default float step configurable
...
Also allow lifting the decimal step formatting with a hint range step
of 0. A new `range_step_decimals()` is added for this to avoid breaking
compatibility on the general purpose `step_decimals()` (which still
returns 0 for an input step of 0).
Supersedes #25470 .
Partial fix for #18251 .
2019-07-23 17:31:38 +02:00
07e289963c
doc: Sync classref with current source
2019-07-22 12:27:52 +02:00
6694c119d0
Added lerp_angles built-in function
...
Co-authored-by: Xrayez <https://github.com/Xrayez >
Co-authored-by: DleanJeans <https://github.com/DleanJeans >
2019-07-20 12:59:41 +03:00
a60f242982
Add integer posmod and rename default arg names
...
"posmod" is the integer version of "fposmod". We do not need a "mod" because of the % operator.
I changed the default arg names from "x" and "y" to "a" and "b" because they are not coordinates. I also changed pow's arg names to "base" and "exp". Also, I reorganized the code in the VS built-in funcs switch statement.
2019-07-18 16:33:43 -04:00
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
4c137bebe8
Extends wrapi/wrapf docs
2019-06-25 14:12:37 +03:00
0764451dc5
doc: Improve docs for Resource* classes
...
Also move module-specific classes to their own module's `doc_classes`
folder.
2019-06-18 20:07:26 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
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
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +01:00
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
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
Hugo Locurcio
Danil Alexeev
Rémi Verschelde
Aaron Franke
Tomasz Chabora
Thomas ten Cate
Haoyu Qiu
Zak
Michael Alexsander
miere43
Yeongho Kim
Thomas Karcher
Kaligule
Chaosus
robojumper
Juan Linietsky