Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-22 12:12:28 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DocData: Re-expose parametric setters and getters

Browse Source 
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.

For example, CPUParticles' `set_param(Parameter param, float value)`.
This commit is contained in:
Rémi Verschelde 2019-06-27 16:10:09 +02:00
parent 7b569e91c0
commit 542489a866
31 changed files with 1050 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/classes/AnimationNodeTransition.xml
View File

@ -7,6 +7,42 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_input_caption" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="input" type="int">
</argument>
<description>
</description>
</method>
<method name="is_input_set_as_auto_advance" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="input" type="int">
</argument>
<description>
</description>
</method>
<method name="set_input_as_auto_advance">
<return type="void">
</return>
<argument index="0" name="input" type="int">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_input_caption">
<return type="void">
</return>
<argument index="0" name="input" type="int">
</argument>
<argument index="1" name="caption" type="String">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="input_0/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> <member name="input_0/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance">

108
doc/classes/AudioEffectChorus.xml
View File

@ -9,6 +9,114 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_voice_cutoff_hz" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_voice_delay_ms" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_voice_depth_ms" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_voice_level_db" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_voice_pan" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_voice_rate_hz" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="set_voice_cutoff_hz">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="cutoff_hz" type="float">
</argument>
<description>
</description>
</method>
<method name="set_voice_delay_ms">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="delay_ms" type="float">
</argument>
<description>
</description>
</method>
<method name="set_voice_depth_ms">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="depth_ms" type="float">
</argument>
<description>
</description>
</method>
<method name="set_voice_level_db">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="level_db" type="float">
</argument>
<description>
</description>
</method>
<method name="set_voice_pan">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="pan" type="float">
</argument>
<description>
</description>
</method>
<method name="set_voice_rate_hz">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="rate_hz" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0"> <member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">

72
doc/classes/CPUParticles.xml
View File

@ -19,6 +19,38 @@
Sets this node's properties to match a given [Particles] node with an assigned [ParticlesMaterial]. Sets this node's properties to match a given [Particles] node with an assigned [ParticlesMaterial].
</description> </description>
</method> </method>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_param_curve" qualifiers="const">
<return type="Curve">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_param_randomness" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_particle_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="CPUParticles.Flags">
</argument>
<description>
</description>
</method>
<method name="restart"> <method name="restart">
<return type="void"> <return type="void">
</return> </return>
@ -26,6 +58,46 @@
Restarts the particle emitter. Restarts the particle emitter.
</description> </description>
</method> </method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_curve">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter">
</argument>
<argument index="1" name="curve" type="Curve">
</argument>
<description>
</description>
</method>
<method name="set_param_randomness">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter">
</argument>
<argument index="1" name="randomness" type="float">
</argument>
<description>
</description>
</method>
<method name="set_particle_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="CPUParticles.Flags">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="amount" type="int" setter="set_amount" getter="get_amount" default="8"> <member name="amount" type="int" setter="set_amount" getter="get_amount" default="8">

72
doc/classes/CPUParticles2D.xml
View File

@ -20,6 +20,38 @@
Sets this node's properties to match a given [Particles2D] node with an assigned [ParticlesMaterial]. Sets this node's properties to match a given [Particles2D] node with an assigned [ParticlesMaterial].
</description> </description>
</method> </method>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_param_curve" qualifiers="const">
<return type="Curve">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_param_randomness" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_particle_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="CPUParticles2D.Flags">
</argument>
<description>
</description>
</method>
<method name="restart"> <method name="restart">
<return type="void"> <return type="void">
</return> </return>
@ -27,6 +59,46 @@
Restarts the particle emitter. Restarts the particle emitter.
</description> </description>
</method> </method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_curve">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<argument index="1" name="curve" type="Curve">
</argument>
<description>
</description>
</method>
<method name="set_param_randomness">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<argument index="1" name="randomness" type="float">
</argument>
<description>
</description>
</method>
<method name="set_particle_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="CPUParticles2D.Flags">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="amount" type="int" setter="set_amount" getter="get_amount" default="8"> <member name="amount" type="int" setter="set_amount" getter="get_amount" default="8">

36
doc/classes/Camera2D.xml
View File

@ -45,6 +45,22 @@
Returns the location of the [Camera2D]'s screen-center, relative to the origin. Returns the location of the [Camera2D]'s screen-center, relative to the origin.
</description> </description>
</method> </method>
<method name="get_drag_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="get_limit" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="make_current"> <method name="make_current">
<return type="void"> <return type="void">
</return> </return>
@ -60,6 +76,26 @@
This has no effect if smoothing is disabled. This has no effect if smoothing is disabled.
</description> </description>
</method> </method>
<method name="set_drag_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="drag_margin" type="float">
</argument>
<description>
</description>
</method>
<method name="set_limit">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="limit" type="int">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode" default="1"> <member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode" default="1">

18
doc/classes/ConeTwistJoint.xml
View File

@ -11,6 +11,24 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="bias" type="float" setter="set_param" getter="get_param" default="0.3"> <member name="bias" type="float" setter="set_param" getter="get_param" default="0.3">

44
doc/classes/Control.xml
View File

@ -173,6 +173,14 @@
The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data. The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data.
</description> </description>
</method> </method>
<method name="get_anchor" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="get_begin" qualifiers="const"> <method name="get_begin" qualifiers="const">
<return type="Vector2"> <return type="Vector2">
</return> </return>
@ -240,6 +248,14 @@
Returns [member margin_right] and [member margin_bottom]. Returns [member margin_right] and [member margin_bottom].
</description> </description>
</method> </method>
<method name="get_focus_neighbour" qualifiers="const">
<return type="NodePath">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="get_focus_owner" qualifiers="const"> <method name="get_focus_owner" qualifiers="const">
<return type="Control"> <return type="Control">
</return> </return>
@ -274,6 +290,14 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="get_minimum_size" qualifiers="const"> <method name="get_minimum_size" qualifiers="const">
<return type="Vector2"> <return type="Vector2">
</return> </return>
@ -574,6 +598,16 @@
Sets [member margin_right] and [member margin_bottom] at the same time. Sets [member margin_right] and [member margin_bottom] at the same time.
</description> </description>
</method> </method>
<method name="set_focus_neighbour">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="neighbour" type="NodePath">
</argument>
<description>
</description>
</method>
<method name="set_global_position"> <method name="set_global_position">
<return type="void"> <return type="void">
</return> </return>
@ -584,6 +618,16 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="offset" type="float">
</argument>
<description>
</description>
</method>
<method name="set_margins_preset"> <method name="set_margins_preset">
<return type="void"> <return type="void">
</return> </return>

18
doc/classes/DynamicFont.xml
View File

@ -40,6 +40,14 @@
Returns the number of fallback fonts. Returns the number of fallback fonts.
</description> </description>
</method> </method>
<method name="get_spacing" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="type" type="int">
</argument>
<description>
</description>
</method>
<method name="remove_fallback"> <method name="remove_fallback">
<return type="void"> <return type="void">
</return> </return>
@ -60,6 +68,16 @@
Sets the fallback font at index [code]idx[/code]. Sets the fallback font at index [code]idx[/code].
</description> </description>
</method> </method>
<method name="set_spacing">
<return type="void">
</return>
<argument index="0" name="type" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing" default="0"> <member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing" default="0">

18
doc/classes/Environment.xml
View File

@ -15,6 +15,24 @@
<link>https://docs.godotengine.org/en/latest/tutorials/3d/high_dynamic_range.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/3d/high_dynamic_range.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="is_glow_level_enabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="set_glow_level">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="adjustment_brightness" type="float" setter="set_adjustment_brightness" getter="get_adjustment_brightness" default="1.0"> <member name="adjustment_brightness" type="float" setter="set_adjustment_brightness" getter="get_adjustment_brightness" default="1.0">

108
doc/classes/Generic6DOFJoint.xml
View File

@ -9,6 +9,114 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_flag_x" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_flag_y" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_flag_z" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_param_x" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<description>
</description>
</method>
<method name="get_param_y" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<description>
</description>
</method>
<method name="get_param_z" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_flag_x">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flag_y">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flag_z">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_param_x">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_y">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_z">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x" default="1.0"> <member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x" default="1.0">

18
doc/classes/GeometryInstance.xml
View File

@ -9,6 +9,14 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="GeometryInstance.Flags">
</argument>
<description>
</description>
</method>
<method name="set_custom_aabb"> <method name="set_custom_aabb">
<return type="void"> <return type="void">
</return> </return>
@ -18,6 +26,16 @@
Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero. Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.
</description> </description>
</method> </method>
<method name="set_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="GeometryInstance.Flags">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting" default="1"> <member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting" default="1">

36
doc/classes/HingeJoint.xml
View File

@ -9,6 +9,42 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="HingeJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="HingeJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="HingeJoint.Flag">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="HingeJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="angular_limit/bias" type="float" setter="set_param" getter="get_param" default="0.3"> <member name="angular_limit/bias" type="float" setter="set_param" getter="get_param" default="0.3">

18
doc/classes/KinematicBody.xml
View File

@ -12,6 +12,14 @@
<link>https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_axis_lock" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="axis" type="int" enum="PhysicsServer.BodyAxis">
</argument>
<description>
</description>
</method>
<method name="get_floor_velocity" qualifiers="const"> <method name="get_floor_velocity" qualifiers="const">
<return type="Vector3"> <return type="Vector3">
</return> </return>
@ -120,6 +128,16 @@
As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0, 0)[/code] or by using [method move_and_slide] instead. As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0, 0)[/code] or by using [method move_and_slide] instead.
</description> </description>
</method> </method>
<method name="set_axis_lock">
<return type="void">
</return>
<argument index="0" name="axis" type="int" enum="PhysicsServer.BodyAxis">
</argument>
<argument index="1" name="lock" type="bool">
</argument>
<description>
</description>
</method>
<method name="test_move"> <method name="test_move">
<return type="bool"> <return type="bool">
</return> </return>

18
doc/classes/Light.xml
View File

@ -10,6 +10,24 @@
<link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="Light.Param">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="Light.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only" default="false"> <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only" default="false">

18
doc/classes/NinePatchRect.xml
View File

@ -9,6 +9,24 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_patch_margin" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="set_patch_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="NinePatchRect.AxisStretchMode" default="0"> <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="NinePatchRect.AxisStretchMode" default="0">

18
doc/classes/Particles.xml
View File

@ -18,6 +18,14 @@
Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.
</description> </description>
</method> </method>
<method name="get_draw_pass_mesh" qualifiers="const">
<return type="Mesh">
</return>
<argument index="0" name="pass" type="int">
</argument>
<description>
</description>
</method>
<method name="restart"> <method name="restart">
<return type="void"> <return type="void">
</return> </return>
@ -25,6 +33,16 @@
Restarts the particle emission, clearing existing particles. Restarts the particle emission, clearing existing particles.
</description> </description>
</method> </method>
<method name="set_draw_pass_mesh">
<return type="void">
</return>
<argument index="0" name="pass" type="int">
</argument>
<argument index="1" name="mesh" type="Mesh">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="amount" type="int" setter="set_amount" getter="get_amount" default="8"> <member name="amount" type="int" setter="set_amount" getter="get_amount" default="8">

72
doc/classes/ParticlesMaterial.xml
View File

@ -11,6 +11,78 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="ParticlesMaterial.Flags">
</argument>
<description>
</description>
</method>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_param_randomness" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<description>
</description>
</method>
<method name="get_param_texture" qualifiers="const">
<return type="Texture">
</return>
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<description>
</description>
</method>
<method name="set_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="ParticlesMaterial.Flags">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_randomness">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<argument index="1" name="randomness" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_texture">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<argument index="1" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="angle" type="float" setter="set_param" getter="get_param" default="0.0"> <member name="angle" type="float" setter="set_param" getter="get_param" default="0.0">

18
doc/classes/PinJoint.xml
View File

@ -9,6 +9,24 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="PinJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="PinJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="params/bias" type="float" setter="set_param" getter="get_param" default="0.3"> <member name="params/bias" type="float" setter="set_param" getter="get_param" default="0.3">

18
doc/classes/RigidBody.xml
View File

@ -82,6 +82,14 @@
Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the [code]impulse[/code] vector passed. Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the [code]impulse[/code] vector passed.
</description> </description>
</method> </method>
<method name="get_axis_lock" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="axis" type="int" enum="PhysicsServer.BodyAxis">
</argument>
<description>
</description>
</method>
<method name="get_colliding_bodies" qualifiers="const"> <method name="get_colliding_bodies" qualifiers="const">
<return type="Array"> <return type="Array">
</return> </return>
@ -90,6 +98,16 @@
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
</description> </description>
</method> </method>
<method name="set_axis_lock">
<return type="void">
</return>
<argument index="0" name="axis" type="int" enum="PhysicsServer.BodyAxis">
</argument>
<argument index="1" name="lock" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_axis_velocity"> <method name="set_axis_velocity">
<return type="void"> <return type="void">
</return> </return>

18
doc/classes/SliderJoint.xml
View File

@ -9,6 +9,24 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="SliderJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="SliderJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="angular_limit/damping" type="float" setter="set_param" getter="get_param" default="0.0"> <member name="angular_limit/damping" type="float" setter="set_param" getter="get_param" default="0.0">

54
doc/classes/SpatialMaterial.xml
View File

@ -10,6 +10,60 @@
<link>https://docs.godotengine.org/en/latest/tutorials/3d/spatial_material.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/3d/spatial_material.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_feature" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature">
</argument>
<description>
</description>
</method>
<method name="get_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags">
</argument>
<description>
</description>
</method>
<method name="get_texture" qualifiers="const">
<return type="Texture">
</return>
<argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam">
</argument>
<description>
</description>
</method>
<method name="set_feature">
<return type="void">
</return>
<argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_texture">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam">
</argument>
<argument index="1" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="albedo_color" type="Color" setter="set_albedo" getter="get_albedo" default="Color( 1, 1, 1, 1 )"> <member name="albedo_color" type="Color" setter="set_albedo" getter="get_albedo" default="Color( 1, 1, 1, 1 )">

18
doc/classes/SpriteBase3D.xml
View File

@ -15,12 +15,30 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_draw_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags">
</argument>
<description>
</description>
</method>
<method name="get_item_rect" qualifiers="const"> <method name="get_item_rect" qualifiers="const">
<return type="Rect2"> <return type="Rect2">
</return> </return>
<description> <description>
</description> </description>
</method> </method>
<method name="set_draw_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="alpha_cut" type="int" setter="set_alpha_cut_mode" getter="get_alpha_cut_mode" enum="SpriteBase3D.AlphaCutMode" default="0"> <member name="alpha_cut" type="int" setter="set_alpha_cut_mode" getter="get_alpha_cut_mode" enum="SpriteBase3D.AlphaCutMode" default="0">

8
doc/classes/StreamTexture.xml
View File

@ -9,6 +9,14 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="load">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="load_path" type="String" setter="load" getter="get_load_path" default="&quot;&quot;"> <member name="load_path" type="String" setter="load" getter="get_load_path" default="&quot;&quot;">

18
doc/classes/StyleBox.xml
View File

@ -31,6 +31,14 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_default_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="get_margin" qualifiers="const"> <method name="get_margin" qualifiers="const">
<return type="float"> <return type="float">
</return> </return>
@ -55,6 +63,16 @@
Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code].
</description> </description>
</method> </method>
<method name="set_default_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="offset" type="float">
</argument>
<description>
</description>
</method>
<method name="test_mask" qualifiers="const"> <method name="test_mask" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>

54
doc/classes/StyleBoxFlat.xml
View File

@ -24,12 +24,46 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_border_width" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="get_border_width_min" qualifiers="const"> <method name="get_border_width_min" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_corner_radius" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="corner" type="int" enum="Corner">
</argument>
<description>
</description>
</method>
<method name="get_expand_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="set_border_width">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="width" type="int">
</argument>
<description>
</description>
</method>
<method name="set_border_width_all"> <method name="set_border_width_all">
<return type="void"> <return type="void">
</return> </return>
@ -38,6 +72,16 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_corner_radius">
<return type="void">
</return>
<argument index="0" name="corner" type="int" enum="Corner">
</argument>
<argument index="1" name="radius" type="int">
</argument>
<description>
</description>
</method>
<method name="set_corner_radius_all"> <method name="set_corner_radius_all">
<return type="void"> <return type="void">
</return> </return>
@ -60,6 +104,16 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_expand_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="size" type="float">
</argument>
<description>
</description>
</method>
<method name="set_expand_margin_all"> <method name="set_expand_margin_all">
<return type="void"> <return type="void">
</return> </return>

36
doc/classes/StyleBoxTexture.xml
View File

@ -9,6 +9,22 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_expand_margin_size" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="get_margin_size" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="set_expand_margin_all"> <method name="set_expand_margin_all">
<return type="void"> <return type="void">
</return> </return>
@ -31,6 +47,26 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_expand_margin_size">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="size" type="float">
</argument>
<description>
</description>
</method>
<method name="set_margin_size">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="size" type="float">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode" default="0"> <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode" default="0">

18
doc/classes/TextureProgress.xml
View File

@ -9,6 +9,24 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_stretch_margin" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
</description>
</method>
<method name="set_stretch_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode" default="0"> <member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode" default="0">

18
doc/classes/Viewport.xml
View File

@ -67,6 +67,14 @@
Returns information about the viewport from the rendering pipeline. Returns information about the viewport from the rendering pipeline.
</description> </description>
</method> </method>
<method name="get_shadow_atlas_quadrant_subdiv" qualifiers="const">
<return type="int" enum="Viewport.ShadowAtlasQuadrantSubdiv">
</return>
<argument index="0" name="quadrant" type="int">
</argument>
<description>
</description>
</method>
<method name="get_size_override" qualifiers="const"> <method name="get_size_override" qualifiers="const">
<return type="Vector2"> <return type="Vector2">
</return> </return>
@ -162,6 +170,16 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_shadow_atlas_quadrant_subdiv">
<return type="void">
</return>
<argument index="0" name="quadrant" type="int">
</argument>
<argument index="1" name="subdiv" type="int" enum="Viewport.ShadowAtlasQuadrantSubdiv">
</argument>
<description>
</description>
</method>
<method name="set_size_override"> <method name="set_size_override">
<return type="void"> <return type="void">
</return> </return>

18
doc/classes/VisibilityEnabler.xml
View File

@ -9,6 +9,24 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="is_enabler_enabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler">
</argument>
<description>
</description>
</method>
<method name="set_enabler">
<return type="void">
</return>
<argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true"> <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">

18
doc/classes/VisibilityEnabler2D.xml
View File

@ -9,6 +9,24 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="is_enabler_enabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler">
</argument>
<description>
</description>
</method>
<method name="set_enabler">
<return type="void">
</return>
<argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true"> <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">

25
editor/doc/doc_data.cpp
View File

@ -323,8 +323,14 @@ void DocData::generate(bool p_basic_types) {
if (E->get().name == "" || (E->get().name[0] == '_' && !(E->get().flags & METHOD_FLAG_VIRTUAL))) if (E->get().name == "" || (E->get().name[0] == '_' && !(E->get().flags & METHOD_FLAG_VIRTUAL)))
continue; //hidden, don't count continue; //hidden, don't count
if (skip_setter_getter_methods && setters_getters.has(E->get().name) && E->get().name.find("/") == -1) if (skip_setter_getter_methods && setters_getters.has(E->get().name)) {
continue; // Don't skip parametric setters and getters, i.e. method which require
// one or more parameters to define what property should be set or retrieved.
// E.g. CPUParticles::set_param(Parameter param, float value).
if (E->get().arguments.size() == 0 /* getter */ || (E->get().arguments.size() == 1 && E->get().return_val.type == Variant::NIL /* setter */)) {
continue;
}
}
MethodDoc method; MethodDoc method;
@ -366,21 +372,6 @@ void DocData::generate(bool p_basic_types) {
method.arguments.push_back(argument); method.arguments.push_back(argument);
} }
/*
String hint;
switch(arginfo.hint) {
case PROPERTY_HINT_DIR: hint="A directory."; break;
case PROPERTY_HINT_RANGE: hint="Range - min: "+arginfo.hint_string.get_slice(",",0)+" max: "+arginfo.hint_string.get_slice(",",1)+" step: "+arginfo.hint_string.get_slice(",",2); break;
case PROPERTY_HINT_ENUM: hint="Values: "; for(int j=0;j<arginfo.hint_string.get_slice_count(",");j++) { if (j>0) hint+=", "; hint+=arginfo.hint_string.get_slice(",",j)+"="+itos(j); } break;
case PROPERTY_HINT_LENGTH: hint="Length: "+arginfo.hint_string; break;
case PROPERTY_HINT_FLAGS: hint="Values: "; for(int j=0;j<arginfo.hint_string.get_slice_count(",");j++) { if (j>0) hint+=", "; hint+=arginfo.hint_string.get_slice(",",j)+"="+itos(1<<j); } break;
case PROPERTY_HINT_FILE: hint="A file:"; break;
//case PROPERTY_HINT_RESOURCE_TYPE: hint="Type: "+arginfo.hint_string; break;
};
if (hint!="")
_write_string(f,4,hint);
*/
} }
c.methods.push_back(method); c.methods.push_back(method);