Rémi Verschelde
b40f3f9740
Style: Sync other changes from new fix_style.sh and clang_format.sh
2020-07-24 10:39:18 +02:00
SaviHex
fda49b74a1
Added a "title" attribute for the link tag in the docs xml
...
(cherry picked from commit 18c08f65d6
)
2020-06-11 09:44:14 +02:00
Umang Kalra
f9dcc30566
Edited the KinematicBody and KinematicBody2D docs
...
Explained the reason why move_and_slide should be used in _physics_process
(cherry picked from commit b7dbf41aa5
)
2020-03-06 23:54:56 +01: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
Marcel Admiraal
907adb37ce
Fixes get_floor_normal() returning the user defined floor_normal.
...
When there is no collision with a floor the get_floor_normal() function
should return the zero vector to be consistent with get_floor_velocity().
Renames floor_normal to up_direction in all bindings.
Updates the documentation of get_floor_normal() and get_floor_velocity()
to make it clear when the values are valid. Updates the documentation for
move_and_slide() and move_and_slide_with_snap() to use the new up_direction
parameter name.
2020-01-15 10:13:35 +01:00
Rémi Verschelde
40f0649e5b
Fix typos with codespell
...
Using codespell 1.16.0.
See ab3bccdb78
for procedure.
2020-01-15 00:49:52 +01:00
Rémi Verschelde
7f9bf5472c
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
Chris Bradfield
7f4059ceb7
[DOCS] Correct "fixed process" reference in KinematicBody doc
2019-07-26 18:50:12 -07:00
Andrii Doroshenko (Xrayez)
8ba50823c4
Make KinematicBody docs consistent regarding `test_only` argument
...
This simply makes the `move_and_collide` method descriptions in
both 2D and 3D to be in sync.
Co-authored-by: 2DemiGods <2DemiGods@users.noreply.github.com>
2019-07-25 15:09:25 +03: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
Guilherme Felipe
36e9af4812
Docs: Add tutorials for KinematicBody2D
2019-05-08 13:45:40 -03:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +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
Tomasz Chabora
0e93714ff7
Better documentation for some move_and_slide parameters
2019-03-23 15:06:50 +01:00
Chris Bradfield
454b701e76
[DOCS] minor classref updates
2019-03-14 11:36:12 -07:00
Michael Alexsander Silva Dias
1b4228cb48
Remove "TODO" instances in the docs
2019-03-05 11:02:44 -03:00
Juan Linietsky
5cfedd46ce
Further clarify docs for #26545
2019-03-04 09:53:02 -03:00
Aaron Franke
763353692b
Improve docs for KinematicBody linear_velocity, fixes #23927
2019-01-18 17:48:16 -05:00
Chris Bradfield
725eb9de8c
DOCS: correction to move_and_slide description
2019-01-16 13:26:17 -08:00
Rémi Verschelde
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
Rémi Verschelde
2815e708a0
Merge pull request #23090 from DavidSichma/inconsistent-kinematic
...
Consistency in KinematicBody
2018-11-12 20:30:38 +01:00
Alex
e3d7ac17e0
fix doc markdown
2018-10-18 11:48:11 -04:00
David Sichma
6ec4da2e3b
Fix inconsistency in KinematicBody
...
- moved new infinite_inertia argument of move_and_slide and
move_and_slide_with_snap in KinematicBody and KinematicBody2D to the
end if not already there. This makes the order of arguments consistent
and should keep projects from 3.0 compatible as this argument did not
exist in 3.0. Docs updated accordingly.
- renamed max_bounces to max_slides for consistency. Docs updated
accordingly.
- the argument infinite_inertia in test_move is now optional, as it is
in every other movement related method. This closes #22829 .
2018-10-17 17:22:14 +02:00
Rémi Verschelde
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
Chris Bradfield
2a0991dde6
[DOCS] Many class ref updates
2018-08-18 21:35:56 -07:00
Rémi Verschelde
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +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
Poommetee Ketson
eb63f7b071
[DOCS] Sync classref with current source
2018-02-25 15:14:25 +07: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
9f479f096c
Fix typos in code and docs with codespell
...
Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 22:01:42 +01:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +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
Martin Capitanio
7c3ba6f72b
Fix the class docs for the rst-syntax errors.
...
- Generate a correkt rst-syntax for the [/code] inline markup.
(http://www.sphinx-doc.org/en/1.6.5/rest.html#inline-markup )
- Fix xml souce bugs
for the sphinx's rst syntax werrors:
class_area.rst:319: WARNING: Inline literal start-string without end-string.
class_area2d.rst:287: WARNING: Inline literal start-string without end-string.
class_audioserver.rst:287: WARNING: Inline literal start-string without end-string.
class_control.rst:509: WARNING: Inline literal start-string without end-string.
class_image.rst:422: WARNING: Inline literal start-string without end-string.
class_image.rst:434: WARNING: Inline literal start-string without end-string.
class_inputevent.rst:74: WARNING: Inline literal start-string without end-string.
class_inputeventaction.rst:45: WARNING: Inline literal start-string without end-string.
class_inputmap.rst:47: WARNING: Inline literal start-string without end-string.
class_kinematicbody.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string.
class_kinematicbody2d.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string.
class_line2d.rst:182: WARNING: Inline literal start-string without end-string.
class_thread.rst:51: WARNING: Inline literal start-string without end-string.
class_treeitem.rst:160: WARNING: Inline literal start-string without end-string.
2017-11-19 20:47:36 +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
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
Benjamin Larsson
fc839f9fe8
Fix a typo in KinematicBody and KinematicBody2D.
2017-10-08 18:39:24 +02:00
Benjamin Larsson
acf81338aa
Minor fixes to KinematicBody and KinematicBody2D
2017-10-07 22:57:31 +02:00
Benjamin Larsson
9b15bf26f6
Edit move_and_slide, it does a bit more than I first thought.
2017-10-07 22:40:18 +02:00
Benjamin Larsson
5e7b98171b
Fixed an error in get_floor_velocity() docs
2017-10-07 22:10:28 +02:00
Benjamin Larsson
94150b8e8e
Small changes to KinematicBody2D docs.
2017-10-07 20:31:04 +02:00
Benjamin Larsson
25300a324c
Update KinematicBody2D docs.
2017-10-07 20:31:04 +02:00
Chris Bradfield
33da7b4913
Document new KinematicCollision2D class
2017-09-16 18:42:07 -07:00