From 266dc732baea350bc5bed40c69eb27cfdce5f782 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 2 Jul 2019 12:04:26 +0200 Subject: doc: Sync classref with current source --- doc/classes/AudioServer.xml | 68 ++++++++------------------------------- doc/classes/CPUParticles.xml | 3 ++ doc/classes/CPUParticles2D.xml | 3 ++ doc/classes/Line2D.xml | 2 +- doc/classes/ParticlesMaterial.xml | 3 ++ 5 files changed, 23 insertions(+), 56 deletions(-) diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index f063cfe5ce..7581ae6935 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -68,13 +68,6 @@ Returns the amount of channels of the bus at index [code]bus_idx[/code]. - - - - - Returns the number of available buses. - - @@ -165,36 +158,25 @@ Returns the volume of the bus at index [code]bus_idx[/code] in dB. - - - - - - - - - - - - - Returns the global rate scale at which audio is being played. + Returns the names of all audio devices detected on the system. - Returns the sample rate at the output of the audioserver. + Returns the sample rate at the output of the [AudioServer]. + Returns the audio driver's output latency. @@ -258,7 +240,7 @@ - Locks the audio drivers mainloop. Remember to unlock it afterwards. + Locks the audio driver's main loop. Remember to unlock it afterwards. @@ -303,15 +285,6 @@ If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. - - - - - - - Adds and removes buses to make the number of buses match [code]amount[/code]. - - @@ -389,23 +362,6 @@ Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. - - - - - - - - - - - - - - - Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast). - - @@ -428,12 +384,13 @@ - - Adds and removes buses to make the number of buses match [code]amount[/code]. + + Number of available audio buses. - + + Name of the current device (see [method get_device_list]). - + Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast). @@ -446,15 +403,16 @@ - Two or fewer speakers are detected. + Two or fewer speakers were detected. + A 3.1 channel surround setup was detected. - A 5.1 channel surround setup detected. + A 5.1 channel surround setup was detected. - A 7.1 channel surround setup detected. + A 7.1 channel surround setup was detected. diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index bd59bdbf9f..8152a52c86 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -82,6 +82,9 @@ Damping randomness ratio. + + Unit vector specifying the particles' emission direction. + Particle draw order. Uses [enum DrawOrder] values. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 5ec460abb7..585b8b5f5b 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -83,6 +83,9 @@ Damping randomness ratio. + + Unit vector specifying the particles' emission direction. + Particle draw order. Uses [enum DrawOrder] values. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index b627ae7344..106c736147 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -99,7 +99,7 @@ The line's width. - + The line's width varies with the curve. The original width is simply multiply by the value of the Curve. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index e0618a87c1..ff8e01c6c9 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -66,6 +66,9 @@ Damping randomness ratio. + + Unit vector specifying the particles' emission direction. + The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX]. -- cgit v1.2.3