summaryrefslogtreecommitdiff
path: root/modules/gdscript/doc_classes/@GDScript.xml
AgeCommit message (Collapse)Author
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-09-30Add an example on iterating an array backwardsHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/3472.
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.
2021-07-22Improve documentation for GDScript constantsHugo Locurcio
2021-06-19Rename `instance()`->`instantiate()` when it's a verbLightning_A
2021-05-29Increase String::num default decimal precisionHeikki Simojoki
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-01-04doc: Sync classref with current sourceRémi Verschelde
2020-12-28Rename Math::stepify to snappedMarcel Admiraal
2020-12-13Pow method doc fixskyace65
2020-12-01Several edits to the GDScript docsDanil Alexeev
2020-11-10Merge pull request #43423 from Calinou/doc-assert-avoid-side-effectsRémi Verschelde
Clarify that code in `assert()` should avoid side effects
2020-11-09Variant: Sync docs with new constructors, fixups after #43403Rémi Verschelde
Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09Clarify that code in `assert()` should avoid side effectsHugo Locurcio
2020-11-06Exposed randi_range to global funcs + renamed rand_range to randf_rangeYuri Roubinsky
2020-10-14Link the Random number generation tutorial in the class referenceHugo Locurcio
2020-10-04Merge pull request #42439 from Xrayez/doc-gdscript-load-and-resloader-xrefRémi Verschelde
Cross-reference GDScript `load` and `ResourceLoader.load` in classref
2020-10-02Fixed padding bug of sprintf functionSerhat
2020-09-30Cross-reference GDScript `load` and `ResourceLoader.load` in classrefAndrii Doroshenko (Xrayez)
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-24Improve documentation related to printing error/warning messagesHugo Locurcio
2020-09-14Several documentation improvementsDanil Alexeev
2020-08-28Cross-reference GDScript built-in rounding methods to ease discoveryHugo Locurcio
This closes #19315.
2020-07-31Merge pull request #40903 from Calinou/doc-jsonRémi Verschelde
Improve JSON-related documentation
2020-07-31Improve JSON-related documentationHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/3848.
2020-07-30doc: Fix typo in BBcode tagRémi Verschelde
2020-07-28doc: Sync classref with current sourceRémi Verschelde
2020-07-25GDScript: Clarified/fixed inaccuracies in the built-in function docs.Meriipu
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-21Update core documentation to match recent C# changesAaron Franke
Also a few minor API changes like adding AABB.abs() Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-06-28Improve the preload and load descriptionsTomasz Chabora
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-21 21:43:59 +0000