summaryrefslogtreecommitdiff
path: root/modules/gdscript/doc_classes
AgeCommit message (Collapse)Author
2023-05-18Docs: Point to @GDScript in GDscript (script impl)Max Hilbrunner
(cherry picked from commit ad21fb0f9261de6a3b82b5267253efb5f6a019fa)
2023-05-12Document caveats related to exported project binary resource conversionHugo Locurcio
(cherry picked from commit febc674f4818dd1185b2e43e899115f70f55b4f5)
2023-05-12Fixed various typos across the docsUltraBIF
(cherry picked from commit 8106d33d0f13825b4459898ca20282ba5b543897)
2023-04-03Fix typo and slightly reword in @GDScript.xmlAraraura
Fix "the every following property" to "then every following property" and change "is added" to "will be added". (cherry picked from commit e1c0df70485266e0385aed4962934bb26cb325e9)
2023-03-27Improve Color8 documentationHugo Locurcio
This documents in which situations Color8 is most suited and its precision limitations. (cherry picked from commit 4e4555bea56fd9fd0734b0d6d0800977f9976b95)
2023-03-13Fix GDScript code style regarding colonDanil Alexeev
(cherry picked from commit ea5fd3d732a85029e8372425904971ad26153ff1)
2023-02-22Document `@GDScript.is_instance_of` methodDanil Alexeev
2023-02-17GDScript: Rework type checkDmitrii Maganov
2023-02-14Tweak `@GlobalScope` & `GDScript`'s documentationMicky
2023-02-07GDScript: Improve validation and documentation of `@export_flags`Danil Alexeev
2023-02-05GDScript: Better handling of `@rpc` annotation and autocompletionDanil Alexeev
2023-02-04Improve docs for rpc annotationsGeroVeni
2023-02-01Merge pull request #72371 from dalexeev/remove-gds-str-duplicateRĂ©mi Verschelde
Remove `@GDScript.str` (duplicate of `@GlobalScope.str`)
2023-01-31GDScript: Fix `@icon` annotationDanil Alexeev
2023-01-30Remove `@GDScript.str` (duplicate of `@GlobalScope.str`)Danil Alexeev
2023-01-30GDScript: Fix `@export_enum` works only with `int`Danil Alexeev
2023-01-25GDScript: Allow constant expressions in annotationsDanil Alexeev
2023-01-20Remove references to compiled GDScript in exportGeorge Marques
This feature was removed from GDScript so it should not be present on the interface nor in the saved export presets.
2023-01-18Update `@icon` definition to add a noteAdam Scott
2022-12-19Add a note for `inst_to_dict` to prevent using it on built-in instancesYuri Rubinsky
2022-12-01Update docs to mention `@icon` only works with global script classessouplamp
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-10-21Merge pull request #67656 from MewPurPur/instanceđŸ§¹Max Hilbrunner
Fix minor mistakes throughout the documentation
2022-10-21Fix small mistakes throughout much of the documentationVolTer
2022-10-18Tweak `@GDScript` documentation overallMicky
- 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-03Fix hide_slider vs no_slider inconsistency in editor property codeAaron Franke
2022-09-30Fix typos with codespellRĂ©mi Verschelde
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-28Document `print_stack()` and `get_stack()` requiring a debugger connectionHugo Locurcio
2022-09-17Spelling correction: change "no" to "not"I Woithe
2022-09-11Remove outdated assert exampleJummit
2022-09-02Rename `or_lesser` range property hint to `or_less`Hugo Locurcio
"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-08-26Rename `str2var` to `str_to_var` and similarMicky
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-19Add documentation for all annotationsYuri Sizov
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-08-08Add `@GDScript.type_exists` documentationRaul Santos
2022-07-20Merge pull request #47935 from HaSa1002/doc-loading-run-timeRĂ©mi Verschelde
2022-07-11Add default argument bindings to GDScript annotationsYuri Sizov
2022-07-06Sync GDScript doc template for new annotationsRĂ©mi Verschelde
2022-07-04Add support for documenting built-in annotationsYuri Sizov
2022-06-16Document how to load Images and MP3 files at run-timeJohannes Witt
2022-04-30Improve description for GDScript built-in rangeEduardo Rodrigues
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-20Fix typo in `GDScript::range` docYuri Roubinsky
2022-02-18Describe usage of float in range documentationMarkus Sauermann
2022-02-15Add an XML schema for documentationHugo Locurcio
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.
2021-11-25Enchance descriptions of @GlobalScope/@GDScriptYuri Roubinsky
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRĂ©mi Verschelde
2021-11-01GDScript gracefully handle debug functions from separate threadBrian Semrau
2021-10-06doc: Update links to latest documentation after content reorganizationRĂ©mi Verschelde
2021-09-30Add an example on iterating an array backwardsHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/3472.
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-07-30doc: Use self-closing tags for `return` and `argument`RĂ©mi Verschelde
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.