4b63ce83d2
Fixed various typos across the docs
...
(cherry picked from commit 8106d33d0f
2023-05-12 12:07:02 +02:00
d0e906327d
Fix typo and slightly reword in @GDScript.xml
...
Fix "the every following property" to "then every following property" and change "is added" to "will be added".
(cherry picked from commit e1c0df7048
2023-04-03 18:41:54 +02:00
9559bbcb18
Improve Color8 documentation
...
This documents in which situations Color8 is most suited and its
precision limitations.
(cherry picked from commit 4e4555bea5
2023-03-27 17:35:47 +02:00
f4ea9df0f4
Fix GDScript code style regarding colon
...
(cherry picked from commit ea5fd3d732
2023-03-13 14:42:27 +01:00
a98a0f5d34
Document `@GDScript.is_instance_of` method
2023-02-22 17:06:55 +03:00
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
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
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
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
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
UltraBIF
Araraura
Hugo Locurcio
Danil Alexeev
Dmitrii Maganov
Micky
GeroVeni
Rémi Verschelde
Adam Scott
Yuri Rubinsky
souplamp
Aaron Franke
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