diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AudioEffectFilter.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Camera2D.xml | 10 | ||||
| -rw-r--r-- | doc/classes/CubeMap.xml | 8 | ||||
| -rw-r--r-- | doc/classes/HTTPClient.xml | 18 | ||||
| -rw-r--r-- | doc/classes/Node2D.xml | 8 | ||||
| -rw-r--r-- | doc/classes/RichTextLabel.xml | 23 | ||||
| -rw-r--r-- | doc/classes/Script.xml | 6 |
7 files changed, 40 insertions, 35 deletions
diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 9ce1a93121..82d572b81b 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -75,7 +75,7 @@ <member name="db" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB"> </member> <member name="gain" type="float" setter="set_gain" getter="get_gain"> - Gain amount of the frequences after the filter. + Gain amount of the frequencies after the filter. </member> <member name="resonance" type="float" setter="set_resonance" getter="get_resonance"> Amount of boost in the overtones near the cutoff frequency. diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 93140a0df6..352e270e77 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -348,10 +348,13 @@ If [code]true[/code] the camera only moves when reaching the vertical drag margins. If [code]false[/code] the camera moves vertically regardless of margins. Default value: [code]true[/code]. </member> <member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled"> + If [code]true[/code] draws the camera's drag margin rectangle in the editor. Default value: [code]false[/code] </member> <member name="editor_draw_limits" type="bool" setter="set_limit_drawing_enabled" getter="is_limit_drawing_enabled"> + If [code]true[/code] draws the camera's limits rectangle in the editor. Default value: [code]true[/code] </member> <member name="editor_draw_screen" type="bool" setter="set_screen_drawing_enabled" getter="is_screen_drawing_enabled"> + If [code]true[/code] draws the camera's screen rectangle in the editor. Default value: [code]false[/code] </member> <member name="limit_bottom" type="int" setter="set_limit" getter="get_limit"> Bottom scroll limit in pixels. The camera stops moving when reaching this value. @@ -363,6 +366,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value. </member> <member name="limit_smoothed" type="bool" setter="set_limit_smoothing_enabled" getter="is_limit_smoothing_enabled"> + If [code]true[/code] the camera smoothly stops when reaches its limits. Default value: [code]false[/code] </member> <member name="limit_top" type="int" setter="set_limit" getter="get_limit"> Top scroll limit in pixels. The camera stops moving when reaching this value. @@ -371,13 +375,13 @@ The camera's offset, useful for looking around or camera shake animations. </member> <member name="rotating" type="bool" setter="set_rotating" getter="is_rotating"> - If [code]true[/code] the camera can rotate during gameplay. Default value: [code]false[/code]. + If [code]true[/code] the camera rotates with the target. Default value: [code]false[/code] </member> <member name="smoothing_enabled" type="bool" setter="set_enable_follow_smoothing" getter="is_follow_smoothing_enabled"> - If [code]true[/code] the camera's velocity changes gradually, preventing sudden starts and stops. Default value: [code]false[/code]. + If [code]true[/code] the camera smoothly moves towards the target at [member smoothing_speed]. Default value: [code]false[/code] </member> <member name="smoothing_speed" type="float" setter="set_follow_smoothing" getter="get_follow_smoothing"> - How fast the camera's velocity changes if smoothing is enabled. + Speed in pixels per second of the camera's smoothing effect when [member smoothing_enabled] is [code]true[/code] </member> <member name="zoom" type="Vector2" setter="set_zoom" getter="get_zoom"> The camera's zoom relative to the viewport. Values larger than [code]Vector2(1, 1)[/code] zoom out and smaller values zoom in. For an example, use [code]Vector2(0.5, 0.5)[/code] for a 2x zoom in, and [code]Vector2(4, 4)[/code] for a 4x zoom out. diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index 5626554193..b173bba3c6 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CubeMap" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> <brief_description> + A CubeMap is a 6 sided 3D texture. </brief_description> <description> + A CubeMap is a 6 sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. </description> <tutorials> </tutorials> @@ -19,6 +21,7 @@ <return type="int"> </return> <description> + Returns the CubeMap's height. </description> </method> <method name="get_lossy_storage_quality" qualifiers="const"> @@ -33,6 +36,7 @@ <argument index="0" name="side" type="int" enum="CubeMap.Side"> </argument> <description> + Returns an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> <method name="get_storage" qualifiers="const"> @@ -45,6 +49,7 @@ <return type="int"> </return> <description> + Returns the CubeMap's width. </description> </method> <method name="set_flags"> @@ -71,6 +76,7 @@ <argument index="1" name="image" type="Image"> </argument> <description> + Sets an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5. </description> </method> <method name="set_storage"> @@ -84,8 +90,10 @@ </methods> <members> <member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality"> + The lossy storage quality of the CubeMap if the storage mode is set to STORAGE_COMPRESS_LOSSY. </member> <member name="storage_mode" type="int" setter="set_storage" getter="get_storage" enum="CubeMap.Storage"> + The CubeMap's storage mode. See [code]STORAGE_*[/code] constants. </member> </members> <constants> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index e75aee0126..f148545848 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -169,24 +169,6 @@ Sends body raw, as a byte array, does not encode it in any way. </description> </method> - <method name="send_body_data"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="body" type="PoolByteArray"> - </argument> - <description> - Stub function - </description> - </method> - <method name="send_body_text"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="body" type="String"> - </argument> - <description> - Stub function - </description> - </method> <method name="set_blocking_mode"> <return type="void"> </return> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index b00020b227..669a0fb9ff 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -322,13 +322,13 @@ Position, relative to the node's parent. </member> <member name="rotation" type="float" setter="set_rotation" getter="get_rotation"> - Rotation in radians. + Rotation in radians, relative to the node's parent. </member> <member name="rotation_deg" type="float" setter="set_rotation_in_degrees" getter="get_rotation_in_degrees"> - Rotation in degrees. + Rotation in degrees, relative to the node's parent. </member> <member name="scale" type="Vector2" setter="set_scale" getter="get_scale"> - Rotation in degrees. + The node's scale. Unscaled value: [code](1, 1)[/code] </member> <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> Local [Transform2D]. @@ -337,7 +337,7 @@ Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. </member> <member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative"> - Make the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. + If [code]true[/code] the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. </member> </members> <constants> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index c28a2b26b4..7f9955d29b 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -31,6 +31,7 @@ <return type="int" enum="Error"> </return> <argument index="0" name="bbcode" type="String"> + Adds BBCode to the text label. </argument> <description> </description> @@ -39,24 +40,28 @@ <return type="void"> </return> <description> + Clears the label's text. </description> </method> <method name="get_bbcode" qualifiers="const"> <return type="String"> </return> <description> + Returns label's BBCode. </description> </method> <method name="get_line_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of lines in the text. </description> </method> <method name="get_percent_visible" qualifiers="const"> <return type="float"> </return> <description> + Returns the text's visibility as a floating point value between 0.0 and 1.0. </description> </method> <method name="get_tab_size" qualifiers="const"> @@ -69,13 +74,14 @@ <return type="String"> </return> <description> - Returns the raw text, stripping out the formatting information. + Returns the label's text with the formatting removed. </description> </method> <method name="get_total_character_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the total number of characters. </description> </method> <method name="get_v_scroll"> @@ -94,6 +100,7 @@ <return type="int"> </return> <description> + Returns the number of visible lines. </description> </method> <method name="is_meta_underlined" qualifiers="const"> @@ -112,6 +119,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if active scrolling is enabled. </description> </method> <method name="is_scroll_following" qualifiers="const"> @@ -124,19 +132,21 @@ <return type="bool"> </return> <description> - Return true if selecting the text inside this richtext is allowed. + Returns [code]true[/code] if the label's text can be selected. </description> </method> <method name="is_using_bbcode" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the label has BBCode. </description> </method> <method name="newline"> <return type="void"> </return> <description> + Adds a newline to the end of the rich text. </description> </method> <method name="parse_bbcode"> @@ -243,6 +253,7 @@ <argument index="0" name="text" type="String"> </argument> <description> + Sets the BBCode text to the label. </description> </method> <method name="set_meta_underline"> @@ -267,6 +278,7 @@ <argument index="0" name="percent_visible" type="float"> </argument> <description> + Sets the text's visibility. Takes a floating point value between 0.0 and 1.0. </description> </method> <method name="set_scroll_active"> @@ -291,7 +303,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set to true if selecting the text inside this richtext is allowed. + If [code]true[/code] text can be selected. </description> </method> <method name="set_tab_size"> @@ -341,14 +353,19 @@ </methods> <members> <member name="bbcode_enabled" type="bool" setter="set_use_bbcode" getter="is_using_bbcode"> + If [code]true[/code] the label uses BBCode formatting. Default value: [code]false[/code]. </member> <member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode"> + The label's text in BBCode format. </member> <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> + If [code]true[/code] the label uses the custom font color. Default value: [code]false[/code]. </member> <member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible"> + The text's visibility, as a [float] between 0.0 and 1.0. </member> <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters"> + The restricted number of characters to display in the label. </member> </members> <signals> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 307afba8a7..c13e009976 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -19,12 +19,6 @@ Returns true if the script can be instanced. </description> </method> - <method name="get_node_type" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> <method name="get_source_code" qualifiers="const"> <return type="String"> </return> |