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
f1d289f6eb
Improve the `AudioStreamPlayer2D/3D.area_mask` documentation
...
The documentation was stating that the area mask affects where sounds
can be heard, which is not true. Instead, the area mask affects audio
bus redirection.
Thanks to Azedaxen on the Godot forums for providing this description :)
(cherry picked from commit ab1eaac315
2022-02-11 09:51:50 +01:00
3ac2999f22
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:22:47 +01:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
dc3b614a6a
Tweak AudioStreamPlayer3D property hints for usability
...
This also improves the documentation for the `max_distance` property.
(cherry picked from commit b383181851
2021-10-18 11:24:42 +02:00
4914b57222
Enable Doppler preview in the 3D editor by default
...
This makes setting up AudioStreamPlayer3D nodes for Doppler playback
a bit easier.
- Move AudioStreamPlayer3D's Doppler Tracking property outside a group
since the group only had 1 property, which resulted in unnecessary
folding in the inspector.
- Put the AudioStreamPlayer3D Playing and Autoplay properties higher up
in the inspector since these are likely to be modified often.
2021-09-17 18:51:09 +02:00
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
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
9b01143380
Improve the AudioStreamPlayer(2D/3D) class descriptions
...
(cherry picked from commit b90adec417
2021-05-09 17:14:35 +02:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
b2b5d9a7a3
Improve the AudioStreamPlayer3D class documentation
...
(cherry picked from commit 95618e2937
2020-11-26 09:38:47 +01:00
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
8466f9147b
Mention listener node in AudioStreamPlayer3D description
...
(cherry picked from commit 51367c1bcf
2020-08-31 15:29:41 +02:00
ae0bc06eba
Improve `pitch_scale` descriptions in AudioStreamPlayer documentation
...
This closes #29439 .
Co-authored-by: Cheeseness <contact@jbushproductions.com>
(cherry picked from commit 4751dee7f4
2020-04-27 10:18:41 +02: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
508e624b87
Complete documentation of various classes
2020-01-10 14:14:07 +01:00
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02: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
886afa9b76
Merge pull request #26868 from NilsIrl/master
...
Add Attenuation Model "NO" for AudioStreamPlayer3D
2019-04-22 13:36:07 +02:00
a1fc73e6d3
Add Attenuation Model "DISABLED" for AudioStreamPlayer3D
2019-04-22 10:34:28 +01:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
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
83c4fc2c88
Added a description to the picth_scale property in the AudioStreamPlayer classes.
2018-05-04 13:31:11 +02:00
d912e10c65
Added missing end points for brief descriptions in the docs.
2018-03-30 20:11:14 -03: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
fee29570d0
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +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
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +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
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
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
3ac7cc9e57
updated AudioStream docs and added AudioServer docs
2017-10-11 00:51:59 +02:00
46af050e93
Rename get_position => get_playback_position and seek_pos => seek on audio classes
2017-09-23 16:55:00 +02:00
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +02:00
Hugo Locurcio
Rémi Verschelde
skyace65
Tomasz Chabora
Nils ANDRÉ-CHANG
robojumper
Nobelix
Michael Alexsander Silva Dias
Juan Linietsky
Andreas Haas
Grosskopf
Marcelo Fernandez
letheed