Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix properties still using a slash delimiter #44876

Closed
wants to merge 2 commits into from
Closed

Fix properties still using a slash delimiter #44876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54d639e
Fix properties still using a slash delimiter
madmiraal Jan 1, 2021
206e091
Fix built properties still using a slash delimiter
madmiraal Jan 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 63 additions & 51 deletions doc/classes/AudioEffectChorus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the specified voice's cutoff frequency in Hz.
</description>
</method>
<method name="get_voice_delay_ms" qualifiers="const">
Expand All @@ -23,6 +24,7 @@
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the specified voice's signal delay in milliseconds.
</description>
</method>
<method name="get_voice_depth_ms" qualifiers="const">
Expand All @@ -31,6 +33,7 @@
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the specified voice's depth in milliseconds.
</description>
</method>
<method name="get_voice_level_db" qualifiers="const">
Expand All @@ -39,6 +42,7 @@
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the specified voice's decibel level.
</description>
</method>
<method name="get_voice_pan" qualifiers="const">
Expand All @@ -47,6 +51,7 @@
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the specified voice's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</description>
</method>
<method name="get_voice_rate_hz" qualifiers="const">
Expand All @@ -55,6 +60,7 @@
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the specified voice's rate in Hz.
</description>
</method>
<method name="set_voice_cutoff_hz">
Expand All @@ -65,6 +71,7 @@
<argument index="1" name="cutoff_hz" type="float">
</argument>
<description>
Sets the specified voice's cutoff frequency in Hz.
</description>
</method>
<method name="set_voice_delay_ms">
Expand All @@ -75,6 +82,7 @@
<argument index="1" name="delay_ms" type="float">
</argument>
<description>
Sets the specified voice's signal delay in milliseconds.
</description>
</method>
<method name="set_voice_depth_ms">
Expand All @@ -85,6 +93,7 @@
<argument index="1" name="depth_ms" type="float">
</argument>
<description>
Sets the specified voice's depth in milliseconds.
</description>
</method>
<method name="set_voice_level_db">
Expand All @@ -95,6 +104,7 @@
<argument index="1" name="level_db" type="float">
</argument>
<description>
Sets the specified voice's decibel level.
</description>
</method>
<method name="set_voice_pan">
Expand All @@ -105,6 +115,7 @@
<argument index="1" name="pan" type="float">
</argument>
<description>
Sets the specified voice's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</description>
</method>
<method name="set_voice_rate_hz">
Expand All @@ -115,90 +126,91 @@
<argument index="1" name="rate_hz" type="float">
</argument>
<description>
Sets the specified voice's rate in Hz.
</description>
</method>
</methods>
<members>
<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
The effect's raw signal.
The proportion of the original sound to include. At [code]0[/code], only the chorus sounds are output. The value can range from [code]0[/code] to [code]1[/code].
</member>
<member name="voice/1/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="8000.0">
The voice's cutoff frequency.
<member name="voice_1_cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="8000.0">
Voice 1's cutoff frequency in Hz.
</member>
<member name="voice/1/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="15.0">
The voice's signal delay.
<member name="voice_1_delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="15.0">
Voice 1's signal delay in milliseconds.
</member>
<member name="voice/1/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="2.0">
The voice filter's depth.
<member name="voice_1_depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="2.0">
Voice 1's depth in milliseconds.
</member>
<member name="voice/1/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="0.0">
The voice's volume.
<member name="voice_1_level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="0.0">
Voice 1's decibel level.
</member>
<member name="voice/1/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="-0.5">
The voice's pan level.
<member name="voice_1_pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="-0.5">
Voice 1's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</member>
<member name="voice/1/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="0.8">
The voice's filter rate.
<member name="voice_1_rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="0.8">
Voice 1's rate in Hz.
</member>
<member name="voice/2/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="8000.0">
The voice's cutoff frequency.
<member name="voice_2_cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="8000.0">
Voice 2's cutoff frequency in Hz.
</member>
<member name="voice/2/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="20.0">
The voice's signal delay.
<member name="voice_2_delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="20.0">
Voice 2's signal delay in milliseconds.
</member>
<member name="voice/2/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="3.0">
The voice filter's depth.
<member name="voice_2_depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="3.0">
Voice 2's depth in milliseconds.
</member>
<member name="voice/2/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="0.0">
The voice's volume.
<member name="voice_2_level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="0.0">
Voice 2's decibel level.
</member>
<member name="voice/2/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="0.5">
The voice's pan level.
<member name="voice_2_pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="0.5">
Voice 2's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</member>
<member name="voice/2/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="1.2">
The voice's filter rate.
<member name="voice_2_rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="1.2">
Voice 2's rate in Hz.
</member>
<member name="voice/3/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
The voice's cutoff frequency.
<member name="voice_3_cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
Voice 3's cutoff frequency in Hz.
</member>
<member name="voice/3/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
The voice's signal delay.
<member name="voice_3_delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
Voice 3's signal delay in milliseconds.
</member>
<member name="voice/3/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
The voice filter's depth.
<member name="voice_3_depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
Voice 3's depth in milliseconds.
</member>
<member name="voice/3/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
The voice's volume.
<member name="voice_3_level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
Voice 3's decibel level.
</member>
<member name="voice/3/pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
The voice's pan level.
<member name="voice_3_pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
Voice 3's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</member>
<member name="voice/3/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
The voice's filter rate.
<member name="voice_3_rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
Voice 3's rate in Hz.
</member>
<member name="voice/4/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
The voice's cutoff frequency.
<member name="voice_4_cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz">
Voice 4's cutoff frequency in Hz.
</member>
<member name="voice/4/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
The voice's signal delay.
<member name="voice_4_delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms">
Voice 4's signal delay in milliseconds.
</member>
<member name="voice/4/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
The voice filter's depth.
<member name="voice_4_depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms">
Voice 4's depth in milliseconds.
</member>
<member name="voice/4/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
The voice's volume.
<member name="voice_4_level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db">
Voice 4's decibel level.
</member>
<member name="voice/4/pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
The voice's pan level.
<member name="voice_4_pan" type="float" setter="set_voice_pan" getter="get_voice_pan">
Voice 4's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</member>
<member name="voice/4/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
The voice's filter rate.
<member name="voice_4_rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz">
Voice 4's rate in Hz.
</member>
<member name="voice_count" type="int" setter="set_voice_count" getter="get_voice_count" default="2">
The amount of voices in the effect.
The number of voices in the chorus.
</member>
<member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">
The effect's processed signal.
The proportion of the processed sound to include. At [code]0[/code], only the original sound is output. Value can range from [code]0[/code] to [code]1[/code].
</member>
</members>
<constants>
Expand Down
46 changes: 23 additions & 23 deletions doc/classes/AudioEffectDelay.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,43 +13,43 @@
</methods>
<members>
<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
The proportion of the original sound to include. At [code]0[/code], only delayed sounds are output. The value can range from [code]0[/code] to [code]1[/code].
</member>
<member name="feedback/active" type="bool" setter="set_feedback_active" getter="is_feedback_active" default="false">
<member name="feedback_active" type="bool" setter="set_feedback_active" getter="is_feedback_active" default="false">
If [code]true[/code], feedback is enabled.
</member>
<member name="feedback/delay_ms" type="float" setter="set_feedback_delay_ms" getter="get_feedback_delay_ms" default="340.0">
<member name="feedback_delay_ms" type="float" setter="set_feedback_delay_ms" getter="get_feedback_delay_ms" default="340.0">
Feedback delay time in milliseconds.
</member>
<member name="feedback/level_db" type="float" setter="set_feedback_level_db" getter="get_feedback_level_db" default="-6.0">
Sound level for [code]tap1[/code].
<member name="feedback_level_db" type="float" setter="set_feedback_level_db" getter="get_feedback_level_db" default="-6.0">
Feedback decibel level.
</member>
<member name="feedback/lowpass" type="float" setter="set_feedback_lowpass" getter="get_feedback_lowpass" default="16000.0">
Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
<member name="feedback_low_pass" type="float" setter="set_feedback_low_pass" getter="get_feedback_low_pass" default="16000.0">
The feedback low-pass cutoff frequency in Hz. Frequencies below this value are filtered out of the source signal.
</member>
<member name="tap1/active" type="bool" setter="set_tap1_active" getter="is_tap1_active" default="true">
If [code]true[/code], [code]tap1[/code] will be enabled.
<member name="tap_1_active" type="bool" setter="set_tap_1_active" getter="is_tap_1_active" default="true">
If [code]true[/code], tap 1 will be enabled.
</member>
<member name="tap1/delay_ms" type="float" setter="set_tap1_delay_ms" getter="get_tap1_delay_ms" default="250.0">
[code]tap1[/code] delay time in milliseconds.
<member name="tap_1_delay_ms" type="float" setter="set_tap_1_delay_ms" getter="get_tap_1_delay_ms" default="250.0">
Tap 1's delay time in milliseconds.
</member>
<member name="tap1/level_db" type="float" setter="set_tap1_level_db" getter="get_tap1_level_db" default="-6.0">
Sound level for [code]tap1[/code].
<member name="tap_1_level_db" type="float" setter="set_tap_1_level_db" getter="get_tap_1_level_db" default="-6.0">
Tap 1's decibel level.
</member>
<member name="tap1/pan" type="float" setter="set_tap1_pan" getter="get_tap1_pan" default="0.2">
Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right).
<member name="tap_1_pan" type="float" setter="set_tap_1_pan" getter="get_tap_1_pan" default="0.2">
Tap 1's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</member>
<member name="tap2/active" type="bool" setter="set_tap2_active" getter="is_tap2_active" default="true">
If [code]true[/code], [code]tap2[/code] will be enabled.
<member name="tap_2_active" type="bool" setter="set_tap_2_active" getter="is_tap_2_active" default="true">
If [code]true[/code], tap 2 will be enabled.
</member>
<member name="tap2/delay_ms" type="float" setter="set_tap2_delay_ms" getter="get_tap2_delay_ms" default="500.0">
[b]Tap2[/b] delay time in milliseconds.
<member name="tap_2_delay_ms" type="float" setter="set_tap_2_delay_ms" getter="get_tap_2_delay_ms" default="500.0">
Tap 2's delay time in milliseconds.
</member>
<member name="tap2/level_db" type="float" setter="set_tap2_level_db" getter="get_tap2_level_db" default="-12.0">
Sound level for [code]tap2[/code].
<member name="tap_2_level_db" type="float" setter="set_tap_2_level_db" getter="get_tap_2_level_db" default="-12.0">
Tap 2's decibel level.
</member>
<member name="tap2/pan" type="float" setter="set_tap2_pan" getter="get_tap2_pan" default="-0.4">
Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right).
<member name="tap_2_pan" type="float" setter="set_tap_2_pan" getter="get_tap_2_pan" default="-0.4">
Tap 2's pan position. A pan of [code]-1[/code] is fully to the left. A pan of [code]1[/code] is fully to the right.
</member>
</members>
<constants>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/ConeTwistJoint3D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ConeTwistJoint3D" inherits="Joint3D" version="4.0">
<brief_description>
A twist joint between two 3D PhysicsBodies.
A cone-limited 3D twist joint.
</brief_description>
<description>
The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint3D].
The twist axis is initiated as the X axis of the [Joint3D].
Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint3D in the local space of the two Bodies. See also [Generic6DOFJoint3D].
Allows the attached bodies to rotate around the X axis of the joint, and hinge to specified limits around the other axes. The twist axis is calculated as the middle of the X axis of the joint in the local space of the two bodies.
</description>
<tutorials>
</tutorials>
Expand All @@ -17,6 +15,7 @@
<argument index="0" name="param" type="int" enum="ConeTwistJoint3D.Param">
</argument>
<description>
Returns the current value of the specified [enum Param].
</description>
</method>
<method name="set_param">
Expand All @@ -27,6 +26,7 @@
<argument index="1" name="value" type="float">
</argument>
<description>
Sets the specified [enum Param] to [code]value[/code].
</description>
</method>
</methods>
Expand All @@ -41,13 +41,13 @@
<member name="softness" type="float" setter="set_param" getter="get_param" default="0.8">
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
</member>
<member name="swing_span" type="float" setter="_set_swing_span" getter="_get_swing_span" default="45.0">
<member name="swing_span" type="float" setter="set_swing_span" getter="get_swing_span" default="45.0">
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected along the swing axis.
Could be defined as looseness in the [ConeTwistJoint3D].
If below 0.05, this behavior is locked.
</member>
<member name="twist_span" type="float" setter="_set_twist_span" getter="_get_twist_span" default="180.0">
<member name="twist_span" type="float" setter="set_twist_span" getter="get_twist_span" default="180.0">
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
Twist is locked if below 0.05.
</member>
Expand All @@ -74,7 +74,7 @@
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
</constant>
<constant name="PARAM_MAX" value="5" enum="Param">
Represents the size of the [enum Param] enum.
The number of [ConeTwistJoint3D] parameters.
</constant>
</constants>
</class>
Loading