summaryrefslogtreecommitdiffstats
path: root/modules/gdscript/doc_classes/@GDScript.xml
Commit message (Collapse)AuthorAgeFilesLines
* 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-151-1/+1
| | | | | | | | 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-151-1/+1
|
* GDScript gracefully handle debug functions from separate threadBrian Semrau2021-11-011-2/+10
|
* Add an example on iterating an array backwardsHugo Locurcio2021-09-301-1/+16
| | | | This closes https://github.com/godotengine/godot-docs/issues/3472.
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-60/+30
| | | | | | | | 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
|
* Merge pull request #43423 from Calinou/doc-assert-avoid-side-effectsRémi Verschelde2020-11-101-4/+5
|\ | | | | Clarify that code in `assert()` should avoid side effects
| * Clarify that code in `assert()` should avoid side effectsHugo Locurcio2020-11-091-4/+5
| |
* | Variant: Sync docs with new constructors, fixups after #43403Rémi Verschelde2020-11-091-47/+29
|/ | | | | Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
* Exposed randi_range to global funcs + renamed rand_range to randf_rangeYuri Roubinsky2020-11-061-2/+17
|
* Link the Random number generation tutorial in the class referenceHugo Locurcio2020-10-141-0/+1
|
* Merge pull request #42439 from Xrayez/doc-gdscript-load-and-resloader-xrefRémi Verschelde2020-10-041-0/+1
|\ | | | | Cross-reference GDScript `load` and `ResourceLoader.load` in classref
| * Cross-reference GDScript `load` and `ResourceLoader.load` in classrefAndrii Doroshenko (Xrayez)2020-09-301-0/+1
| | | | | | | | | | | | 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.
* | Fixed padding bug of sprintf functionSerhat2020-10-021-1/+1
|/
* Improve documentation related to printing error/warning messagesHugo Locurcio2020-09-241-0/+2
|
* Several documentation improvementsDanil Alexeev2020-09-141-48/+25
|
* Cross-reference GDScript built-in rounding methods to ease discoveryHugo Locurcio2020-08-281-0/+4
| | | | This closes #19315.
* Merge pull request #40903 from Calinou/doc-jsonRémi Verschelde2020-07-311-10/+15
|\ | | | | Improve JSON-related documentation
| * Improve JSON-related documentationHugo Locurcio2020-07-311-10/+15
| | | | | | | | This closes https://github.com/godotengine/godot-docs/issues/3848.
* | doc: Fix typo in BBcode tagRémi Verschelde2020-07-301-1/+1
|/
* doc: Sync classref with current sourceRémi Verschelde2020-07-281-36/+0
|
* GDScript: Clarified/fixed inaccuracies in the built-in function docs.Meriipu2020-07-251-6/+19
| | | | | | | | | | | | | | | | | 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.
* Update core documentation to match recent C# changesAaron Franke2020-07-211-39/+25
| | | | | | Also a few minor API changes like adding AABB.abs() Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
* Improve the preload and load descriptionsTomasz Chabora2020-06-281-8/+8
|
* [Core] Rename linear_interpolate to lerpAaron Franke2020-04-291-1/+1
|
* Add missing docs for assert message in GDScriptThomas ten Cate2020-03-311-1/+5
| | | | Seems like this was overlooked in PR #31142. See also issue #17082.
* doc: Update classref with node renamesRémi Verschelde2020-03-301-1/+1
| | | | A few extra renames for classes which were missed in last week's PRs.
* Merge pull request #36620 from Calinou/doc-linear2db-exampleRémi Verschelde2020-02-281-1/+7
|\ | | | | Add a practical example for `@GDScript.linear2db()`
| * Add a practical example for `@GDScript.linear2db()`Hugo Locurcio2020-02-271-1/+7
| | | | | | | | | | | | | | One of its most common applications in games is for volume sliders. See https://www.dr-lex.be/info-stuff/volumecontrols.html for more information.
* | Improve the `@GDScript.inverse_lerp()` documentationHugo Locurcio2020-02-271-4/+8
|/ | | | This closes https://github.com/godotengine/godot-docs/issues/2589.
* doc: Sync classref with current sourceRémi Verschelde2020-02-181-2/+2
| | | | Handle removal of Pool*Array types and other recent changes.