summaryrefslogtreecommitdiff
path: root/doc/classes/Area2D.xml
AgeCommit message (Collapse)Author
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (8)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-03-03Merge pull request #57478 from FelixNemis/physics-signal-doc-fixRémi Verschelde
Fix snippet for getting collisionshape node in body/area signal docs
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.
2022-02-01Clarify Area2D/Area3D `overlaps_area()`/`overlaps_body()` documentationHugo Locurcio
2022-01-31Fix recommended snippet for getting collisionshape node in body/area signal docsCharlie Burnham
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-11-09Separate space override modes for gravity/damping in AreaPouleyKetchoupp
Also make inspector clearer for gravity point properties.
2021-10-23Improve area method descriptionsskyace65
2021-10-14Improve area/body_shape_entered/exited signals parameter names and docMaxime Lapointe
Fix some typoed names from the doc Add _index to "index" parameters of *_shape_* signals, this is both in doc and in the template. This makes the code, signature and doc easier to understand Add method to get Node from the _index params of those signals. This was not as easy to find as one would expect. Putting this information where it is needed will help.
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-23Fix doc typosNicholas Huelin
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`, `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
2021-06-18Better format arguments in variant parserMichael Alexsander Silva Dias
2021-06-10Let var2str display StringName with correct sigilJonathan Gollnick
2021-05-18Merge pull request #42742 from madmiraal/fix-12215Rémi Verschelde
Return RID instead of Object id in area-body_shape_entered-exited signals.
2021-05-18Area: Uncap the range for gravity and change the slider hintsAaron Franke
2021-05-05Increase the default 2D gravity to 980.0Hugo Locurcio
This makes 2D RigidBody physics feel less floaty out of the box. This closes https://github.com/godotengine/godot-proposals/issues/98.
2021-04-20Move collision layer and mask into CollisionObject.Marcel Admiraal
2021-04-18Put physics override parameters in their own group and document that areas ↵Lightning_A
can be used to influence audio
2021-03-06Return RID instead of Object id in area-body_shape_entered-exited signals.Marcel Admiraal
2021-02-24Use a more specific type for Area2D/3D body signalsAaron Franke
2021-01-09Rename the final parameter of area_shape_entered-exited local_shape.Marcel Admiraal
2021-01-09Update area-body_shape_entered-exited signal documentation.Marcel Admiraal
2020-10-13Correct the doc about linear dampingTomasz Chabora
2020-10-01Link to demos from within the class referenceAaron Franke
2020-08-31Merge pull request #40993 from Calinou/doc-collision-layer-maskRémi Verschelde
Reference the online documentation in collision layer/mask properties
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-03Reference the online documentation in collision layer/mask propertiesHugo Locurcio
See https://github.com/godotengine/godot-docs/pull/3863.
2020-04-24doc: Fix parsing typed arrays in makerst.pyRémi Verschelde
`Type[]` typed arrays will link to `Type`, as it's likely the most interesting information for the user. And sync classref with current source.
2020-02-22doc: Sync classref with StringName/Callable changesRémi Verschelde
2020-01-31Update docs to version 4.0clayjohn
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.
2019-12-26add area_shape_entered usageLakshay Angrish
2019-10-31Added link to Area2D tutorial in documentation.Derwent Ready (drentsoft)
2019-06-30doc: Remove hardcoded default values from descriptionsRémi Verschelde
They are now generated automatically by doctool.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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
2019-06-27doc: Fix scoped hyperlinks to same-class enums/methodsRémi Verschelde
The class name does not need to be specified when it is the current class.
2019-06-24Area2D: Fix argument type of body_* signalsRémi Verschelde
Those signals receive either a PhysicsBody2D or a TileMap object, and what the emitting method checks internally is only that the object is a Node. In theory any Node could go through these signals if they talk directly to the PhysicsServer2D. Also updated docs. Fixes #27076. Might need further (compat breaking) improvement as this API is a bit confusing, cf. #24739.
2019-05-23Change "Return" to "Returns" where necessary in XML documentationSean Heffernan
In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-05Merge pull request #27465 from ↵Rémi Verschelde
neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-01-07doc: Fix wrong references found by new makerst.pyRémi Verschelde
Thanks @PJB3005
2018-12-29doc: Fix references to setters and misc formattingRémi Verschelde
2018-12-20doc: Add missing commas after "If true/false"Rémi Verschelde
2018-08-31update class docsKelly Thomas
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde