Haoyu Qiu
c4b5161ed1
Fix invalid use of markdown syntax in classref
...
Also:
* changed `[b]true[/b]` to `[code]true[/code]`
* use `[i]` for mathematical constant "e"
* use `[b]` for button text & menu item text
* improve markups about "tap1" and "tap2" in AudioEffectDelay
2023-08-01 22:44:31 +08:00
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
Yuri Sizov
8f113c6532
Merge pull request #72749 from aaronfranke/area-priority
...
Make Area physics priority consistently int and allow negative numbers
2023-04-18 14:21:06 +02:00
Aaron Franke
87bd8d2dcf
Make Area physics priority consistently int and allow negative numbers
2023-04-18 13:50:20 +02:00
Paweł
4431cdd154
Remove double thes from documentation
2023-04-17 21:45:30 +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
Rémi Verschelde
35c37ce4ce
Merge pull request #67847 from rburing/warn_non-uniformists
...
Warn against using non-uniform scale for 3D physics (in the editor and class reference)
2023-01-23 10:32:06 +01: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
e723456494
Changed Area3D node description
...
Changed description to be less confusing
Changed
"3D area for detection and physics and audio influence."
To
"3D area for detection, physics, and audio influence."
2022-11-19 17:56:17 -06:00
Ricardo Buring
0e6b796cf6
Warn against using non-uniform scale for 3D physics
...
Using non-uniform scale is known to cause many issues.
Add warnings to the editor and to the class reference.
Also remove the warning from SoftBody3D since it is
not relevant there: it simulates in global space.
2022-10-24 19:31:00 +02:00
Micky
c1b5b68eee
Rename remaining "*_enable" to "*_enabled"
...
Material.`proximity_fade_enable` -> `proximity_fade_enabled`
Material.`set_proximity_fade` -> `set_proximity_fade_enabled`
(Material.`is_proximity_fade_enabled` is unchanged)
Area3D.`reverb_bus_enable` -> `reverb_bus_enabled`
(`set_use_reverb_bus` & `is_using_reverb_bus` are unchanged)
RDPipelineRasterizationState:
`depth_bias_enable` -> `depth_bias_enabled`
`set_depth_bias_enable` -> `set_depth_bias_enabled`
`get_depth_bias_enable` -> `get_depth_bias_enabled`
Bonus:
Area3D.`set_reverb_bus` -> `set_reverb_bus_name`
Area3D.`get_reverb_bus` -> `set_get_reverb_bus_name`
2022-09-21 22:47:46 +02: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
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
Laelaps9
7f691f060e
Fix area_shape_exited's description
...
area_shape_entered and area_shape_exited had the exact same description. Changed area_shape_exited's description to specify that the signal is emitted when another area's shape exits rather than enters this area's shapes.
2021-10-30 16:59:10 -05: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
Jeffrey Cochran
e806397196
Enabled area-specific wind forces
2021-08-23 17:00:50 -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
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
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
Marcel Admiraal
daa084d004
Rename Area3D audio_bus_name getter and setter
2020-12-10 08:31:14 +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
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
eaaee63b62
doc: Update classref with node renames
...
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
