godot/doc/classes/AudioEffectReverb.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectReverb" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Adds a reverberation audio effect to an Audio bus.
	</brief_description>
	<description>
		Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
	</description>
	<tutorials>
		<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<members>
		<member name="damping" type="float" setter="set_damping" getter="get_damping" default="0.5">
			Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.
		</member>
		<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
			Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.
		</member>
		<member name="hipass" type="float" setter="set_hpf" getter="get_hpf" default="0.0">
			High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.
		</member>
		<member name="predelay_feedback" type="float" setter="set_predelay_feedback" getter="get_predelay_feedback" default="0.4">
			Output percent of predelay. Value can range from 0 to 1.
		</member>
		<member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec" default="150.0">
			Time between the original signal and the early reflections of the reverb signal, in milliseconds.
		</member>
		<member name="room_size" type="float" setter="set_room_size" getter="get_room_size" default="0.8">
			Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.
		</member>
		<member name="spread" type="float" setter="set_spread" getter="get_spread" default="1.0">
			Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.
		</member>
		<member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">
			Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.
		</member>
	</members>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
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-14 21:18:53 +08:00			`<class name="AudioEffectReverb" inherits="AudioEffect" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
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-22 07:04:47 +08:00			`Adds a reverberation audio effect to an Audio bus.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Cleanup audio effect class reference pages 2022-06-20 07:11:11 +08:00			`Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Cleanup audio effect class reference pages 2022-06-20 07:11:11 +08:00			`<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>`
Link to demos from within the class reference 2020-10-01 16:34:47 +08:00			`<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</tutorials>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="damping" type="float" setter="set_damping" getter="get_damping" default="0.5">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="hipass" type="float" setter="set_hpf" getter="get_hpf" default="0.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="predelay_feedback" type="float" setter="set_predelay_feedback" getter="get_predelay_feedback" default="0.4">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Output percent of predelay. Value can range from 0 to 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec" default="150.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Time between the original signal and the early reflections of the reverb signal, in milliseconds.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="room_size" type="float" setter="set_room_size" getter="get_room_size" default="0.8">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="spread" type="float" setter="set_spread" getter="get_spread" default="1.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
			`</members>`
			`</class>`