6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
c3ae7ddedd
Add raycast options to hit when starting inside / hit back faces
...
Makes the results consistent for all shape types with options to set
the desired behavior.
2021-11-10 17:43:35 -07:00
788b3aa27a
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs
...
And fix up formatting not supported by makerst.
2021-10-05 19:13:20 +02:00
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05:00
989acbbe81
Uniformize layer names, script methods and documentation
...
- Back to 1-based layer names to make it clearer in editor UI
- Layer bit accessors are renamed to layer value and 1-based too
- Uniform errors and documentation in render and physics
- Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 08:06:42 -07:00
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
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
a2a78a8066
doc: Sync classref with current source
...
Bind missing enums.
2020-09-11 12:22:10 +02:00
a706c22db7
Rename RayCast's `cast_to` property to `target_position`
...
`cast_to` is sometimes mistaken as a method rather than a property.
`target_position` makes it more obvious that it's a property.
2020-09-10 19:06:56 +02:00
2cfc5b8680
Merge pull request #40993 from Calinou/doc-collision-layer-mask
...
Reference the online documentation in collision layer/mask properties
2020-08-31 15:32:44 +02:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
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
9986439352
Commit other files changed by file_format.sh
2020-07-13 14:14:11 -04:00
96644d23a0
doc: Sync classref with current source
2020-07-03 16:09:12 +02:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08: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
4c4172ec92
Added link to raycasting tutorial to RayCast/RayCast2D
2019-11-07 22:47:50 +03: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
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
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
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
449fcc5a72
RayCast2D: Fix reporting old collider after collision ended
...
It now behaves the same as RayCast (3D).
Fixed documentation accordingly and documented new configuration options.
Supersedes and closes #20567 .
2018-08-30 16:28:48 +02:00
5267099a87
doc: Sync classref with current source
2018-08-29 22:25:11 +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
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
0ec8f4c06b
Added description to get_collision_mask_bit and set_collision_mask_bit in RayCast2D.xml
2018-01-18 23:14:31 +05:30
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +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
15ada56d73
doc: Sync classref with current source
2017-11-24 09:16:27 +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
552ed07cfd
classref: Sync with current source
...
[ci skip]
2017-10-24 19:22:43 +02:00
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
7b12ae39f2
Rename RayCasts collision_layer to collision_mask
...
The point is that `RayCast`s are checked against objects' `collision_layer`(s), but they themselves are considered no to _belong_ to any layer. Therefore, the correct name for their property is `collision_mask`, rather than `collision_layer`.
Only renaming is needed since the behavior was already the right one, only that it wasn't matching what users would expect from the name and description of the property.
Fixes #7589 , where it's also discussed.
2017-10-21 22:17:47 +02:00
4c716f3623
[DOCS] Fix a few typos.
2017-10-14 12:45:49 +02:00
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
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00
4f929a0fdf
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
...
recognize them.
2017-09-12 17:45:41 -03:00
Rémi Verschelde
PouleyKetchoupp
Aaron Franke
Michael Alexsander Silva Dias
Hugo Locurcio
clayjohn
Yuri Roubinsky
Sean Heffernan
LikeLakers2
Anutrix
Pedro J. Estébanez
Andreas Haas
Juan Linietsky