summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamPlayer2D.xml
AgeCommit message (Collapse)Author
2022-07-08AudioStreamPlayer: Clarify that no validation is made on 'bus' nameRémi Verschelde
Supersedes #39605. Fixes #39585.
2022-06-17Audio: Expose 2D/3D panning strength parametersEllen Poe
2022-02-15Add an XML schema for documentationHugo Locurcio
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-10Improve the `AudioStreamPlayer2D/3D.area_mask` documentationHugo Locurcio
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 :)
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-09-07Add polyphony to Audio Stream Player nodesEllen Poe
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
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-06-10Let var2str display StringName with correct sigilJonathan Gollnick
2021-05-05Improve the AudioStreamPlayer(2D/3D) class descriptionsHugo Locurcio
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-04-26Improve `pitch_scale` descriptions in AudioStreamPlayer documentationHugo Locurcio
This closes #29439. Co-authored-by: Cheeseness <contact@jbushproductions.com>
2020-02-22doc: Sync classref with StringName/Callable changesRémi Verschelde
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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-10Complete documentation of various classesTomasz Chabora
2019-07-15doc: Sync classref with current sourceRémi Verschelde
2019-06-30doc: Remove hardcoded default values from descriptionsRémi Verschelde
They are now generated automatically by doctool.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-15doc: Sync classref with current sourceRémi Verschelde
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-01-07doc: Fix wrong references found by Sphinx and new makerst.pyRémi Verschelde
2018-12-20doc: Add missing commas after "If true/false"Rémi Verschelde
2018-11-05doc: Use HTTPS for docs.godotengine.org and point to latest branchRémi Verschelde
Fixes #23509.
2018-07-26doc: Sync classref with current sourceRémi Verschelde
Fix various missing arguments in bindings.
2018-06-12Add support for tutorial links to makerst.pyrobojumper
Also change the <tutorials> structure to make use of individual <link> tags
2018-05-04Added a description to the picth_scale property in the AudioStreamPlayer ↵Nobelix
classes.
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Sync classref with current sourceRémi Verschelde
2018-02-19doc: Update version string in headerRémi Verschelde
2018-01-25doc: Fix references to online tutorials after godotengine/godot-docs#1015Rémi Verschelde
2018-01-25doc: Sync with current sourceRémi Verschelde
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-15Filled tutorial field in most relevent classes.Juan Linietsky
Added tutorial display in doc.
2018-01-13doc: Update version string in XMLRémi Verschelde
2017-11-24doc: Remove setters and getters now exposed via properties/membersRémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-10-11updated AudioStream docs and added AudioServer docsGrosskopf
2017-09-23Rename get_position => get_playback_position and seek_pos => seek on audio ↵Marcelo Fernandez
classes
2017-09-23doc: Sync classref with current sourceRémi Verschelde
[ci skip]
2017-09-20Rename pos to position in user facing methods and variablesletheed
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-17Added Documentation of AudioStreamPlayer2DGrosskopf
Fixxed according to comments Somehow that fix was messed up again Forgot some quotationmarks updated autoplay, tried again
2017-09-13doc: Sync classref with current sourceRémi Verschelde
[ci skip]
2017-09-13doc: Sync classref with current sourceRémi Verschelde
[ci skip]
2017-09-12Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky
possible to save module files in module directories and the build system will recognize them.