Commit graph

77 commits

Author SHA1 Message Date
Charlie Burnham
51681ed501 Backport fix documentation about body_shape_index 2024-02-10 17:39:54 -06:00
MJacred
1c63c54ab3 [3.x] Warn against using non-uniform scale for 3D physics (in class reference only)
partial backport of #67847
fixes #56824
2023-05-20 18:48:34 +02:00
Rémi Verschelde
0a8d5d7098 Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
Haoyu Qiu
fb62ec6c1d Fix several typos in the classref 2022-06-01 15:57:51 +08:00
skyace65
c0ecbeaf6f Fix rigid body damp description (3.x) 2022-05-30 13:39:44 -04:00
Hugo Locurcio
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
Hugo Locurcio
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
Rémi Verschelde
3ac2999f22
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
Maxime Lapointe
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
Rémi Verschelde
f0b37b1519
doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
Rémi Verschelde
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
Marcel Admiraal
09456c2a01 Return RID instead of Object id in area-body_shape_entered-exited signals. 2021-05-19 10:51:59 +01:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Marcel Admiraal
cdcd425432 Update area-body_shape_entered-exited signal documentation. 2021-01-15 09:46:17 +00:00
Rémi Verschelde
d298949513
Merge pull request #42882 from madmiraal/fix-39767-3.2
[3.2] Set Bullet collision shape index to zero when using a single shape or ConcavePolygonShape
2021-01-14 20:46:06 +01:00
Rémi Verschelde
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
Aaron Franke
069ed4ec63
Link to demos from within the class reference
(cherry picked from commit 439be614f4)
2020-10-19 16:10:01 +02:00
Tomasz Chabora
f7ea1e6b38
Correct the doc about linear damping
(cherry picked from commit ebca7d4e4e)
2020-10-19 16:09:58 +02:00
Marcel Admiraal
b7d00a364e Set Bullet collision shape index to zero when using a single shape
or ConcavePolygonShape.
2020-10-19 11:50:29 +01:00
Hugo Locurcio
be126bfd55
Document RigidBodies in character mode never sleeping automatically
See #7996.

(cherry picked from commit 5fbf709ca2)
2020-09-01 21:01:58 +02:00
skyace65
45e596e02f
Document where the center of mass is for RigidBody nodes
(cherry picked from commit 555f4f3e17)
2020-08-31 15:29:42 +02:00
Rémi Verschelde
e82e9588fd doc: Sync classref with current source 2020-07-28 11:50:39 +02:00
Marcel Admiraal
cdb3712992 Clarify the difference between contacts and collisions.
(cherry picked from commit 6f1c99e5b4)
2020-07-28 00:52:07 +02:00
Yerik
d09b16512b Added Method get_inverse_inertia_tensor 2020-07-19 13:51:32 -03:00
Marcel Admiraal
7200a0eac5 Update Rigidbody 2D and 3D sleep documentation.
(cherry picked from commit 1b738a77c1)
2020-06-10 15:30:52 +02:00
PouleyKetchoupp
eab7342321 More details in Rigid Body add_force documentation
(cherry picked from commit 219c5712f0)
2020-04-16 12:57:22 +02: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
Chris Bradfield
2092ebda9c [DOC] Add missing physics_material_override descriptions 2019-10-06 11:54:58 -07:00
Rémi Verschelde
efd55631e2 doc: Sync classref with current source 2019-07-15 20:45:30 +02:00
Rémi Verschelde
542489a866 DocData: Re-expose parametric setters and getters
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.

For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +02:00
Rémi Verschelde
1fbca7ed88 doc: Mark PhysicsBody bounce/friction as deprecated 2019-06-30 13:58:07 +02:00
Rémi Verschelde
a78373ddc2 doc: Remove null default values that can't be determined
Applying #30187.
2019-06-30 13:58:07 +02: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
Cheeseness
b06dc6ba8c Correct typos in RigidBody axis lock documentation 2019-05-31 13:28:30 +10:00
Sean Heffernan
426bcc9941 Change "Return" to "Returns" where necessary in XML documentation
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-05-23 21:11:24 -07:00
Rémi Verschelde
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
toger5
ef99f034b4 [DOCS] rephrase impulse
- improove coordinate system explanation
 - define usecase
2019-01-29 13:05:20 +01:00
Rémi Verschelde
ee6f1fa3f8 doc: Fix references to setters and misc formatting 2018-12-29 00:17:09 +01:00
Rémi Verschelde
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Rémi Verschelde
5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch
Fixes #23509.
2018-11-05 08:46:27 +01:00
Chris Bradfield
7bc11505b1 [DOCS] Classref updates: Color, RigidBody* 2018-10-02 15:47:10 -07:00
LikeLakers2
eaac1e3b81 [Docs] Remove double-spaces from descriptions, as well a couple other small fixes 2018-09-23 16:13:30 -04:00
Kelly Thomas
1dc8e7c05f Improve ClassDB information for some some signal parameters 2018-09-01 18:05:51 +08:00
Tiger C
74aa104607 Added documentation for some RigidBody methods, and copied the descriptions to matching PhysicsDirectBodyState methods. 2018-08-29 18:44:24 -04:00