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
Haoyu Qiu
b2c012a8c8
Add GridMap.get_used_cells_by_item
2022-02-16 13:03:50 +08:00
rafallus
75fcb31cee
[3.x] Consider gridmap collisions in navigation bake
2022-01-24 19:10:33 -06:00
kobewi
9b149d5848
Add physics material to GridMap
...
(cherry picked from commit 59a9b2192e
)
2022-01-06 21:44:40 +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
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
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
JFonS
e2c28675ef
Batch of lightmapper fixes and minor improvements
...
- Fix objects with no material being considered as fully transparent by the lightmapper.
- Added "environment_min_light" property: gives artistic control over the shadow color.
- Fixed "Custom Color" environment mode, it was ignored before.
- Added "interior" property to BakedLightmapData: controls whether dynamic capture objects receive environment light or not.
- Automatically update dynamic capture objects when the capture data changes (also works for "energy" which used to require object movement to trigger the update).
- Added "use_in_baked_light" property to GridMap: controls whether the GridMap will be included in BakedLightmap bakes.
- Set "flush zero" and "denormal zero" mode for SSE2 instructions in the Embree raycaster. According to Embree docs it should give a performance improvement.
2021-03-12 12:00:53 +01:00
Jack Linhart
8190305075
Added GridMap description to get_bake_meshes()
...
(cherry picked from commit 03fd2b4c86
)
2021-02-25 22:37:29 +01:00
Hugo Locurcio
4a74f6f3b7
Document that GridMap doesn't support visual layers or cull masks
...
See #40245 .
(cherry picked from commit 95fda7e881
)
2021-02-05 10:26:03 +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
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
Rémi Verschelde
7140d766a2
Merge pull request #33997 from akien-mga/doc-makerst-escape
...
makerst: Escape default values using reST markup
2019-12-01 11:52:20 +01:00
James Westman
7ef16ca136
Docs: GridMap and MeshLibrary
...
The only methods left to document are resource_changed, set_clip, and
the methods dealing with baked meshes.
2019-11-29 18:21:34 -06:00
Rémi Verschelde
55676b16da
makerst: Escape default values using reST markup
...
Otherwise the docs would complain about values like "godot_"
which reST tries to interpret as an identifier.
2019-11-29 14:25:37 +01:00
Rémi Verschelde
aa0fa6b14f
doc: Sync classref with current source
2019-10-26 16:40:41 +02:00
Rémi Verschelde
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +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
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
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
Rémi Verschelde
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +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
luz.paz
08bde5b2de
Misc. typos
...
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-09-12 21:39:17 -04:00
Rémi Verschelde
5267099a87
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
robojumper
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02: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
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +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
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
Juan Linietsky
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Bojidar Marinov
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
Rémi Verschelde
8d03cafd7c
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
Rémi Verschelde
abf20709af
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
Rémi Verschelde
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +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
8652c1d5b1
classref: Sync with current source
2017-10-21 12:04:36 +02:00
David Saltares
62ba7a1eb0
[DOCS] Document GridMap
...
[ci skip]
2017-10-15 20:38:38 +02:00
Rémi Verschelde
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00