summaryrefslogtreecommitdiffstats
path: root/modules/gdscript/doc_classes/@GDScript.xml
Commit message (Collapse)AuthorAgeFilesLines
* 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.
* Remove deprecated decimals builtinRémi Verschelde2020-02-121-9/+0
| | | | Replaced by 'step_decimals' in 3.2 via #21425.
* Update docs to version 4.0clayjohn2020-01-311-1/+1
|
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-1/+1
| | | | | | | | | | 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.
* doc: Document named color constantsRémi Verschelde2020-01-261-3/+2
| | | | Busywork but it's good for our completion rate :)
* Merge pull request #34280 from zaksnet/fix-yield-documentationRémi Verschelde2019-12-161-12/+15
|\ | | | | Fix documentation for yield
| * Fix documentation for yieldZak2019-12-131-12/+15
| | | | | | #33872 PR was misleading as i though inheritance from GDScriptFunctionState was optional.
* | Updates docs for GDScript built-in functionsHaoyu Qiu2019-12-151-3/+12
| | | | | | | | | | | | | | * 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
* | Add note in 'load()' docs that the path must be absoluteMichael Alexsander2019-12-111-2/+3
|/
* doc: Markup fixes for enums and constantsRémi Verschelde2019-12-061-3/+3
|
* Mention that `int()` can be used as an alternative to `floor()`Hugo Locurcio2019-12-031-2/+3
|
* Add docs for is_equal_approx on structuresAaron Franke2019-11-301-2/+2
|
* Remove type hint from the @GDScript class documentationHugo Locurcio2019-11-261-3/+3
| | | | | The current consensus in the Godot documentation is to avoid using type hints unless they're relevant to the behavior explained.
* Added missing documentation for yield()Zak Stam2019-11-251-0/+20
| | | Added some missing documentation about yield() being able to wait for a function also. I cant believe something like that was missing from the docs, it would have saved me so much time (and others i assume).
* Merge pull request #33257 from aaronfranke/printrawRémi Verschelde2019-11-071-0/+1
|\ | | | | Document behavior of GDScript printraw
| * Document behavior of printrawAaron Franke2019-11-021-0/+1
| |
* | Fix Color8 GDScript documentationAaron Franke2019-11-021-1/+1
|/
* Print errors when tab indent found in [codeblock]Yeongho Kim2019-10-011-4/+4
|
* doc: Sync classref with current sourceRémi Verschelde2019-09-241-0/+8
| | | | Fix a few missing bindings or unspecified argument names and default values.
* doc: Sync classref with current sourceRémi Verschelde2019-08-291-1/+1
|
* Updated description for "stepify"Thomas Karcher2019-08-291-1/+5
| | | Mentioned the possibility to use stepify as a rounding function; +code examples
* Add a reference to pow to the description of exp.Kaligule2019-07-291-0/+1
| | | | | | | | | This might be especially usefull since godot script doesn't support ** or ^ as operators, so beginners might search for the exponential function, when what they really need is the pow function. This is exactly what happened to me and since I couldn't find helpfull information in the documentation I had to look it up online, where I found the answer on a helpfull [reddit thread](https://www.reddit.com/r/godot/comments/3mvwz0/how_do_i_do_exponents_in_godot/). @akien-mga told me how to reference methods here: godotengine#30909
* Inspector: Make default float step configurableRémi Verschelde2019-07-231-1/+1
| | | | | | | | | | Also allow lifting the decimal step formatting with a hint range step of 0. A new `range_step_decimals()` is added for this to avoid breaking compatibility on the general purpose `step_decimals()` (which still returns 0 for an input step of 0). Supersedes #25470. Partial fix for #18251.
* doc: Sync classref with current sourceRémi Verschelde2019-07-221-33/+33
|
* Added lerp_angles built-in functionChaosus2019-07-201-0/+23
| | | | | Co-authored-by: Xrayez <https://github.com/Xrayez> Co-authored-by: DleanJeans <https://github.com/DleanJeans>
* Add integer posmod and rename default arg namesAaron Franke2019-07-181-19/+52
| | | | | "posmod" is the integer version of "fposmod". We do not need a "mod" because of the % operator. I changed the default arg names from "x" and "y" to "a" and "b" because they are not coordinates. I also changed pow's arg names to "base" and "exp". Also, I reorganized the code in the VS built-in funcs switch statement.
* Proofread and improve the whole class referenceHugo Locurcio2019-06-271-82/+79
| | | | | | | | | | | | | - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
* Extends wrapi/wrapf docsChaosus2019-06-251-0/+16
|
* doc: Improve docs for Resource* classesRémi Verschelde2019-06-181-0/+1301
Also move module-specific classes to their own module's `doc_classes` folder.