summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamPlayer3D.xml
AgeCommit message (Collapse)Author
2022-11-22Fix AudioStreamPlayer2D and 3D's `playing` not updating right awayMicky
2022-09-17Rename AudioStreamPlayer3D's `unit_db` to `volume_db`Micky
AudioStreamPlayer3D.`unit_db` -> `volume_db` Now matches the same name AudioStreamPlayer and AudioStreamPlayer2D use.
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (8)Andy Maloney
2022-08-09Add note about using AudioListener2DDan Boorstein
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-08Rename the argument tag to param in XML documentationYuri Sizov
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-25Tweak AudioStreamPlayer3D property hints for usabilityHugo Locurcio
This also improves the documentation for the `max_distance` property.
2021-09-17Merge pull request #52774 from Calinou/audiostreamplayer3d-remove-out-of-rangeRémi Verschelde
2021-09-17Remove unused `out_of_range_mode` property from AudioStreamPlayer3DHugo Locurcio
The `out_of_range_mode` property is no longer used since audio mixing was moved out of the various AudioStreamPlayer nodes.
2021-09-16Rename Listener2D/Listener3D to AudioListener2D/AudioListener3DWilson E. Alvarez
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-06Increase the default AudioStreamPlayer3D unit size to 10Hugo Locurcio
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-05Improve the AudioStreamPlayer(2D/3D) class descriptionsHugo Locurcio
2020-11-23Improve the AudioStreamPlayer3D class documentationHugo 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-08-27Mention listener node in AudioStreamPlayer3D descriptionskyace65
2020-04-26Improve `pitch_scale` descriptions in AudioStreamPlayer documentationHugo Locurcio
This closes #29439. Co-authored-by: Cheeseness <contact@jbushproductions.com>
2020-03-30doc: Update classref with node renamesRémi Verschelde
A few extra renames for classes which were missed in last week's PRs.
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-22Merge pull request #26868 from NilsIrl/masterRémi Verschelde
Add Attenuation Model "NO" for AudioStreamPlayer3D
2019-04-22Add Attenuation Model "DISABLED" for AudioStreamPlayer3DNils ANDRÉ-CHANG
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-03-30Added missing end points for brief descriptions in the docs.Michael Alexsander Silva Dias
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.