diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-29 21:22:15 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-30 13:58:07 +0200 |
| commit | a78373ddc2c1123b13161da2037a16c40a3c4b26 (patch) | |
| tree | 8dbb21b09c12d83789145a06141a89d49e7484fa /doc | |
| parent | b9aa13e5917b45a540e92e50b81f7bc923e493d1 (diff) | |
doc: Remove null default values that can't be determined
Applying #30187.
Diffstat (limited to 'doc')
42 files changed, 218 insertions, 281 deletions
diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index d4a507b597..7d5d8a2db1 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -203,7 +203,7 @@ </method> </methods> <members> - <member name="filter_enabled" type="bool" setter="set_filter_enabled" getter="is_filter_enabled" default="null"> + <member name="filter_enabled" type="bool" setter="set_filter_enabled" getter="is_filter_enabled"> Returns whether filtering is enabled. </member> </members> diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index e4ee9e695a..4d2a11578f 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -9,133 +9,133 @@ <methods> </methods> <members> - <member name="input_0/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_0/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_0/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_0/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_1/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_1/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_1/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_1/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_10/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_10/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_10/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_10/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_11/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_11/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_11/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_11/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_12/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_12/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_12/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_12/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_13/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_13/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_13/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_13/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_14/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_14/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_14/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_14/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_15/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_15/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_15/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_15/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_16/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_16/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_16/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_16/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_17/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_17/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_17/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_17/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_18/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_18/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_18/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_18/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_19/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_19/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_19/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_19/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_2/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_2/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_2/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_2/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_20/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_20/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_20/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_20/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_21/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_21/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_21/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_21/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_22/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_22/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_22/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_22/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_23/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_23/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_23/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_23/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_24/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_24/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_24/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_24/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_25/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_25/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_25/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_25/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_26/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_26/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_26/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_26/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_27/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_27/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_27/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_27/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_28/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_28/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_28/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_28/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_29/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_29/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_29/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_29/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_3/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_3/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_3/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_3/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_30/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_30/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_30/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_30/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_31/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_31/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_31/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_31/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_4/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_4/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_4/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_4/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_5/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_5/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_5/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_5/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_6/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_6/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_6/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_6/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_7/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_7/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_7/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_7/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_8/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_8/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_8/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_8/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> - <member name="input_9/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance" default="null"> + <member name="input_9/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> - <member name="input_9/name" type="String" setter="set_input_caption" getter="get_input_caption" default="null"> + <member name="input_9/name" type="String" setter="set_input_caption" getter="get_input_caption"> </member> <member name="input_count" type="int" setter="set_enabled_inputs" getter="get_enabled_inputs" default="0"> </member> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 5a2ce1b574..b4c44fe8eb 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -223,7 +223,7 @@ </method> </methods> <members> - <member name="assigned_animation" type="String" setter="set_assigned_animation" getter="get_assigned_animation" default="null"> + <member name="assigned_animation" type="String" setter="set_assigned_animation" getter="get_assigned_animation"> If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also [member current_animation]. </member> <member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay" default=""""> @@ -232,16 +232,16 @@ <member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation" default=""""> The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play]. </member> - <member name="current_animation_length" type="float" setter="" getter="get_current_animation_length" default="null"> + <member name="current_animation_length" type="float" setter="" getter="get_current_animation_length"> The length (in seconds) of the currently being played animation. </member> - <member name="current_animation_position" type="float" setter="" getter="get_current_animation_position" default="null"> + <member name="current_animation_position" type="float" setter="" getter="get_current_animation_position"> The position (in seconds) of the currently playing animation. </member> <member name="method_call_mode" type="int" setter="set_method_call_mode" getter="get_method_call_mode" enum="AnimationPlayer.AnimationMethodCallMode" default="0"> The call mode to use for Call Method tracks. </member> - <member name="playback_active" type="bool" setter="set_active" getter="is_active" default="null"> + <member name="playback_active" type="bool" setter="set_active" getter="is_active"> If [code]true[/code], updates animations in response to process-related notifications. </member> <member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time" default="0.0"> diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 7c252b2708..13bc6ac097 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -50,40 +50,40 @@ <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> - <member name="voice/3/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="null"> + <member name="voice/3/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz"> The voice's cutoff frequency. </member> - <member name="voice/3/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="null"> + <member name="voice/3/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms"> The voice's signal delay. </member> - <member name="voice/3/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="null"> + <member name="voice/3/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms"> The voice filter's depth. </member> - <member name="voice/3/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="null"> + <member name="voice/3/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db"> The voice's volume. </member> - <member name="voice/3/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="null"> + <member name="voice/3/pan" type="float" setter="set_voice_pan" getter="get_voice_pan"> The voice's pan level. </member> - <member name="voice/3/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="null"> + <member name="voice/3/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz"> The voice's filter rate. </member> - <member name="voice/4/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz" default="null"> + <member name="voice/4/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz"> The voice's cutoff frequency. </member> - <member name="voice/4/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms" default="null"> + <member name="voice/4/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms"> The voice's signal delay. </member> - <member name="voice/4/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms" default="null"> + <member name="voice/4/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms"> The voice filter's depth. </member> - <member name="voice/4/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db" default="null"> + <member name="voice/4/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db"> The voice's volume. </member> - <member name="voice/4/pan" type="float" setter="set_voice_pan" getter="get_voice_pan" default="null"> + <member name="voice/4/pan" type="float" setter="set_voice_pan" getter="get_voice_pan"> The voice's pan level. </member> - <member name="voice/4/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz" default="null"> + <member name="voice/4/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz"> The voice's filter rate. </member> <member name="voice_count" type="int" setter="set_voice_count" getter="get_voice_count" default="2"> diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index f5336643ab..bd59bdbf9f 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -85,19 +85,19 @@ <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles.DrawOrder" default="0"> Particle draw order. Uses [enum DrawOrder] values. </member> - <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents" default="null"> + <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents"> The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. </member> <member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors" default="PoolColorArray( )"> </member> - <member name="emission_normals" type="PoolVector3Array" setter="set_emission_normals" getter="get_emission_normals" default="null"> + <member name="emission_normals" type="PoolVector3Array" setter="set_emission_normals" getter="get_emission_normals"> </member> <member name="emission_points" type="PoolVector3Array" setter="set_emission_points" getter="get_emission_points" default="PoolVector3Array( )"> </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles.EmissionShape" default="0"> Particles will be emitted inside this region. See [enum EmissionShape] for possible values. </member> - <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius" default="null"> + <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> The sphere's radius if [enum EmissionShape] is set to [constant EMISSION_SHAPE_SPHERE]. </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting" default="true"> @@ -163,14 +163,14 @@ <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot" default="false"> If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. </member> - <member name="orbit_velocity" type="float" setter="set_param" getter="get_param" default="null"> + <member name="orbit_velocity" type="float" setter="set_param" getter="get_param"> Orbital velocity applied to each particle. Makes the particles circle around origin in the local XY plane. Specified in number of full rotations around origin per second. This property is only available when [member flag_disable_z] is [code]true[/code]. </member> - <member name="orbit_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve" default="null"> + <member name="orbit_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> Each particle's orbital velocity will vary along this [Curve]. </member> - <member name="orbit_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="null"> + <member name="orbit_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> Orbital velocity randomness ratio. </member> <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time" default="0.0"> diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 9c27d126c8..5d159c169b 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -86,19 +86,19 @@ <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles2D.DrawOrder" default="0"> Particle draw order. Uses [enum DrawOrder] values. </member> - <member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors" default="null"> + <member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors"> </member> - <member name="emission_normals" type="PoolVector2Array" setter="set_emission_normals" getter="get_emission_normals" default="null"> + <member name="emission_normals" type="PoolVector2Array" setter="set_emission_normals" getter="get_emission_normals"> </member> - <member name="emission_points" type="PoolVector2Array" setter="set_emission_points" getter="get_emission_points" default="null"> + <member name="emission_points" type="PoolVector2Array" setter="set_emission_points" getter="get_emission_points"> </member> - <member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents" default="null"> + <member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents"> The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE]. </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape" default="0"> Particles will be emitted inside this region. See [enum EmissionShape] for possible values. </member> - <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius" default="null"> + <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE]. </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting" default="true"> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 8ae0346efb..e9a9f22e82 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -68,7 +68,7 @@ <member name="current" type="bool" setter="_set_current" getter="is_current" default="false"> If [code]true[/code], the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one. </member> - <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport" default="null"> + <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> The custom [Viewport] node attached to the [Camera2D]. If [code]null[/code] or not a [Viewport], uses the default viewport instead. </member> <member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2"> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 881dbe0f68..5ac825ddcd 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -526,7 +526,7 @@ <member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled" default="false"> If [code]true[/code], the object draws behind its parent. </member> - <member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top" default="null"> + <member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top"> If [code]true[/code], the object draws on top of its parent. </member> <member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false"> diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index aaaea6b7f1..5963e00d9e 100644 --- a/doc/classes/CanvasItemMaterial.xml +++ b/doc/classes/CanvasItemMaterial.xml @@ -17,11 +17,11 @@ <member name="light_mode" type="int" setter="set_light_mode" getter="get_light_mode" enum="CanvasItemMaterial.LightMode" default="0"> The manner in which material reacts to lighting. </member> - <member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames" default="null"> + <member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames"> </member> - <member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop" default="null"> + <member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop"> </member> - <member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames" default="null"> + <member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames"> </member> <member name="particles_animation" type="bool" setter="set_particles_animation" getter="get_particles_animation" default="false"> </member> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index fc0dd21064..2e56009f50 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -20,7 +20,7 @@ </method> </methods> <members> - <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport" default="null"> + <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead. </member> <member name="follow_viewport_enable" type="bool" setter="set_follow_viewport" getter="is_following_viewport" default="false"> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index bdfd97932b..d25c2b31ee 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -714,7 +714,7 @@ <member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" default="false"> Enables whether rendering of children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered. </member> - <member name="rect_global_position" type="Vector2" setter="_set_global_position" getter="get_global_position" default="null"> + <member name="rect_global_position" type="Vector2" setter="_set_global_position" getter="get_global_position"> The node's global position, relative to the world (usually to the top-left corner of the window). </member> <member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size" default="Vector2( 0, 0 )"> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index ca7d57dbd0..c91ddccaa4 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -183,7 +183,7 @@ <member name="blocking_mode_enabled" type="bool" setter="set_blocking_mode" getter="is_blocking_mode_enabled" default="false"> If [code]true[/code], execution will block until all data is read from the response. </member> - <member name="connection" type="StreamPeer" setter="set_connection" getter="get_connection" default="null"> + <member name="connection" type="StreamPeer" setter="set_connection" getter="get_connection"> The connection to use for this client. </member> </members> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 3b87150cca..5d5d492439 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -11,16 +11,16 @@ <methods> </methods> <members> - <member name="error" type="int" setter="set_error" getter="get_error" enum="Error" default="null"> + <member name="error" type="int" setter="set_error" getter="get_error" enum="Error"> The error type if the JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. </member> - <member name="error_line" type="int" setter="set_error_line" getter="get_error_line" default="117929728"> + <member name="error_line" type="int" setter="set_error_line" getter="get_error_line" default="116547728"> The line number where the error occurred if JSON source was not successfully parsed. </member> <member name="error_string" type="String" setter="set_error_string" getter="get_error_string" default=""""> The error message if JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. </member> - <member name="result" type="Variant" setter="set_result" getter="get_result" default="null"> + <member name="result" type="Variant" setter="set_result" getter="get_result"> A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with braces ([code][][/code]), an [Array] will be returned. [b]Note:[/b] The JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. [b]Note:[/b] JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 70d8106674..4ce28b25c9 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -18,7 +18,7 @@ <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> The colliding body's unique [RID]. </member> - <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata" default="null"> + <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata"> The colliding body's metadata. See [Object]. </member> <member name="collider_shape" type="Object" setter="" getter="get_collider_shape" default="null"> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index cde87dd131..91cee3d05a 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -18,7 +18,7 @@ <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> The colliding body's unique [RID]. </member> - <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata" default="null"> + <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata"> The colliding body's metadata. See [Object]. </member> <member name="collider_shape" type="Object" setter="" getter="get_collider_shape" default="null"> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index 6add0e2f1d..5f8c7ed120 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -91,7 +91,7 @@ If [code]true[/code] (or if the [member network_peer] has [member PacketPeer.allow_object_decoding] set to [code]true[/code]), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </member> - <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer" default="null"> + <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. </member> <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections" default="false"> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index eee8e5dcf2..f6c7a7d1b5 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -103,7 +103,7 @@ </member> <member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles" default="false"> </member> - <member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="null"> + <member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> </member> <member name="geometry/parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type" default="0"> </member> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index fa79513bab..5a90354124 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -813,19 +813,19 @@ </method> </methods> <members> - <member name="custom_multiplayer" type="MultiplayerAPI" setter="set_custom_multiplayer" getter="get_custom_multiplayer" default="null"> + <member name="custom_multiplayer" type="MultiplayerAPI" setter="set_custom_multiplayer" getter="get_custom_multiplayer"> The override to the default [MultiplayerAPI]. Set to [code]null[/code] to use the default [SceneTree] one. </member> - <member name="filename" type="String" setter="set_filename" getter="get_filename" default="null"> + <member name="filename" type="String" setter="set_filename" getter="get_filename"> When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. </member> - <member name="multiplayer" type="MultiplayerAPI" setter="" getter="get_multiplayer" default="null"> + <member name="multiplayer" type="MultiplayerAPI" setter="" getter="get_multiplayer"> The [MultiplayerAPI] instance associated with this node. Either the [member custom_multiplayer], or the default SceneTree one (if inside tree). </member> - <member name="name" type="String" setter="set_name" getter="get_name" default="null"> + <member name="name" type="String" setter="set_name" getter="get_name"> The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed. </member> - <member name="owner" type="Node" setter="set_owner" getter="get_owner" default="null"> + <member name="owner" type="Node" setter="set_owner" getter="get_owner"> The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using [PackedScene]), all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. </member> <member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode" default="0"> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 9b37515b52..abdbfa09f7 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -115,19 +115,19 @@ </method> </methods> <members> - <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position" default="null"> + <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> Global position. </member> - <member name="global_rotation" type="float" setter="set_global_rotation" getter="get_global_rotation" default="null"> + <member name="global_rotation" type="float" setter="set_global_rotation" getter="get_global_rotation"> Global rotation in radians. </member> - <member name="global_rotation_degrees" type="float" setter="set_global_rotation_degrees" getter="get_global_rotation_degrees" default="null"> + <member name="global_rotation_degrees" type="float" setter="set_global_rotation_degrees" getter="get_global_rotation_degrees"> Global rotation in degrees. </member> - <member name="global_scale" type="Vector2" setter="set_global_scale" getter="get_global_scale" default="null"> + <member name="global_scale" type="Vector2" setter="set_global_scale" getter="get_global_scale"> Global scale. </member> - <member name="global_transform" type="Transform2D" setter="set_global_transform" getter="get_global_transform" default="null"> + <member name="global_transform" type="Transform2D" setter="set_global_transform" getter="get_global_transform"> Global [Transform2D]. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2( 0, 0 )"> @@ -142,7 +142,7 @@ <member name="scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2( 1, 1 )"> The node's scale. Unscaled value: [code](1, 1)[/code]. </member> - <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="null"> + <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> Local [Transform2D]. </member> <member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative" default="true"> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index e46f395664..9854c2dead 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -800,74 +800,7 @@ </method> </methods> <members> - <member name="clipboard" type="String" setter="set_clipboard" getter="get_clipboard" default="" -[godotengine/godot] Large shaders difficult to edit because of live recompile interruptions (#30164) -Contrib/godot - x -loganjk <notifications@github.com> - -Fri, 28 Jun, 19:52 (16 hours ago) - - -to godotengine/godot, Subscribed - -Godot version: -3.1.1 win64 (Classical) - -OS/device including version: -Windows 10 Pro, Intel i7-4790K, integrated GPU only (Intel HD Graphics 4600), driver igdkmd64.sys version 20.19.15.5058 - -Issue description: - -With a GLES2 fragment shader of about 2,000 lines, I find the interruptions due to live recompile (and parsing?) to be annoying. I would prefer to have an option to turn off this behavior so I can recompile/parse only when desired and otherwise have the editor window behave like a simple text editor. I looked in the editor and project settings, but could not find a way to do this or at least greatly increase the delay before recompile/parsing to permit longer pauses in typing. - -The problem is not only that there the editor window freezes, but that sometimes keystrokes I made after the freeze began, before I noticed the freeze, are not remembered by the editor and are lost, leading to typos if I am not careful. - -I realize that most shaders are probably small enough that this is not a problem, but it would be a great \"quality of life\" improvement for me. An alternative is to use a separate editor and copy/paste when I want into Godot's editor window, but I'd prefer to do everything in Godot if possible. - -Thanks for considering. - -— -You are receiving this because you are subscribed to this thread. -Reply to this email directly, view it on GitHub, or mute the thread. -Zireael07 <notifications@github.com> - -Fri, 28 Jun, 20:26 (15 hours ago) - - -to godotengine/godot, Subscribed - -With a large shader, even moving around in shader editor (by arrow keys or mouse) gets laggy. -Hugo Locurcio <notifications@github.com> - -Fri, 28 Jun, 23:09 (13 hours ago) - - -to godotengine/godot, Subscribed - - I looked in the editor and project settings, but could not find a way to do this or at least greatly increase the delay before recompile/parsing to permit longer pauses in typing. - -You can increase Text Editor → Completion → Idle Parse Delay in the Editor Settings. Note that this affects both the script editor and shader editor, and will cause error reporting to take longer to appear. -loganjk <notifications@github.com> - -Fri, 28 Jun, 23:21 (12 hours ago) - - -to godotengine/godot, Subscribed - -Closed #30164. -loganjk <notifications@github.com> - -Fri, 28 Jun, 23:21 (12 hours ago) - - -to godotengine/godot, Subscribed - -I changed Idle Parse Delay before and it had no effect, but it seems that's because I did not restart the editor afterwards! Thanks very much, problem solved. - - - -""> + <member name="clipboard" type="String" setter="set_clipboard" getter="get_clipboard" default=""an editor if it were""> The clipboard from the host OS. Might be unavailable on some platforms. </member> <member name="current_screen" type="int" setter="set_current_screen" getter="get_current_screen" default="0"> diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml index 18d7d941f2..0376fea592 100644 --- a/doc/classes/PacketPeerStream.xml +++ b/doc/classes/PacketPeerStream.xml @@ -15,7 +15,7 @@ </member> <member name="output_buffer_max_size" type="int" setter="set_output_buffer_max_size" getter="get_output_buffer_max_size" default="65532"> </member> - <member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer" default="null"> + <member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer"> The wrapped [StreamPeer] object. </member> </members> diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 3176e80231..7ff99ebb73 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -36,13 +36,13 @@ <member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh" default="null"> [Mesh] that is drawn for the first draw pass. </member> - <member name="draw_pass_2" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh" default="null"> + <member name="draw_pass_2" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> [Mesh] that is drawn for the second draw pass. </member> - <member name="draw_pass_3" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh" default="null"> + <member name="draw_pass_3" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> [Mesh] that is drawn for the third draw pass. </member> - <member name="draw_pass_4" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh" default="null"> + <member name="draw_pass_4" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> [Mesh] that is drawn for the fourth draw pass. </member> <member name="draw_passes" type="int" setter="set_draw_passes" getter="get_draw_passes" default="1"> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index bd31452737..e0618a87c1 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -66,25 +66,25 @@ <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0"> Damping randomness ratio. </member> - <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents" default="null"> + <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents"> The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX]. </member> - <member name="emission_color_texture" type="Texture" setter="set_emission_color_texture" getter="get_emission_color_texture" default="null"> + <member name="emission_color_texture" type="Texture" setter="set_emission_color_texture" getter="get_emission_color_texture"> Particle color will be modulated by color determined by sampling this texture at the same point as the [member emission_point_texture]. </member> - <member name="emission_normal_texture" type="Texture" setter="set_emission_normal_texture" getter="get_emission_normal_texture" default="null"> + <member name="emission_normal_texture" type="Texture" setter="set_emission_normal_texture" getter="get_emission_normal_texture"> Particle velocity and rotation will be set by sampling this texture at the same point as the [member emission_point_texture]. Used only in [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. </member> - <member name="emission_point_count" type="int" setter="set_emission_point_count" getter="get_emission_point_count" default="null"> + <member name="emission_point_count" type="int" setter="set_emission_point_count" getter="get_emission_point_count"> The number of emission points if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. </member> - <member name="emission_point_texture" type="Texture" setter="set_emission_point_texture" getter="get_emission_point_texture" default="null"> + <member name="emission_point_texture" type="Texture" setter="set_emission_point_texture" getter="get_emission_point_texture"> Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape" default="0"> Particles will be emitted inside this region. Use [code]EMISSION_SHAPE_*[/code] constants for values. </member> - <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius" default="null"> + <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE]. </member> <member name="flag_align_y" type="bool" setter="set_flag" getter="get_flag" default="false"> @@ -126,14 +126,14 @@ <member name="linear_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0"> Linear acceleration randomness ratio. </member> - <member name="orbit_velocity" type="float" setter="set_param" getter="get_param" default="null"> + <member name="orbit_velocity" type="float" setter="set_param" getter="get_param"> Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. Only available when [member flag_disable_z] is [code]true[/code]. </member> - <member name="orbit_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture" default="null"> + <member name="orbit_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> Each particle's orbital velocity will vary along this [CurveTexture]. </member> - <member name="orbit_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="null"> + <member name="orbit_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> Orbital velocity randomness ratio. </member> <member name="radial_accel" type="float" setter="set_param" getter="get_param" default="0.0"> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index 5f79e74b0b..076131357b 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -85,7 +85,7 @@ <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> The physics layers this area scans for collisions. </member> - <member name="layers" type="int" setter="_set_layers" getter="_get_layers" default="null"> + <member name="layers" type="int" setter="_set_layers" getter="_get_layers"> Both [member collision_layer] and [member collision_mask]. Returns [member collision_layer] when accessed. Updates [member collision_layer] and [member collision_mask] when modified. </member> </members> diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 14a21e26b5..6fc0d76d02 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -110,7 +110,7 @@ <member name="texture_offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2( 0, 0 )"> Amount to offset the polygon's [code]texture[/code]. If [code](0, 0)[/code] the texture's origin (its top-left corner) will be placed at the polygon's [code]position[/code]. </member> - <member name="texture_rotation" type="float" setter="set_texture_rotation" getter="get_texture_rotation" default="null"> + <member name="texture_rotation" type="float" setter="set_texture_rotation" getter="get_texture_rotation"> The texture's rotation in radians. </member> <member name="texture_rotation_degrees" type="float" setter="set_texture_rotation_degrees" getter="get_texture_rotation_degrees" default="0.0"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 590a610b23..3e9e063c0c 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -748,6 +748,8 @@ <member name="node/name_num_separator" type="int" setter="" getter="" default="0"> What to use to separate node name from number. This is mostly an editor setting. </member> + <member name="physics/2d/default_gravity" type="int" setter="" getter="" default="98"> + </member> <member name="physics/2d/physics_engine" type="String" setter="" getter="" default=""DEFAULT""> </member> <member name="physics/2d/thread_model" type="int" setter="" getter="" default="1"> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index e3f449eed4..82fffd0cb8 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -45,7 +45,7 @@ <member name="page" type="float" setter="set_page" getter="get_page" default="0.0"> Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code]. </member> - <member name="ratio" type="float" setter="set_as_ratio" getter="get_as_ratio" default="null"> + <member name="ratio" type="float" setter="set_as_ratio" getter="get_as_ratio"> The value mapped between 0 and 1. </member> <member name="rounded" type="bool" setter="set_use_rounded_values" getter="is_using_rounded_values" default="false"> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index fe7c08aec0..dd9bcecfb3 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -125,7 +125,7 @@ <member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false"> Lock the body's movement in the Z axis. </member> - <member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="null"> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> RigidBody's bounciness. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> @@ -144,7 +144,7 @@ <member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator" default="false"> If [code]true[/code], internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. </member> - <member name="friction" type="float" setter="set_friction" getter="get_friction" default="null"> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction, from 0 (frictionless) to 1 (max friction). </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0"> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 7c0cf92d0d..43fc5704aa 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -126,7 +126,7 @@ <member name="applied_torque" type="float" setter="set_applied_torque" getter="get_applied_torque" default="0.0"> The body's total applied torque. </member> - <member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="null"> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> The body's bounciness. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> @@ -145,13 +145,13 @@ <member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator" default="false"> If [code]true[/code], internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the [method _integrate_forces] function. </member> - <member name="friction" type="float" setter="set_friction" getter="get_friction" default="null"> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0"> Multiplies the gravity applied to the body. The body's gravity is calculated from the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b] and/or any additional gravity vector applied by [Area2D]s. </member> - <member name="inertia" type="float" setter="set_inertia" getter="get_inertia" default="null"> + <member name="inertia" type="float" setter="set_inertia" getter="get_inertia"> The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 6b0218554f..1302c1e6bf 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -267,7 +267,7 @@ </method> </methods> <members> - <member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene" default="null"> + <member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene"> The current scene. </member> <member name="debug_collisions_hint" type="bool" setter="set_debug_collisions_hint" getter="is_debugging_collisions_hint" default="false"> @@ -276,17 +276,17 @@ <member name="debug_navigation_hint" type="bool" setter="set_debug_navigation_hint" getter="is_debugging_navigation_hint" default="false"> If [code]true[/code], navigation polygons will be visible when running the game from the editor for debugging purposes. </member> - <member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root" default="null"> + <member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root"> The root of the edited scene. </member> - <member name="multiplayer" type="MultiplayerAPI" setter="set_multiplayer" getter="get_multiplayer" default="null"> + <member name="multiplayer" type="MultiplayerAPI" setter="set_multiplayer" getter="get_multiplayer"> The default [MultiplayerAPI] instance for this [SceneTree]. </member> <member name="multiplayer_poll" type="bool" setter="set_multiplayer_poll_enabled" getter="is_multiplayer_poll_enabled" default="true"> If [code]true[/code] (default value), enables automatic polling of the [MultiplayerAPI] for this SceneTree during [signal idle_frame]. If [code]false[/code], you need to manually call [method MultiplayerAPI.poll] to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads. </member> - <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer" default="null"> + <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the [SceneTree] will become a network server (check with [method is_network_server]) and will set the root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with the root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to [SceneTree]'s signals. </member> <member name="paused" type="bool" setter="set_pause" getter="is_paused" default="false"> @@ -297,7 +297,7 @@ <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections" default="false"> If [code]true[/code], the [SceneTree]'s [member network_peer] refuses new incoming connections. </member> - <member name="root" type="Viewport" setter="" getter="get_root" default="null"> + <member name="root" type="Viewport" setter="" getter="get_root"> The [SceneTree]'s root [Viewport]. </member> <member name="use_font_oversampling" type="bool" setter="set_use_font_oversampling" getter="is_using_font_oversampling" default="false"> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index ece6e3c5df..fca73e3ea7 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -75,7 +75,7 @@ </method> </methods> <members> - <member name="source_code" type="String" setter="set_source_code" getter="get_source_code" default="null"> + <member name="source_code" type="String" setter="set_source_code" getter="get_source_code"> The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically. </member> </members> diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 7b9add24e9..9f4118aa7b 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -293,13 +293,13 @@ </method> </methods> <members> - <member name="gizmo" type="SpatialGizmo" setter="set_gizmo" getter="get_gizmo" default="null"> + <member name="gizmo" type="SpatialGizmo" setter="set_gizmo" getter="get_gizmo"> The [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. </member> - <member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform" default="null"> + <member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform"> World space (global) [Transform] of this node. </member> - <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation" default="null"> + <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation"> Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). [b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. </member> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 26c23a3ef5..5e18e72f90 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -17,83 +17,83 @@ </member> <member name="albedo_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> </member> - <member name="anisotropy" type="float" setter="set_anisotropy" getter="get_anisotropy" default="null"> + <member name="anisotropy" type="float" setter="set_anisotropy" getter="get_anisotropy"> The strength of the anisotropy effect. </member> <member name="anisotropy_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. </member> - <member name="anisotropy_flowmap" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="anisotropy_flowmap" type="Texture" setter="set_texture" getter="get_texture"> </member> <member name="ao_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], ambient occlusion is enabled. </member> - <member name="ao_light_affect" type="float" setter="set_ao_light_affect" getter="get_ao_light_affect" default="null"> + <member name="ao_light_affect" type="float" setter="set_ao_light_affect" getter="get_ao_light_affect"> </member> - <member name="ao_on_uv2" type="bool" setter="set_flag" getter="get_flag" default="null"> + <member name="ao_on_uv2" type="bool" setter="set_flag" getter="get_flag"> </member> - <member name="ao_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="ao_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="ao_texture_channel" type="int" setter="set_ao_texture_channel" getter="get_ao_texture_channel" enum="SpatialMaterial.TextureChannel" default="null"> + <member name="ao_texture_channel" type="int" setter="set_ao_texture_channel" getter="get_ao_texture_channel" enum="SpatialMaterial.TextureChannel"> </member> - <member name="clearcoat" type="float" setter="set_clearcoat" getter="get_clearcoat" default="null"> + <member name="clearcoat" type="float" setter="set_clearcoat" getter="get_clearcoat"> </member> <member name="clearcoat_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the material. </member> - <member name="clearcoat_gloss" type="float" setter="set_clearcoat_gloss" getter="get_clearcoat_gloss" default="null"> + <member name="clearcoat_gloss" type="float" setter="set_clearcoat_gloss" getter="get_clearcoat_gloss"> </member> - <member name="clearcoat_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="clearcoat_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="depth_deep_parallax" type="bool" setter="set_depth_deep_parallax" getter="is_depth_deep_parallax_enabled" default="null"> + <member name="depth_deep_parallax" type="bool" setter="set_depth_deep_parallax" getter="is_depth_deep_parallax_enabled"> </member> <member name="depth_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also [member normal_enabled]. </member> - <member name="depth_flip_binormal" type="bool" setter="set_depth_deep_parallax_flip_binormal" getter="get_depth_deep_parallax_flip_binormal" default="null"> + <member name="depth_flip_binormal" type="bool" setter="set_depth_deep_parallax_flip_binormal" getter="get_depth_deep_parallax_flip_binormal"> </member> - <member name="depth_flip_tangent" type="bool" setter="set_depth_deep_parallax_flip_tangent" getter="get_depth_deep_parallax_flip_tangent" default="null"> + <member name="depth_flip_tangent" type="bool" setter="set_depth_deep_parallax_flip_tangent" getter="get_depth_deep_parallax_flip_tangent"> </member> - <member name="depth_max_layers" type="int" setter="set_depth_deep_parallax_max_layers" getter="get_depth_deep_parallax_max_layers" default="null"> + <member name="depth_max_layers" type="int" setter="set_depth_deep_parallax_max_layers" getter="get_depth_deep_parallax_max_layers"> </member> - <member name="depth_min_layers" type="int" setter="set_depth_deep_parallax_min_layers" getter="get_depth_deep_parallax_min_layers" default="null"> + <member name="depth_min_layers" type="int" setter="set_depth_deep_parallax_min_layers" getter="get_depth_deep_parallax_min_layers"> </member> - <member name="depth_scale" type="float" setter="set_depth_scale" getter="get_depth_scale" default="null"> + <member name="depth_scale" type="float" setter="set_depth_scale" getter="get_depth_scale"> </member> - <member name="depth_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="depth_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="detail_albedo" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="detail_albedo" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="detail_blend_mode" type="int" setter="set_detail_blend_mode" getter="get_detail_blend_mode" enum="SpatialMaterial.BlendMode" default="null"> + <member name="detail_blend_mode" type="int" setter="set_detail_blend_mode" getter="get_detail_blend_mode" enum="SpatialMaterial.BlendMode"> </member> <member name="detail_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> </member> - <member name="detail_mask" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="detail_mask" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="detail_normal" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="detail_normal" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="SpatialMaterial.DetailUV" default="null"> + <member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="SpatialMaterial.DetailUV"> </member> - <member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance" default="null"> + <member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance"> </member> - <member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance" default="null"> + <member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance"> </member> <member name="distance_fade_mode" type="int" setter="set_distance_fade" getter="get_distance_fade" enum="SpatialMaterial.DistanceFadeMode" default="0"> </member> - <member name="emission" type="Color" setter="set_emission" getter="get_emission" default="null"> + <member name="emission" type="Color" setter="set_emission" getter="get_emission"> The emitted light's color. See [member emission_enabled]. </member> <member name="emission_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], the body emits light. </member> - <member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy" default="null"> + <member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy"> The emitted light's strength. See [member emission_enabled]. </member> - <member name="emission_on_uv2" type="bool" setter="set_flag" getter="get_flag" default="null"> + <member name="emission_on_uv2" type="bool" setter="set_flag" getter="get_flag"> </member> - <member name="emission_operator" type="int" setter="set_emission_operator" getter="get_emission_operator" enum="SpatialMaterial.EmissionOperator" default="null"> + <member name="emission_operator" type="int" setter="set_emission_operator" getter="get_emission_operator" enum="SpatialMaterial.EmissionOperator"> </member> - <member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> <member name="flags_albedo_tex_force_srgb" type="bool" setter="set_flag" getter="get_flag" default="false"> </member> @@ -143,12 +143,12 @@ <member name="normal_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], normal mapping is enabled. </member> - <member name="normal_scale" type="float" setter="set_normal_scale" getter="get_normal_scale" default="null"> + <member name="normal_scale" type="float" setter="set_normal_scale" getter="get_normal_scale"> The strength of the normal map's effect. </member> - <member name="normal_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="normal_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="params_alpha_scissor_threshold" type="float" setter="set_alpha_scissor_threshold" getter="get_alpha_scissor_threshold" default="null"> + <member name="params_alpha_scissor_threshold" type="float" setter="set_alpha_scissor_threshold" getter="get_alpha_scissor_threshold"> </member> <member name="params_billboard_keep_scale" type="bool" setter="set_flag" getter="get_flag" default="false"> </member> @@ -171,7 +171,7 @@ <member name="params_grow" type="bool" setter="set_grow_enabled" getter="is_grow_enabled" default="false"> If [code]true[/code], enables the vertex grow setting. See [member params_grow_amount]. </member> - <member name="params_grow_amount" type="float" setter="set_grow" getter="get_grow" default="null"> + <member name="params_grow_amount" type="float" setter="set_grow" getter="get_grow"> Grows object vertices in the direction of their normals. </member> <member name="params_line_width" type="float" setter="set_line_width" getter="get_line_width" default="1.0"> @@ -184,16 +184,16 @@ </member> <member name="params_use_alpha_scissor" type="bool" setter="set_flag" getter="get_flag" default="false"> </member> - <member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames" default="null"> + <member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames"> The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. </member> - <member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop" default="null"> + <member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop"> If [code]true[/code], particle animations are looped. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. </member> - <member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames" default="null"> + <member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames"> The number of vertical frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. </member> - <member name="proximity_fade_distance" type="float" setter="set_proximity_fade_distance" getter="get_proximity_fade_distance" default="null"> + <member name="proximity_fade_distance" type="float" setter="set_proximity_fade_distance" getter="get_proximity_fade_distance"> </member> <member name="proximity_fade_enable" type="bool" setter="set_proximity_fade" getter="is_proximity_fade_enabled" default="false"> If [code]true[/code], the proximity and distance fade effect is enabled. @@ -201,21 +201,21 @@ <member name="refraction_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], the refraction effect is enabled. Distorts transparency based on light from behind the object. </member> - <member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction" default="null"> + <member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction"> The strength of the refraction effect. </member> - <member name="refraction_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="refraction_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="refraction_texture_channel" type="int" setter="set_refraction_texture_channel" getter="get_refraction_texture_channel" enum="SpatialMaterial.TextureChannel" default="null"> + <member name="refraction_texture_channel" type="int" setter="set_refraction_texture_channel" getter="get_refraction_texture_channel" enum="SpatialMaterial.TextureChannel"> </member> - <member name="rim" type="float" setter="set_rim" getter="get_rim" default="null"> + <member name="rim" type="float" setter="set_rim" getter="get_rim"> </member> <member name="rim_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], rim effect is enabled. </member> - <member name="rim_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="rim_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="rim_tint" type="float" setter="set_rim_tint" getter="get_rim_tint" default="null"> + <member name="rim_tint" type="float" setter="set_rim_tint" getter="get_rim_tint"> The amount of to blend light and albedo color when rendering rim effect. If [code]0[/code] the light color is used, while [code]1[/code] means albedo color is used. An intermediate value generally works best. </member> <member name="roughness" type="float" setter="set_roughness" getter="get_roughness" default="1.0"> @@ -228,18 +228,18 @@ <member name="subsurf_scatter_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. </member> - <member name="subsurf_scatter_strength" type="float" setter="set_subsurface_scattering_strength" getter="get_subsurface_scattering_strength" default="null"> + <member name="subsurf_scatter_strength" type="float" setter="set_subsurface_scattering_strength" getter="get_subsurface_scattering_strength"> The strength of the subsurface scattering effect. </member> - <member name="subsurf_scatter_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="subsurf_scatter_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> - <member name="transmission" type="Color" setter="set_transmission" getter="get_transmission" default="null"> + <member name="transmission" type="Color" setter="set_transmission" getter="get_transmission"> The color used by the transmission effect. Represents the light passing through an object. </member> <member name="transmission_enabled" type="bool" setter="set_feature" getter="get_feature" default="false"> If [code]true[/code], the transmission effect is enabled. </member> - <member name="transmission_texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> + <member name="transmission_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> <member name="uv1_offset" type="Vector3" setter="set_uv1_offset" getter="get_uv1_offset" default="Vector3( 0, 0, 0 )"> </member> diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index ef4a34b924..f28192519e 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -169,7 +169,7 @@ </method> </methods> <members> - <member name="frames" type="Array" setter="_set_frames" getter="_get_frames" default="null"> + <member name="frames" type="Array" setter="_set_frames" getter="_get_frames"> </member> </members> <constants> diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index e471107965..b3243a4fca 100644 --- a/doc/classes/StaticBody.xml +++ b/doc/classes/StaticBody.xml @@ -13,7 +13,7 @@ <methods> </methods> <members> - <member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="null"> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> The body's bounciness. </member> <member name="constant_angular_velocity" type="Vector3" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="Vector3( 0, 0, 0 )"> @@ -22,7 +22,7 @@ <member name="constant_linear_velocity" type="Vector3" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" default="Vector3( 0, 0, 0 )"> The body's constant linear velocity. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. </member> - <member name="friction" type="float" setter="set_friction" getter="get_friction" default="null"> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction, from 0 (frictionless) to 1 (full friction). </member> <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override" default="null"> diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index b092c3a684..c039b7888c 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -12,7 +12,7 @@ <methods> </methods> <members> - <member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="null"> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). </member> <member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="0.0"> @@ -21,7 +21,7 @@ <member name="constant_linear_velocity" type="Vector2" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" default="Vector2( 0, 0 )"> The body's constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving. </member> - <member name="friction" type="float" setter="set_friction" getter="get_friction" default="null"> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction. Values range from [code]0[/code] (no friction) to [code]1[/code] (full friction). </member> <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override" default="null"> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index c0c55ee6be..ee5205efd7 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -286,9 +286,11 @@ <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> The collision mask(s) for all colliders in the TileMap. </member> - <member name="collision_use_kinematic" type="bool" setter="set_collision_use_kinematic" getter="get_collision_use_kinematic" default="false"> + <member name="collision_use_kinematic" type="bool" setter="set_collision_use_kinematic" getter="get_collision_use_kinematic" default="true"> If [code]true[/code], TileMap collisions will be handled as a kinematic body. If [code]false[/code], collisions will be handled as static body. </member> + <member name="collision_use_parent" type="bool" setter="set_collision_use_parent" getter="get_collision_use_parent" default="false"> + </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="TileMap.Mode" default="0"> The TileMap orientation mode. See [enum Mode] for possible values. </member> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 311a2caf89..4f455fb377 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -41,13 +41,13 @@ <member name="one_shot" type="bool" setter="set_one_shot" getter="is_one_shot" default="false"> If [code]true[/code], the timer will stop when reaching 0. If [code]false[/code], it will restart. </member> - <member name="paused" type="bool" setter="set_paused" getter="is_paused" default="null"> + <member name="paused" type="bool" setter="set_paused" getter="is_paused"> If [code]true[/code], the timer is paused and will not process until it is unpaused again, even if [method start] is called. </member> <member name="process_mode" type="int" setter="set_timer_process_mode" getter="get_timer_process_mode" enum="Timer.TimerProcessMode" default="1"> Processing mode. See [enum TimerProcessMode]. </member> - <member name="time_left" type="float" setter="" getter="get_time_left" default="null"> + <member name="time_left" type="float" setter="" getter="get_time_left"> The timer's remaining time in seconds. Returns 0 if the timer is inactive. [b]Note:[/b] You cannot set this value. To change the timer's remaining time, use [member wait_time]. </member> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 11ba843bb3..45341cee74 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -66,10 +66,10 @@ </member> <member name="stream" type="VideoStream" setter="set_stream" getter="get_stream" default="null"> </member> - <member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position" default="null"> + <member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position"> The current position of the stream, in seconds. </member> - <member name="volume" type="float" setter="set_volume" getter="get_volume" default="null"> + <member name="volume" type="float" setter="set_volume" getter="get_volume"> Audio volume as a linear value. </member> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0"> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index fbda2819b3..a9ffd9f66d 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -219,7 +219,7 @@ <member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener" default="false"> If [code]true[/code], the viewport will process 3D audio streams. </member> - <member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform" default="null"> + <member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform"> The canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. </member> <member name="debug_draw" type="int" setter="set_debug_draw" getter="get_debug_draw" enum="Viewport.DebugDraw" default="0"> @@ -228,7 +228,7 @@ <member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled" default="false"> If [code]true[/code], the viewport will disable 3D rendering. For actual disabling use [code]usage[/code]. </member> - <member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform" default="null"> + <member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform"> The global canvas transform of the viewport. The canvas transform is relative to this. </member> <member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled" default="false"> @@ -293,7 +293,7 @@ <member name="world" type="World" setter="set_world" getter="get_world" default="null"> The custom [World] which can be used as 3D environment source. </member> - <member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d" default="null"> + <member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d"> The custom [World2D] which can be used as 2D environment source. </member> </members> diff --git a/doc/classes/World.xml b/doc/classes/World.xml index a660001565..adb3286c51 100644 --- a/doc/classes/World.xml +++ b/doc/classes/World.xml @@ -12,7 +12,7 @@ <methods> </methods> <members> - <member name="direct_space_state" type="PhysicsDirectSpaceState" setter="" getter="get_direct_space_state" default="null"> + <member name="direct_space_state" type="PhysicsDirectSpaceState" setter="" getter="get_direct_space_state"> The World's physics direct space state, used for making various queries. Might be used only during [code]_physics_process[/code]. </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment" default="null"> @@ -21,10 +21,10 @@ <member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment" default="null"> The World's fallback_environment will be used if the World's [Environment] fails or is missing. </member> - <member name="scenario" type="RID" setter="" getter="get_scenario" default="null"> + <member name="scenario" type="RID" setter="" getter="get_scenario"> The World's visual scenario. </member> - <member name="space" type="RID" setter="" getter="get_space" default="null"> + <member name="space" type="RID" setter="" getter="get_space"> The World's physics space. </member> </members> diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index 69557f0221..66ef18f8f4 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -12,13 +12,13 @@ <methods> </methods> <members> - <member name="canvas" type="RID" setter="" getter="get_canvas" default="null"> + <member name="canvas" type="RID" setter="" getter="get_canvas"> The [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing. </member> - <member name="direct_space_state" type="Physics2DDirectSpaceState" setter="" getter="get_direct_space_state" default="null"> + <member name="direct_space_state" type="Physics2DDirectSpaceState" setter="" getter="get_direct_space_state"> The state of this world's physics space. This allows arbitrary querying for collision. </member> - <member name="space" type="RID" setter="" getter="get_space" default="null"> + <member name="space" type="RID" setter="" getter="get_space"> The [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area. </member> </members> |