godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2018-11-20 09:34:45 +01:00
parent 57b634ad3d
commit daa9092ed3
11 changed files with 126 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/AudioEffectReverb.xml
View File

@ -15,7 +15,7 @@
</methods>
<members>
<member name="damping" type="float" setter="set_damping" getter="get_damping">
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].
</member>
<member name="dry" type="float" setter="set_dry" getter="get_dry">
Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: [code]1[/code].

22
doc/classes/Dictionary.xml
View File

@ -41,6 +41,17 @@
Erase a dictionary key/value pair by key.
</description>
</method>
<method name="get">
<return type="Variant">
</return>
<argument index="0" name="key" type="Variant">
</argument>
<argument index="1" name="default" type="Variant" default="Null">
</argument>
<description>
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.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -87,17 +98,6 @@
Return the list of values in the [code]Dictionary[/code].
</description>
</method>
<method name="get">
<return type="Variant">
</return>
<argument index="0" name="key" type="Variant">
</argument>
<argument index="1" name="default" type="Variant" default="null">
</argument>
<description>
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.
</description>
</method>
</methods>
<constants>
</constants>

2
doc/classes/Environment.xml
View File

@ -120,6 +120,8 @@
<member name="fog_depth_enabled" type="bool" setter="set_fog_depth_enabled" getter="is_fog_depth_enabled">
Enables the fog depth.
</member>
<member name="fog_depth_end" type="float" setter="set_fog_depth_end" getter="get_fog_depth_end">
</member>
<member name="fog_enabled" type="bool" setter="set_fog_enabled" getter="is_fog_enabled">
Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
</member>

2
doc/classes/File.xml
View File

@ -330,7 +330,7 @@
<method name="store_csv_line">
<return type="void">
</return>
<argument index="0" name="values" type="PoolStringArray" default="&quot;,&quot;">
<argument index="0" name="values" type="PoolStringArray">
</argument>
<argument index="1" name="delim" type="String" default="&quot;,&quot;">
</argument>

78
doc/classes/Generic6DOFJoint.xml
View File

@ -113,6 +113,30 @@
<member name="angular_motor_z/target_velocity" type="float" setter="set_param_z" getter="get_param_z">
Target speed for the motor at the z-axis.
</member>
<member name="angular_spring_x/damping" type="float" setter="set_param_x" getter="get_param_x">
</member>
<member name="angular_spring_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x">
</member>
<member name="angular_spring_x/equilibrium_point" type="float" setter="set_param_x" getter="get_param_x">
</member>
<member name="angular_spring_x/stiffness" type="float" setter="set_param_x" getter="get_param_x">
</member>
<member name="angular_spring_y/damping" type="float" setter="set_param_y" getter="get_param_y">
</member>
<member name="angular_spring_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y">
</member>
<member name="angular_spring_y/equilibrium_point" type="float" setter="set_param_y" getter="get_param_y">
</member>
<member name="angular_spring_y/stiffness" type="float" setter="set_param_y" getter="get_param_y">
</member>
<member name="angular_spring_z/damping" type="float" setter="set_param_z" getter="get_param_z">
</member>
<member name="angular_spring_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z">
</member>
<member name="angular_spring_z/equilibrium_point" type="float" setter="set_param_z" getter="get_param_z">
</member>
<member name="angular_spring_z/stiffness" type="float" setter="set_param_z" getter="get_param_z">
</member>
<member name="linear_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x">
The amount of damping that happens at the x-motion.
</member>
@ -194,6 +218,30 @@
<member name="linear_motor_z/target_velocity" type="float" setter="set_param_z" getter="get_param_z">
The speed that the linear motor will attempt to reach on the z-axis.
</member>
<member name="linear_spring_x/damping" type="float" setter="set_param_x" getter="get_param_x">
</member>
<member name="linear_spring_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x">
</member>
<member name="linear_spring_x/equilibrium_point" type="float" setter="set_param_x" getter="get_param_x">
</member>
<member name="linear_spring_x/stiffness" type="float" setter="set_param_x" getter="get_param_x">
</member>
<member name="linear_spring_y/damping" type="float" setter="set_param_y" getter="get_param_y">
</member>
<member name="linear_spring_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y">
</member>
<member name="linear_spring_y/equilibrium_point" type="float" setter="set_param_y" getter="get_param_y">
</member>
<member name="linear_spring_y/stiffness" type="float" setter="set_param_y" getter="get_param_y">
</member>
<member name="linear_spring_z/damping" type="float" setter="set_param_z" getter="get_param_z">
</member>
<member name="linear_spring_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z">
</member>
<member name="linear_spring_z/equilibrium_point" type="float" setter="set_param_z" getter="get_param_z">
</member>
<member name="linear_spring_z/stiffness" type="float" setter="set_param_z" getter="get_param_z">
</member>
</members>
<constants>
<constant name="PARAM_LINEAR_LOWER_LIMIT" value="0" enum="Param">
@ -217,34 +265,34 @@
<constant name="PARAM_LINEAR_MOTOR_FORCE_LIMIT" value="6" enum="Param">
The maximum force the linear motor will apply while trying to reach the velocity target.
</constant>
<constant name="PARAM_ANGULAR_LOWER_LIMIT" value="7" enum="Param">
<constant name="PARAM_ANGULAR_LOWER_LIMIT" value="10" enum="Param">
The minimum rotation in negative direction to break loose and rotate around the axes.
</constant>
<constant name="PARAM_ANGULAR_UPPER_LIMIT" value="8" enum="Param">
<constant name="PARAM_ANGULAR_UPPER_LIMIT" value="11" enum="Param">
The minimum rotation in positive direction to break loose and rotate around the axes.
</constant>
<constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="9" enum="Param">
<constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="12" enum="Param">
The speed of all rotations across the axes.
</constant>
<constant name="PARAM_ANGULAR_DAMPING" value="10" enum="Param">
<constant name="PARAM_ANGULAR_DAMPING" value="13" enum="Param">
The amount of rotational damping across the axes. The lower, the more dampening occurs.
</constant>
<constant name="PARAM_ANGULAR_RESTITUTION" value="11" enum="Param">
<constant name="PARAM_ANGULAR_RESTITUTION" value="14" enum="Param">
The amount of rotational restitution across the axes. The lower, the more restitution occurs.
</constant>
<constant name="PARAM_ANGULAR_FORCE_LIMIT" value="12" enum="Param">
<constant name="PARAM_ANGULAR_FORCE_LIMIT" value="15" enum="Param">
The maximum amount of force that can occur, when rotating around the axes.
</constant>
<constant name="PARAM_ANGULAR_ERP" value="13" enum="Param">
<constant name="PARAM_ANGULAR_ERP" value="16" enum="Param">
When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
</constant>
<constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="14" enum="Param">
<constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="17" enum="Param">
Target speed for the motor at the axes.
</constant>
<constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="15" enum="Param">
<constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="18" enum="Param">
Maximum acceleration for the motor at the axes.
</constant>
<constant name="PARAM_MAX" value="16" enum="Param">
<constant name="PARAM_MAX" value="22" enum="Param">
End flag of PARAM_* constants, used internally.
</constant>
<constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="Flag">
@ -253,12 +301,16 @@
<constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="Flag">
If [code]set[/code] there is rotational motion possible.
</constant>
<constant name="FLAG_ENABLE_MOTOR" value="2" enum="Flag">
<constant name="FLAG_ENABLE_LINEAR_SPRING" value="3" enum="Flag">
</constant>
<constant name="FLAG_ENABLE_ANGULAR_SPRING" value="2" enum="Flag">
</constant>
<constant name="FLAG_ENABLE_MOTOR" value="4" enum="Flag">
If [code]set[/code] there is a rotational motor across these axes.
</constant>
<constant name="FLAG_ENABLE_LINEAR_MOTOR" value="3" enum="Flag">
<constant name="FLAG_ENABLE_LINEAR_MOTOR" value="5" enum="Flag">
</constant>
<constant name="FLAG_MAX" value="4" enum="Flag">
<constant name="FLAG_MAX" value="6" enum="Flag">
End flag of FLAG_* constants, used internally.
</constant>
</constants>

10
doc/classes/Object.xml
View File

@ -348,6 +348,16 @@
If set to true, signal emission is blocked.
</description>
</method>
<method name="set_deferred">
<return type="void">
</return>
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description>
</description>
</method>
<method name="set_indexed">
<return type="void">
</return>

22
doc/classes/PhysicsServer.xml
View File

@ -1401,31 +1401,31 @@
<constant name="G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT" value="6" enum="G6DOFJointAxisParam">
The maximum force that the linear motor can apply while trying to reach the target velocity.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="7" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="10" enum="G6DOFJointAxisParam">
The minimum rotation in negative direction to break loose and rotate around the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="8" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="11" enum="G6DOFJointAxisParam">
The minimum rotation in positive direction to break loose and rotate around the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="9" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="12" enum="G6DOFJointAxisParam">
A factor that gets multiplied onto all rotations across the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="10" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="13" enum="G6DOFJointAxisParam">
The amount of rotational damping across the axes. The lower, the more dampening occurs.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="11" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="14" enum="G6DOFJointAxisParam">
The amount of rotational restitution across the axes. The lower, the more restitution occurs.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="12" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="15" enum="G6DOFJointAxisParam">
The maximum amount of force that can occur, when rotating around the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_ERP" value="13" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_ERP" value="16" enum="G6DOFJointAxisParam">
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.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="14" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="17" enum="G6DOFJointAxisParam">
Target speed for the motor at the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="15" enum="G6DOFJointAxisParam">
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="18" enum="G6DOFJointAxisParam">
Maximum acceleration for the motor at the axes.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="G6DOFJointAxisFlag">
@ -1434,10 +1434,10 @@
<constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="G6DOFJointAxisFlag">
If [code]set[/code] there is rotational motion possible.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2" enum="G6DOFJointAxisFlag">
<constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="4" enum="G6DOFJointAxisFlag">
If [code]set[/code] there is a rotational motor across these axes.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR" value="3" enum="G6DOFJointAxisFlag">
<constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR" value="5" enum="G6DOFJointAxisFlag">
If [code]set[/code] there is a linear motor on this axis that targets a specific velocity.
</constant>
<constant name="SHAPE_PLANE" value="0" enum="ShapeType">

4
doc/classes/SpatialMaterial.xml
View File

@ -52,6 +52,10 @@
<member name="depth_enabled" type="bool" setter="set_feature" getter="get_feature">
If [code]true[/code] Depth mapping is enabled. 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">
</member>
<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">
</member>
<member name="depth_min_layers" type="int" setter="set_depth_deep_parallax_min_layers" getter="get_depth_deep_parallax_min_layers">

2
doc/classes/Tree.xml
View File

@ -384,6 +384,8 @@
</theme_item>
<theme_item name="custom_button_pressed" type="StyleBox">
</theme_item>
<theme_item name="draw_guides" type="int">
</theme_item>
<theme_item name="draw_relationship_lines" type="int">
</theme_item>
<theme_item name="drop_position_color" type="Color">

14
doc/classes/Viewport.xml
View File

@ -125,6 +125,12 @@
<description>
</description>
</method>
<method name="is_input_handled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_size_override_enabled" qualifiers="const">
<return type="bool">
</return>
@ -147,6 +153,12 @@
<description>
</description>
</method>
<method name="set_input_as_handled">
<return type="void">
</return>
<description>
</description>
</method>
<method name="set_size_override">
<return type="void">
</return>
@ -222,6 +234,8 @@
<member name="gui_snap_controls_to_pixels" type="bool" setter="set_snap_controls_to_pixels" getter="is_snap_controls_to_pixels_enabled">
If [code]true[/code] the GUI controls on the viewport will lay pixel perfectly. Default value: [code]true[/code].
</member>
<member name="handle_input_locally" type="bool" setter="set_handle_input_locally" getter="is_handling_input_locally">
</member>
<member name="hdr" type="bool" setter="set_hdr" getter="get_hdr">
If [code]true[/code] the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: [code]true[/code].
</member>

8
doc/classes/VisualServer.xml
View File

@ -1113,11 +1113,13 @@
</argument>
<argument index="2" name="depth_begin" type="float">
</argument>
<argument index="3" name="depth_curve" type="float">
<argument index="3" name="depth_end" type="float">
</argument>
<argument index="4" name="transmit" type="bool">
<argument index="4" name="depth_curve" type="float">
</argument>
<argument index="5" name="transmit_curve" type="float">
<argument index="5" name="transmit" type="bool">
</argument>
<argument index="6" name="transmit_curve" type="float">
</argument>
<description>
</description>