c0ecbeaf6f
Fix rigid body damp description (3.x)
2022-05-30 13:39:44 -04:00
b087538119
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-03-16 23:01:02 +01:00
2fe15124de
Document that RigidBody angular velocity is in degrees per second
...
This will be changed to radians per second in Godot 4.0, but it can't
be changed in 3.x to preserve compatibility with existing projects.
2021-12-07 18:38:03 +01:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
f3002c62b7
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-15 11:28:17 -04:00
f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5
2021-08-03 10:20:19 +02:00
09456c2a01
Return RID instead of Object id in area-body_shape_entered-exited signals.
2021-05-19 10:51:59 +01:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
596169d7df
class reference proofreading
...
(cherry picked from commit 8455e901f3
2021-03-26 09:49:07 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
cdcd425432
Update area-body_shape_entered-exited signal documentation.
2021-01-15 09:46:17 +00:00
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
2020-10-19 16:10:01 +02:00
f7ea1e6b38
Correct the doc about linear damping
...
(cherry picked from commit ebca7d4e4e
2020-10-19 16:09:58 +02:00
5d548d12aa
Remove reference to 3D shapes in RigidBody2D.xml contacts description.
...
(cherry picked from commit e7edbcedc9
2020-10-04 20:54:16 +02:00
be126bfd55
Document RigidBodies in character mode never sleeping automatically
...
See #7996 .
(cherry picked from commit 5fbf709ca2
2020-09-01 21:01:58 +02:00
45e596e02f
Document where the center of mass is for RigidBody nodes
...
(cherry picked from commit 555f4f3e17
2020-08-31 15:29:42 +02:00
cdb3712992
Clarify the difference between contacts and collisions.
...
(cherry picked from commit 6f1c99e5b4
2020-07-28 00:52:07 +02:00
7200a0eac5
Update Rigidbody 2D and 3D sleep documentation.
...
(cherry picked from commit 1b738a77c1
2020-06-10 15:30:52 +02:00
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
2092ebda9c
[DOC] Add missing physics_material_override descriptions
2019-10-06 11:54:58 -07:00
74713fe970
Fix custom inertia in physics2d, closes#30838
2019-08-22 20:30:03 +08:00
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
1fbca7ed88
doc: Mark PhysicsBody bounce/friction as deprecated
2019-06-30 13:58:07 +02:00
a78373ddc2
doc: Remove null default values that can't be determined
...
Applying #30187 .
2019-06-30 13:58:07 +02:00
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
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
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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
1170b78e28
Update of RigidBody2D class description
...
Added a hint in the RigidBody2D class description regarding the transformation issue mentioned in https://github.com/godotengine/godot/issues/5734
2019-05-03 10:49:54 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
ef99f034b4
[DOCS] rephrase impulse
...
- improove coordinate system explanation
- define usecase
2019-01-29 13:05:20 +01:00
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
7bc11505b1
[DOCS] Classref updates: Color, RigidBody*
2018-10-02 15:47:10 -07:00
1dc8e7c05f
Improve ClassDB information for some some signal parameters
2018-09-01 18:05:51 +08:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
eb63f7b071
[DOCS] Sync classref with current source
2018-02-25 15:14:25 +07:00
48850d4077
Merge pull request #16738 from YeldhamDev/rigidbodies_descriptions
...
Made modifications to the RigidBody(2D) descriptions
2018-02-19 20:29:53 +01:00
50e6b3c005
Made modifications to the RigidBody(2D) descriptions.
2018-02-19 14:40:00 -03:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
d516aab8fa
doc: Sync with current source
...
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
e633a04c42
Update documentation to clarify that list of overlaps is not updated immediately.
2018-01-11 11:19:12 -03:00
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
92f07fefcd
doc: Remove setters and getters now exposed via properties/members
2017-11-24 18:10:32 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
skyace65
Hugo Locurcio
Rémi Verschelde
Maxime Lapointe
Marcel Admiraal
Paul Joannon
Aaron Franke
Tomasz Chabora
Chris Bradfield
RaphaelHunter
Thomas Karcher
toger5
Chris Bradfield
Kelly Thomas
Poommetee Ketson
Michael Alexsander Silva Dias
Bojidar Marinov
Juan Linietsky