From daa9092ed3e08d05fbc57c32d7824605aead0f13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 20 Nov 2018 09:34:45 +0100 Subject: doc: Sync classref with current source --- doc/classes/AudioEffectReverb.xml | 2 +- doc/classes/Dictionary.xml | 22 +++++------ doc/classes/Environment.xml | 2 + doc/classes/File.xml | 2 +- doc/classes/Generic6DOFJoint.xml | 78 ++++++++++++++++++++++++++++++++------- doc/classes/Object.xml | 10 +++++ doc/classes/PhysicsServer.xml | 22 +++++------ doc/classes/SpatialMaterial.xml | 4 ++ doc/classes/Tree.xml | 2 + doc/classes/Viewport.xml | 14 +++++++ doc/classes/VisualServer.xml | 8 ++-- 11 files changed, 126 insertions(+), 40 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index 87c622e3bb..008c644466 100644 --- a/doc/classes/AudioEffectReverb.xml +++ b/doc/classes/AudioEffectReverb.xml @@ -15,7 +15,7 @@ - Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code]. + Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code]. Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: [code]1[/code]. diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index cc58c56404..a9e2a38dcf 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -41,6 +41,17 @@ Erase a dictionary key/value pair by key. + + + + + + + + + Returns the current value for the specified key in the [code]Dictionary[/code]. If the key does not exist, the method returns the value of the optional default argument, or Null if it is omitted. + + @@ -87,17 +98,6 @@ Return the list of values in the [code]Dictionary[/code]. - - - - - - - - - Returns the current value for the specified key in the [code]Dictionary[/code]. If the key does not exist, the method returns the value of the optional default argument, or Null if it is omitted. - - diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 4c2c83e55f..4f0ade328f 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -120,6 +120,8 @@ Enables the fog depth. + + Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 1745389833..058bb09090 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -330,7 +330,7 @@ - + diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 0863ead4ec..e1046e282a 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -113,6 +113,30 @@ Target speed for the motor at the z-axis. + + + + + + + + + + + + + + + + + + + + + + + + The amount of damping that happens at the x-motion. @@ -194,6 +218,30 @@ The speed that the linear motor will attempt to reach on the z-axis. + + + + + + + + + + + + + + + + + + + + + + + + @@ -217,34 +265,34 @@ The maximum force the linear motor will apply while trying to reach the velocity target. - + The minimum rotation in negative direction to break loose and rotate around the axes. - + The minimum rotation in positive direction to break loose and rotate around the axes. - + The speed of all rotations across the axes. - + The amount of rotational damping across the axes. The lower, the more dampening occurs. - + The amount of rotational restitution across the axes. The lower, the more restitution occurs. - + The maximum amount of force that can occur, when rotating around the axes. - + When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - + Target speed for the motor at the axes. - + Maximum acceleration for the motor at the axes. - + End flag of PARAM_* constants, used internally. @@ -253,12 +301,16 @@ If [code]set[/code] there is rotational motion possible. - + + + + + If [code]set[/code] there is a rotational motor across these axes. - + - + End flag of FLAG_* constants, used internally. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index fcd105d66b..86de830d56 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -348,6 +348,16 @@ If set to true, signal emission is blocked. + + + + + + + + + + diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index c836414dd2..7dfc8e66d4 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1401,31 +1401,31 @@ The maximum force that the linear motor can apply while trying to reach the target velocity. - + The minimum rotation in negative direction to break loose and rotate around the axes. - + The minimum rotation in positive direction to break loose and rotate around the axes. - + A factor that gets multiplied onto all rotations across the axes. - + The amount of rotational damping across the axes. The lower, the more dampening occurs. - + The amount of rotational restitution across the axes. The lower, the more restitution occurs. - + The maximum amount of force that can occur, when rotating around the axes. - + When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - + Target speed for the motor at the axes. - + Maximum acceleration for the motor at the axes. @@ -1434,10 +1434,10 @@ If [code]set[/code] there is rotational motion possible. - + If [code]set[/code] there is a rotational motor across these axes. - + If [code]set[/code] there is a linear motor on this axis that targets a specific velocity. diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 392a550ee4..3503505999 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -52,6 +52,10 @@ If [code]true[/code] Depth mapping is enabled. See also [member normal_enabled]. + + + + diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 8051062fc4..14be256d85 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -384,6 +384,8 @@ + + diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 2cdd8c407f..4706651c6e 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -125,6 +125,12 @@ + + + + + + @@ -147,6 +153,12 @@ + + + + + + @@ -222,6 +234,8 @@ If [code]true[/code] the GUI controls on the viewport will lay pixel perfectly. Default value: [code]true[/code]. + + If [code]true[/code] the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: [code]true[/code]. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 46a06d63d4..b24eeaa112 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1113,11 +1113,13 @@ - + - + - + + + -- cgit v1.2.3