quinnyo
edf7f5cf3e
Replace "dampen" with "damp", "attenuate" in class docs
2023-02-08 08:01:32 +10:00
Silc Renew
75330887d7
Implement blending audio feature to AnimationTree
2023-01-28 20:08:29 +09:00
Micky
b6db09968d
Fix AudioStreamPlayer2D and 3D's playing
not updating right away
2022-11-22 15:46:28 +01:00
Micky
eb0cc08a23
Rename AudioStreamPlayer3D's unit_db
to volume_db
...
AudioStreamPlayer3D.`unit_db` -> `volume_db`
Now matches the same name AudioStreamPlayer and AudioStreamPlayer2D use.
2022-09-17 16:06:30 +02:00
Andy Maloney
9b345e793a
[doc] Use "param" instead of "code" to refer to parameters (8)
2022-08-12 14:00:25 -04:00
Dan Boorstein
a7ebc6fb18
Add note about using AudioListener2D
...
There was no mention of the effect of AudioListener2D in this documentation, making it unclear if there was a relationship. The new text is copied and modified from the AudioStreamPlayer3D documentation.
Use 'an' as article before 'AudioListener3D'
2022-08-09 21:58:42 -08:00
Yuri Sizov
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
Rémi Verschelde
eedb729771
AudioStreamPlayer: Clarify that no validation is made on 'bus' name
...
Supersedes #39605 .
Fixes #39585 .
2022-07-08 09:33:25 +02:00
Ellen Poe
d384d84f45
Audio: Expose 2D/3D panning strength parameters
2022-06-17 13:08:48 +02:00
Hugo Locurcio
b68dd2e189
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-02-15 00:03:31 +01:00
Hugo Locurcio
ab1eaac315
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 :)
2022-02-10 23:26:29 +01:00
Rémi Verschelde
6c1bd4d227
Replace Godot docs URL with $DOCS_URL
in XML class reference
2021-11-15 13:02:21 +01:00
Hugo Locurcio
b383181851
Tweak AudioStreamPlayer3D property hints for usability
...
This also improves the documentation for the `max_distance` property.
2021-09-25 12:24:30 +02:00
Rémi Verschelde
43cc6dd479
Merge pull request #52774 from Calinou/audiostreamplayer3d-remove-out-of-range
2021-09-17 21:56:59 +02:00
Hugo Locurcio
973f52b784
Remove unused out_of_range_mode
property from AudioStreamPlayer3D
...
The `out_of_range_mode` property is no longer used since audio mixing
was moved out of the various AudioStreamPlayer nodes.
2021-09-17 20:18:38 +02:00
Wilson E. Alvarez
f3a564f9a5
Rename Listener2D/Listener3D to AudioListener2D/AudioListener3D
2021-09-16 17:51:51 -04:00
Ellen Poe
0e3cab41eb
Add polyphony to Audio Stream Player nodes
2021-09-07 09:44:39 -07:00
Rémi Verschelde
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
Jonathan Gollnick
6710ad1737
Let var2str display StringName with correct sigil
2021-06-10 16:30:28 -05:00
Hugo Locurcio
87d107bb11
Increase the default AudioStreamPlayer3D unit size to 10
...
This makes it easier to hear sound while setting up the node.
Since this changes the default value, this may break existing projects
slightly.
This also tweaks the Unit Size editor property hint for better usability.
See discussion in #25468 .
2021-05-06 02:45:46 +02:00
Hugo Locurcio
b90adec417
Improve the AudioStreamPlayer(2D/3D) class descriptions
2021-05-05 20:39:36 +02:00
Hugo Locurcio
95618e2937
Improve the AudioStreamPlayer3D class documentation
2020-11-23 16:56:05 +01:00
Hugo Locurcio
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
skyace65
51367c1bcf
Mention listener node in AudioStreamPlayer3D description
2020-08-27 12:44:20 -04:00
Hugo Locurcio
4751dee7f4
Improve pitch_scale
descriptions in AudioStreamPlayer documentation
...
This closes #29439 .
Co-authored-by: Cheeseness <contact@jbushproductions.com>
2020-04-26 16:37:57 +02:00
Rémi Verschelde
eaaee63b62
doc: Update classref with node renames
...
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
Rémi Verschelde
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
clayjohn
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08: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
Tomasz Chabora
508e624b87
Complete documentation of various classes
2020-01-10 14:14:07 +01:00
Rémi Verschelde
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
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
886afa9b76
Merge pull request #26868 from NilsIrl/master
...
Add Attenuation Model "NO" for AudioStreamPlayer3D
2019-04-22 13:36:07 +02:00
Nils ANDRÉ-CHANG
a1fc73e6d3
Add Attenuation Model "DISABLED" for AudioStreamPlayer3D
2019-04-22 10:34:28 +01:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02: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
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
Rémi Verschelde
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +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
Nobelix
83c4fc2c88
Added a description to the picth_scale property in the AudioStreamPlayer classes.
2018-05-04 13:31:11 +02:00
Michael Alexsander Silva Dias
d912e10c65
Added missing end points for brief descriptions in the docs.
2018-03-30 20:11:14 -03: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
fee29570d0
doc: Sync classref with current source
2018-02-19 10:47:16 +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