virtualx-engine/doc/classes/AudioEffectReverb.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectReverb" inherits="AudioEffect" version="3.2">
	<brief_description>
		Adds a reverberation audio effect to an Audio bus.
		Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
	</brief_description>
	<description>
		Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<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>
	<constants>
	</constants>
</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-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
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:01:49 +01:00			`<class name="AudioEffectReverb" inherits="AudioEffect" version="3.2">`
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-12 22:42:36 +02: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 01:04:47 +02:00			`Adds a reverberation audio effect to an Audio bus.`
[DOCS] Adds AudioEffects doc 2017-09-16 18:47:19 +02: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-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
[DOCS] Adds AudioEffects doc 2017-09-16 18:47:19 +02:00			`Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.`
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-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02: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 15:24:23 +02: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-12 22:42:36 +02:00			`</member>`
			`</members>`
			`<constants>`
			`</constants>`
			`</class>`