godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
56,771 Commits 15 Branches 59 Tags 2.2 GiB
5453503697
Commit Graph

76 Commits

Author SHA1 Message Date
Rémi Verschelde
81064cc239
Doctool: Remove version attribute from XML header 
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
 2023-07-06 10:08:21 +02:00
Rémi Verschelde
346f1ab86b
Bump version to 4.2-dev 
Keep on waitin'
 2023-07-05 22:07:03 +02:00
VolTer
e3d0da404f Overhaul the top sections of the class reference (Physics classes) 2023-05-20 03:25:26 +02:00
Aaron Franke
87bd8d2dcf Make Area physics priority consistently int and allow negative numbers 2023-04-18 13:50:20 +02:00
Rémi Verschelde
1c1524a651
Bump version to 4.1-dev 
Can't stop, won't stop, they said, huh?
 2023-03-01 01:44:37 +01:00
Matthew
9f6bb7dd50
Merge pull request #68905 from jaymehta-g/area-node-description-typo 
Fix Area node description mistake
 2023-02-10 22:06:32 -05:00
Jay Mehta
3bafb97e89 Second revision of area node desc 2023-02-07 16:13:28 -06:00
Aaron Franke
79215131b5
Replace Area gravity point distance scale with unit distance 2023-01-29 22:12:00 -06:00
Yuri Sizov
29dc73fc6c Improve signal documentation for Area2D/3D 2022-12-12 23:15:14 +03:00
Jay Mehta
0331f44757 Revise Area node brief descriptions 
Revision to make the separation between collision and physics/audio influence more clear
 2022-11-20 19:43:21 -06:00
Jay Mehta
98bda13fd8 Changed Area2D node description 
Changed description to be less confusing

Changed
"2D area for detection and physics and audio influence."
To
"2D area for detection, physics, and audio influence."
 2022-11-19 17:55:15 -06:00
VolTer
ed4fe1e2bd Implement Area.has_overlapping_* 2022-09-10 12:17:37 +02:00
Ricardo Buring
5da55356c8 Document behavior of areas with concave shapes 2022-08-23 22:22:35 +02:00
Andy Maloney
9b345e793a [doc] Use "param" instead of "code" to refer to parameters (8) 2022-08-12 14:00:25 -04:00
Yuri Sizov
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
Rémi Verschelde
b70688401a
Merge pull request #57478 from FelixNemis/physics-signal-doc-fix 
Fix snippet for getting collisionshape node in body/area signal docs
 2022-03-03 16:08:13 +01:00
Hugo Locurcio
b68dd2e189
Add an XML schema for documentation 
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-15 00:03:31 +01:00
Hugo Locurcio
2ea08134c3
Clarify Area2D/Area3D overlaps_area()/overlaps_body() documentation 2022-02-01 22:20:29 +01:00
Charlie Burnham
aab4cdf135 Fix recommended snippet for getting collisionshape node in body/area signal docs 2022-01-31 02:34:02 -06:00
Rémi Verschelde
6c1bd4d227
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 13:02:21 +01:00
PouleyKetchoupp
3d1c123d45 Separate space override modes for gravity/damping in Area 
Also make inspector clearer for gravity point properties.
 2021-11-09 10:29:24 -07:00
skyace65
4dd8ab745a Improve area method descriptions 2021-10-23 08:59:43 -04:00
Maxime Lapointe
b66fdb8dd2 Improve area/body_shape_entered/exited signals parameter names and doc 
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-10-14 15:41:26 -04:00
Rémi Verschelde
7adf4cc9b5
doc: Use self-closing tags for return and argument 
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-30 15:29:52 +02:00
Nicholas Huelin
9a72b0d3d0 Fix doc typos 
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`,  `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
 2021-07-23 12:15:15 -04:00
Michael Alexsander Silva Dias
0ff4095b36 Better format arguments in variant parser 2021-06-18 00:06:40 -03:00
Jonathan Gollnick
6710ad1737
Let var2str display StringName with correct sigil 2021-06-10 16:30:28 -05:00
Rémi Verschelde
c340ed6394
Merge pull request #42742 from madmiraal/fix-12215 
Return RID instead of Object id in area-body_shape_entered-exited signals.
 2021-05-18 20:00:48 +02:00
Aaron Franke
ab674a41aa
Area: Uncap the range for gravity and change the slider hints 2021-05-18 07:17:11 -04:00
Hugo Locurcio
4a28f7e44f
Increase the default 2D gravity to 980.0 
This makes 2D RigidBody physics feel less floaty out of the box.

This closes https://github.com/godotengine/godot-proposals/issues/98.
 2021-05-05 22:49:06 -04:00
Marcel Admiraal
071871b787 Move collision layer and mask into CollisionObject. 2021-04-20 10:38:42 +01:00
Lightning_A
80b1a29c46 Put physics override parameters in their own group and document that areas can be used to influence audio 2021-04-18 21:27:06 -06:00
Marcel Admiraal
38f2e32e32 Return RID instead of Object id in area-body_shape_entered-exited signals. 2021-03-06 10:48:17 +00:00
Aaron Franke
548de64742
Use a more specific type for Area2D/3D body signals 2021-02-24 00:05:54 -05:00
Marcel Admiraal
5fa12da6f9 Rename the final parameter of area_shape_entered-exited local_shape. 2021-01-09 13:34:59 +00:00
Marcel Admiraal
a77173b335 Update area-body_shape_entered-exited signal documentation. 2021-01-09 13:34:50 +00:00
Tomasz Chabora
ebca7d4e4e Correct the doc about linear damping 2020-10-13 11:41:18 +02:00
Aaron Franke
439be614f4
Link to demos from within the class reference 2020-10-01 23:57:21 -04:00
Rémi Verschelde
2cfc5b8680
Merge pull request #40993 from Calinou/doc-collision-layer-mask 
Reference the online documentation in collision layer/mask properties
 2020-08-31 15:32:44 +02:00
Hugo Locurcio
c4903a603b
Add link titles for all links in the class reference 
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
 2020-08-31 14:22:07 +02:00
Hugo Locurcio
c73c327bab
Reference the online documentation in collision layer/mask properties 
See https://github.com/godotengine/godot-docs/pull/3863.
 2020-08-03 13:58:51 +02:00
Rémi Verschelde
d567c15aed doc: Fix parsing typed arrays in makerst.py 
`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-04-24 17:50:20 +02:00
Rémi Verschelde
fea37cfb52 doc: Sync classref with StringName/Callable changes 2020-02-22 14:59:09 +01:00
clayjohn
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08:00
Rémi Verschelde
2d20fc39aa doc: Drop unused 'category' property from header 
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-26 16:02:39 +01:00
Lakshay Angrish
fe9a4ff818 add area_shape_entered usage 2019-12-26 17:30:48 +05:30
Derwent Ready (drentsoft)
1758a6f494 Added link to Area2D tutorial in documentation. 2019-10-31 20:59:13 +00:00
Rémi Verschelde
b9aa13e591 doc: Remove hardcoded default values from descriptions 
They are now generated automatically by doctool.
 2019-06-30 13:58:07 +02:00
Rémi Verschelde
c6cea6e9b3 doc: Add default values to all properties 
Thanks to @bojidar-bg's impressive work in #29380.
 2019-06-30 13:58:07 +02:00
Hugo Locurcio
f7f6115f76
Proofread and improve the whole class reference 
- 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-27 22:30:19 +02:00