8fe023ad93
GDScript: Rework type check
2023-02-17 19:57:18 +02:00
436bbfebe2
Tweak `@GlobalScope` & `GDScript`'s documentation
2023-02-14 13:26:18 +01:00
c8e3d8b5d5
GDScript: Improve validation and documentation of `@export_flags`
2023-02-07 19:32:08 +03:00
31749de128
GDScript: Better handling of `@rpc` annotation and autocompletion
2023-02-05 21:21:37 +03:00
54f2226ce5
Improve docs for rpc annotations
2023-02-04 13:28:41 +00:00
ab2f8ab6ce
Merge pull request #72371 from dalexeev/remove-gds-str-duplicate
...
Remove `@GDScript.str` (duplicate of `@GlobalScope.str`)
2023-02-01 07:25:02 +01:00
83cb968965
GDScript: Fix `@icon` annotation
2023-01-31 17:43:54 +03:00
be4f36b87e
Remove `@GDScript.str` (duplicate of `@GlobalScope.str`)
2023-01-30 14:29:07 +03:00
d4b78c352f
GDScript: Fix `@export_enum` works only with `int`
2023-01-30 12:30:37 +03:00
b004f8180e
GDScript: Allow constant expressions in annotations
2023-01-25 18:43:56 +03:00
7e5c2f945d
Remove references to compiled GDScript in export
...
This feature was removed from GDScript so it should not be present on
the interface nor in the saved export presets.
2023-01-20 15:09:07 -03:00
807b7ed557
Update `@icon` definition to add a note
2023-01-18 19:48:01 -05:00
78d296d7ca
Add a note for `inst_to_dict` to prevent using it on built-in instances
2022-12-19 19:12:00 +03:00
369c7d2422
Update docs to mention `@icon` only works with global script classes
...
Update the docs to clarify that the `@icon` annotation does not work
when only attaching a script to a node, and clarify that the script itself
must be a globally accessible script type.
2022-12-01 12:52:58 -06:00
13138b307b
Merge pull request #67656 from MewPurPur/instance 🧹
...
Fix minor mistakes throughout the documentation
2022-10-21 18:19:32 +02:00
05a9637d5d
Fix small mistakes throughout much of the documentation
2022-10-21 00:20:59 +02:00
a34cf161aa
Tweak `@GDScript` documentation overall
...
- Made use of [param] more frequently,
- Link to other classes' documentation more often, improve the examples.
- Made the writing style closer to how the rest of the documentation is formatted.
- Ensure these are called "functions", not "methods".
- Add [b]Warning:[/b] where more appropriate than [b]Note:[/b]
Most notably, removed " It must be a static string, so format strings can't be used.", as this behavior is actually a bug.
2022-10-18 22:54:46 +02:00
094e8db97c
Fix hide_slider vs no_slider inconsistency in editor property code
2022-10-03 13:40:31 -05:00
166df0896c
Fix typos with codespell
...
Using codespell 2.3-dev from current git.
And fix typo in `methods.py` for `vsproj=yes` option (still won't work
though).
2022-09-30 14:23:36 +02:00
530e31d4a3
Document `print_stack()` and `get_stack()` requiring a debugger connection
2022-09-28 12:24:39 +02:00
4c785ae3f8
Spelling correction: change "no" to "not"
2022-09-17 21:02:54 +09:30
899b73e01d
Remove outdated assert example
2022-09-11 07:55:03 +02:00
f7292dbeb3
Rename `or_lesser` range property hint to `or_less`
...
"less" should be used for quantity, rather than "lesser".
Existing scripts that use `or_lesser` in `_get_property_list()`
will need to be updated to account for this change.
2022-09-02 19:08:20 +02:00
59e11934d8
Rename `str2var` to `str_to_var` and similar
...
Affects the Math class, a good chunk of the audio code, and a lot of other miscellaneous classes, too.
- `var2str` -> `var_to_str`
- `str2var` -> `str_to_var`
- `bytes2var` -> `bytes_to_var`
- `bytes2var_with_objects` -> `bytes_to_var_with_objects`
- `var2bytes` -> `var_to_bytes`
- `var2bytes_with_objects` -> `var_to_bytes_with_objects`
- `linear2db` -> `linear_to_db`
- `db2linear` -> `db_to_linear`
- `deg2rad` -> `deg_to_rad`
- `rad2deg` -> `rad_to_deg`
- `dict2inst` -> `dict_to_inst`
- `inst2dict` -> `inst_to_dict`
2022-08-26 14:58:22 +02:00
a0995182fe
Add documentation for all annotations
2022-08-19 15:06:39 +03:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
e47ba81050
Add `@GDScript.type_exists` documentation
2022-08-08 15:40:32 +02:00
fa2dcc7ace
Merge pull request #47935 from HaSa1002/doc-loading-run-time
2022-07-20 22:33:49 +02:00
316f78a037
Add default argument bindings to GDScript annotations
2022-07-11 23:02:55 +03:00
09e12ba9b4
Sync GDScript doc template for new annotations
2022-07-06 16:37:40 +02:00
a9098e6147
Add support for documenting built-in annotations
2022-07-04 20:21:39 +03:00
8c7d4996c9
Document how to load Images and MP3 files at run-time
2022-06-16 13:18:36 +02:00
b2841ce194
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.
2022-04-30 15:17:17 -03:00
540fca147d
Fix typo in `GDScript::range` doc
2022-04-20 19:38:49 +03:00
bac8e451c0
Describe usage of float in range documentation
2022-02-18 00:59:22 +01:00
b68dd2e189
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-02-15 00:03:31 +01:00
ce48604eb7
Enchance descriptions of @GlobalScope/@GDScript
2021-11-25 14:24:09 +03:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
d3051b2637
GDScript gracefully handle debug functions from separate thread
2021-11-01 12:13:25 -04:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
810d8f06b7
Add an example on iterating an array backwards
...
This closes https://github.com/godotengine/godot-docs/issues/3472 .
2021-09-30 20:29:57 +02:00
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05:00
7adf4cc9b5
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.
2021-07-30 15:29:52 +02:00
8ff8c1e5f8
Improve documentation for GDScript constants
2021-07-22 09:50:24 +02:00
e28fd07b2b
Rename `instance()`->`instantiate()` when it's a verb
2021-06-19 20:49:18 -06:00
09a905ca80
Increase String::num default decimal precision
...
Fixes #34541
Renamed MAX_DIGITS to MAX_DECIMALS, since it only changes the
amount of digits after the decimal point.
Increased MAX_DECIMALS to 32, and made String::num use
MAX_DECIMALS consistently. If -1 is passed as
decimal precision to String::num, it now gets changed to
the correct precision based on the number's magnitude,
instead of using printf default(which is 6)
String::num_real also calculates the correct precision now.
Also made the types used in floating-point math more
consistent in a few places.
2021-05-29 11:24:57 -04:00
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
b743a2ef3c
Rename Math::stepify to snapped
2020-12-28 13:01:30 +00:00
4fd20015f3
Pow method doc fix
2020-12-13 17:53:30 -05:00
bf96056ad0
Several edits to the GDScript docs
2020-12-01 16:05:10 +03:00
fbb806fd68
Unregister GDScriptFunctionState class
...
This is not user accessible anymore so it does not need to be show in
documentation.
2020-11-26 21:39:54 -03:00
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
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
d6c7073bd7
Clarify that code in `assert()` should avoid side effects
2020-11-09 21:48:24 +01:00
38fb26794b
Exposed randi_range to global funcs + renamed rand_range to randf_range
2020-11-06 17:06:26 +03:00
802c1e4df1
Link the Random number generation tutorial in the class reference
2020-10-14 18:03:29 +02:00
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
9f2cdfea82
Fixed padding bug of sprintf function
2020-10-02 00:25:42 +03:00
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
50f3a8e312
Improve documentation related to printing error/warning messages
2020-09-24 14:23:53 +02:00
a4c5790350
Several documentation improvements
2020-09-14 20:02:19 +03:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
20d0f5bbd7
Cross-reference GDScript built-in rounding methods to ease discovery
...
This closes #19315 .
2020-08-28 17:04:22 +02:00
ba853f86af
Merge pull request #40903 from Calinou/doc-json
...
Improve JSON-related documentation
2020-07-31 10:39:56 +02:00
930e10ffff
Improve JSON-related documentation
...
This closes https://github.com/godotengine/godot-docs/issues/3848 .
2020-07-31 09:56:11 +02:00
9833f9cc11
doc: Fix typo in BBcode tag
2020-07-30 16:24:37 +02:00
932b75e247
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
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
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
13298ed873
Improve the preload and load descriptions
2020-06-28 20:51:46 +02:00
540156b387
[Core] Rename linear_interpolate to lerp
2020-04-29 04:02:49 -04:00
0ef8bcac4d
DocData: Skip unexposed classes
...
Properly expose classes that we actually want accessible.
2020-04-20 12:51:10 +02:00
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
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
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
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
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
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
bd78b9f445
Remove deprecated decimals builtin
...
Replaced by 'step_decimals' in 3.2 via #21425 .
2020-02-12 13:39:39 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08: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
Dmitrii Maganov
Micky
Danil Alexeev
GeroVeni
Rémi Verschelde
George Marques
Adam Scott
Yuri Rubinsky
souplamp
Max Hilbrunner
VolTer
Aaron Franke
Hugo Locurcio
I Woithe
Jummit
Yuri Sizov
Raul Santos
Rémi Verschelde
Johannes Witt
Eduardo Rodrigues
Markus Sauermann
Brian Semrau
Lightning_A
Heikki Simojoki
Marcel Admiraal
skyace65
Serhat
Andrii Doroshenko (Xrayez)
Meriipu
Tomasz Chabora
Thomas ten Cate
clayjohn
Haoyu Qiu
Zak
Michael Alexsander
miere43
Yeongho Kim