asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
33265 commits 1 branch 0 tags 2.2 GiB
Commit graph

51 commits

Author SHA1 Message Date
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
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
skyace65
c1709e8177
Improve area method descriptions 
(cherry picked from commit 4dd8ab745a)
 2021-10-26 13:34:36 +02: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
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
Hugo Locurcio
e0facdaf61
Uncap the range for gravity and change the slider hints 
There's not really a reason to cap the gravity amount, and we can also
give better hints for the range (for 3D, ±32 is much more sensible
than ±1024).
 2021-06-03 02:08:57 +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
Marcel Admiraal
8766769fd4 Move collision layer and mask into CollisionObject. 2021-05-08 11:40:57 +01:00
Lightning_A
e4addffde1
Put physics override parameters in their own group and document that areas can be used to influence audio 
(cherry picked from commit 80b1a29c46)
 2021-04-29 12:27:31 +02: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
253b1c22da Rename the final parameter of area_shape_entered-exited local_shape. 2021-01-15 09:46:19 +00:00
Marcel Admiraal
cdcd425432 Update area-body_shape_entered-exited signal documentation. 2021-01-15 09:46:17 +00: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
Hugo Locurcio
cc3b69cf7b
Reference the online documentation in collision layer/mask properties 
See https://github.com/godotengine/godot-docs/pull/3863.

(cherry picked from commit c73c327bab)
 2020-08-31 15:55:11 +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
Lakshay Angrish
fe9a4ff818 add area_shape_entered usage 2019-12-26 17:30:48 +05:30
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
Rémi Verschelde
71d53637b5 doc: Fix scoped hyperlinks to same-class enums/methods 
The class name does not need to be specified when it is the current class.
 2019-06-27 11:44:37 +02:00
Rémi Verschelde
f34c8015cb Area2D: Fix argument type of body_* signals 
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-06-24 21:40:31 +02:00
Rémi Verschelde
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough 
EditorHelp: Improve enum ref resolving and add constant ref support
 2019-04-05 15:19:21 +02:00
Rémi Verschelde
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
d80bc5cbba ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] 
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
 2019-03-29 23:47:35 +01:00
Rémi Verschelde
a15620c83e doc: Fix wrong references found by Sphinx and new makerst.py 2019-01-07 12:15:01 +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
Kelly Thomas
1dc8e7c05f Improve ClassDB information for some some signal parameters 2018-09-01 18:05:51 +08:00
Kelly Thomas
29f2571662 update class docs 2018-08-31 22:35:15 +02:00
Max Hilbrunner
fdd0f18959
[DOCS] Small fix to Area: Fix copy/paste errors 2018-03-03 10:52:14 +01:00
Rémi Verschelde
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
Rémi Verschelde
3c7a39b40c doc: Update version string in header 2018-02-19 10:46:33 +01:00
Rémi Verschelde
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
Rémi Verschelde
e28cdc4654 doc: Update version string in XML 2018-01-13 11:43:42 +01:00
Juan Linietsky
e633a04c42 Update documentation to clarify that list of overlaps is not updated immediately. 2018-01-11 11:19:12 -03:00
Will Nations
61d833a56e [DOCS] Area members and methods 2017-12-06 08:46:52 -06:00
Rémi Verschelde
7dfba3cda9 doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00
Rémi Verschelde
92f07fefcd doc: Remove setters and getters now exposed via properties/members 2017-11-24 18:10:32 +01:00
Rémi Verschelde
bc75fae579 doc: Update header version for 3.0-beta 2017-11-24 09:16:52 +01:00
Rémi Verschelde
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
Rémi Verschelde
fc09e14366 classref: Sync with current source 
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
 2017-10-22 12:56:17 +02:00
Rémi Verschelde
b302084395 makerst: Fix rst-ization of members and escaping of [Class]s 
Fixes #11517.
 2017-10-21 12:33:52 +02:00
Chris Bradfield
0843d2379c [DOCS] Area/Area2D class ref update 2017-09-24 00:24:41 -07:00
Rémi Verschelde
62cb43bb8d doc: Sync classref with current source 
[ci skip]
 2017-09-16 01:46:29 +02:00
Rémi Verschelde
a4005221f5 doc: Sync classref with current source 
[ci skip]
 2017-09-13 08:53:01 +02:00