summaryrefslogtreecommitdiff
path: root/modules/gdscript/doc_classes
AgeCommit message (Collapse)Author
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.
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-26Unregister GDScriptFunctionState classGeorge Marques
This is not user accessible anymore so it does not need to be show in documentation.
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-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
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
2020-04-29[Core] Rename linear_interpolate to lerpAaron Franke
2020-04-20DocData: Skip unexposed classesRémi Verschelde
Properly expose classes that we actually want accessible.
2020-03-31Add missing docs for assert message in GDScriptThomas ten Cate
Seems like this was overlooked in PR #31142. See also issue #17082.
2020-03-30doc: Update classref with node renamesRémi Verschelde
A few extra renames for classes which were missed in last week's PRs.
2020-02-28Merge pull request #36620 from Calinou/doc-linear2db-exampleRémi Verschelde
Add a practical example for `@GDScript.linear2db()`
2020-02-27Add a practical example for `@GDScript.linear2db()`Hugo Locurcio
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.
2020-02-27Improve the `@GDScript.inverse_lerp()` documentationHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/2589.
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-02-12Remove deprecated decimals builtinRémi Verschelde
Replaced by 'step_decimals' in 3.2 via #21425.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26Merge pull request #35589 from akien-mga/doc-drop-category-propertyRémi Verschelde
doc: Drop unused 'category' property from header
2020-01-26doc: Do not expose Variant::NIL as a type in the class referenceRémi Verschelde
Fix signals Variant arguments incorrectly listed as Nil. Fixes #12520.
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26doc: Document named color constantsRémi Verschelde
Busywork but it's good for our completion rate :)
2019-12-16Merge pull request #34280 from zaksnet/fix-yield-documentationRémi Verschelde
Fix documentation for yield
2019-12-15Updates docs for GDScript built-in functionsHaoyu Qiu
* Adds description for `ord()` * Adds relationship description between `char()` and `ord()` * Describes the argument of `char()` as Unicode code point instead of ASCII code * Fixes wrong interval notation in `randi()` description
2019-12-13Fix documentation for yieldZak
#33872 PR was misleading as i though inheritance from GDScriptFunctionState was optional.
2019-12-11Add note in 'load()' docs that the path must be absoluteMichael Alexsander
2019-12-06doc: Markup fixes for enums and constantsRémi Verschelde
2019-12-03Mention that `int()` can be used as an alternative to `floor()`Hugo Locurcio
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 19:44:58 +0000