04562662d3
Overhaul the top sections of the class reference (Core classes)
2023-05-19 07:04:48 +02:00
ad21fb0f92
Docs: Point to @GDScript in GDscript (script impl)
2023-05-17 13:47:33 +02:00
a6ac305f96
Rework Navigation Avoidance
...
Rework Navigation Avoidance.
2023-05-10 05:01:58 +02:00
febc674f48
Document caveats related to exported project binary resource conversion
2023-05-08 07:02:00 +02:00
921d231ad6
Merge pull request #76664 from Xenoparrot/simple-typos
2023-05-06 15:41:55 +02:00
ce75c46331
Merge pull request #76650 from Koyper/gdscript_range_docs
2023-05-05 17:09:56 +02:00
8106d33d0f
Fixed various typos across the docs
2023-05-02 18:24:32 -04:00
bcce315a9a
Update @GDScript.xml range docs to iterate backwards.
2023-05-01 11:03:48 -05:00
0ba6048ad3
Add support for static variables in GDScript
...
Which allows editable data associated with a particular class instead of
the instance. Scripts with static variables are kept in memory
indefinitely unless the `@static_unload` annotation is used or the
`static_unload()` method is called on the GDScript.
If the custom function `_static_init()` exists it will be called when
the class is loaded, after the static variables are set.
2023-04-27 09:51:44 -03:00
391eccca76
Validate code tags in documentation for potential params
...
Adds a check to make_rst to look for matches
between the text inside of the [code][/code] tag
and known param identifiers.
Fixes most of what was revealed.
2023-04-26 21:36:04 +02:00
e1c0df7048
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".
2023-03-31 20:30:29 +00:00
4e4555bea5
Improve Color8 documentation
...
This documents in which situations Color8 is most suited and its
precision limitations.
2023-03-19 17:42:15 +01:00
ea5fd3d732
Fix GDScript code style regarding colon
2023-03-05 17:03:20 +03:00
1c1524a651
Bump version to 4.1-dev
...
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +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
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
VolTer
Max Hilbrunner
smix8
Hugo Locurcio
Max Hilbrunner
UltraBIF
Koyper
George Marques
Yuri Sizov
Araraura
Danil Alexeev
Rémi Verschelde
Dmitrii Maganov
Micky
GeroVeni
Adam Scott
Yuri Rubinsky
souplamp
Aaron Franke
I Woithe
Jummit
Raul Santos
Rémi Verschelde
Johannes Witt
Eduardo Rodrigues
Markus Sauermann