summaryrefslogtreecommitdiffstats
path: root/modules/gdscript/doc_classes
Commit message (Collapse)AuthorAgeFilesLines
* Tweak `@GlobalScope` & `GDScript`'s documentationMicky2023-02-141-36/+38
|
* GDScript: Improve validation and documentation of `@export_flags`Danil Alexeev2023-02-071-1/+15
|
* GDScript: Better handling of `@rpc` annotation and autocompletionDanil Alexeev2023-02-051-2/+2
|
* Improve docs for rpc annotationsGeroVeni2023-02-041-4/+12
|
* Merge pull request #72371 from dalexeev/remove-gds-str-duplicateRémi Verschelde2023-02-011-12/+0
|\ | | | | | | Remove `@GDScript.str` (duplicate of `@GlobalScope.str`)
| * Remove `@GDScript.str` (duplicate of `@GlobalScope.str`)Danil Alexeev2023-01-301-12/+0
| |
* | GDScript: Fix `@icon` annotationDanil Alexeev2023-01-311-0/+1
| |
* | GDScript: Fix `@export_enum` works only with `int`Danil Alexeev2023-01-301-3/+12
|/
* GDScript: Allow constant expressions in annotationsDanil Alexeev2023-01-251-1/+1
|
* Remove references to compiled GDScript in exportGeorge Marques2023-01-201-6/+0
| | | | | This feature was removed from GDScript so it should not be present on the interface nor in the saved export presets.
* Update `@icon` definition to add a noteAdam Scott2023-01-181-0/+2
|
* Add a note for `inst_to_dict` to prevent using it on built-in instancesYuri Rubinsky2022-12-191-0/+1
|
* Update docs to mention `@icon` only works with global script classessouplamp2022-12-011-1/+1
| | | | | | 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.
* Merge pull request #67656 from MewPurPur/instance🧹Max Hilbrunner2022-10-211-1/+1
|\ | | | | Fix minor mistakes throughout the documentation
| * Fix small mistakes throughout much of the documentationVolTer2022-10-211-1/+1
| |
* | Tweak `@GDScript` documentation overallMicky2022-10-181-48/+48
|/ | | | | | | | | | - 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.
* Fix hide_slider vs no_slider inconsistency in editor property codeAaron Franke2022-10-031-1/+1
|
* Fix typos with codespellRémi Verschelde2022-09-301-1/+1
| | | | | | | Using codespell 2.3-dev from current git. And fix typo in `methods.py` for `vsproj=yes` option (still won't work though).
* Document `print_stack()` and `get_stack()` requiring a debugger connectionHugo Locurcio2022-09-281-2/+4
|
* Spelling correction: change "no" to "not"I Woithe2022-09-171-1/+1
|
* Remove outdated assert exampleJummit2022-09-111-2/+2
|
* Rename `or_lesser` range property hint to `or_less`Hugo Locurcio2022-09-021-2/+2
| | | | | | | "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.
* Rename `str2var` to `str_to_var` and similarMicky2022-08-261-5/+5
| | | | | | | | | | | | | | | | | | 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`
* Add documentation for all annotationsYuri Sizov2022-08-191-0/+178
|
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-36/+36
|
* Add `@GDScript.type_exists` documentationRaul Santos2022-08-081-0/+5
|
* Merge pull request #47935 from HaSa1002/doc-loading-run-timeRémi Verschelde2022-07-201-0/+1
|\
| * Document how to load Images and MP3 files at run-timeJohannes Witt2022-06-161-0/+1
| |
* | Add default argument bindings to GDScript annotationsYuri Sizov2022-07-111-17/+14
| |
* | Sync GDScript doc template for new annotationsRémi Verschelde2022-07-061-0/+20
| |
* | Add support for documenting built-in annotationsYuri Sizov2022-07-041-0/+141
|/
* Improve description for GDScript built-in rangeEduardo Rodrigues2022-04-301-16/+13
| | | | | | 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.
* Fix typo in `GDScript::range` docYuri Roubinsky2022-04-201-1/+1
|
* Describe usage of float in range documentationMarkus Sauermann2022-02-181-0/+12
|
* Add an XML schema for documentationHugo Locurcio2022-02-152-2/+2
| | | | | | | | 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.
* Enchance descriptions of @GlobalScope/@GDScriptYuri Roubinsky2021-11-251-2/+2
|
* Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde2021-11-152-2/+2
|
* GDScript gracefully handle debug functions from separate threadBrian Semrau2021-11-011-2/+10
|
* doc: Update links to latest documentation after content reorganizationRémi Verschelde2021-10-061-1/+1
|
* Add an example on iterating an array backwardsHugo Locurcio2021-09-301-1/+16
| | | | This closes https://github.com/godotengine/godot-docs/issues/3472.
* Don't generate empty doc sections and reduce code duplicationAaron Franke2021-09-201-2/+0
|
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-302-64/+32
| | | | | | | | 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.
* Improve documentation for GDScript constantsHugo Locurcio2021-07-221-4/+6
|
* Rename `instance()`->`instantiate()` when it's a verbLightning_A2021-06-191-1/+1
|
* Increase String::num default decimal precisionHeikki Simojoki2021-05-291-2/+2
| | | | | | | | | | | | | | | | | | 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.
* doc: Sync classref with current sourceRémi Verschelde2021-01-041-1111/+6
|
* Rename Math::stepify to snappedMarcel Admiraal2020-12-281-6/+6
|
* Pow method doc fixskyace652020-12-131-1/+1
|
* Several edits to the GDScript docsDanil Alexeev2020-12-011-48/+36
|
* Unregister GDScriptFunctionState classGeorge Marques2020-11-261-45/+0
| | | | | This is not user accessible anymore so it does not need to be show in documentation.