diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/@Global Scope.xml | 134 | ||||
| -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/EditorImportPlugin.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Environment.xml | 62 | ||||
| -rw-r--r-- | doc/classes/HTTPClient.xml | 18 | ||||
| -rw-r--r-- | doc/classes/Image.xml | 71 | ||||
| -rw-r--r-- | doc/classes/LineEdit.xml | 58 | ||||
| -rw-r--r-- | doc/classes/Node2D.xml | 8 | ||||
| -rw-r--r-- | doc/classes/ParallaxLayer.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Quat.xml | 2 | ||||
| -rw-r--r-- | doc/classes/RayCast.xml | 18 | ||||
| -rw-r--r-- | doc/classes/RayCast2D.xml | 18 | ||||
| -rw-r--r-- | doc/classes/RichTextLabel.xml | 23 | ||||
| -rw-r--r-- | doc/classes/Script.xml | 6 | ||||
| -rw-r--r-- | doc/classes/TextEdit.xml | 16 |
17 files changed, 307 insertions, 153 deletions
diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml index 9d0133faf4..20f323bb4f 100644 --- a/doc/classes/@Global Scope.xml +++ b/doc/classes/@Global Scope.xml @@ -863,199 +863,199 @@ <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824"> Group Switch Key Mask </constant> - <constant name="BUTTON_LEFT" value="1" enum=""> + <constant name="BUTTON_LEFT" value="1"> Left Mouse Button </constant> - <constant name="BUTTON_RIGHT" value="2" enum=""> + <constant name="BUTTON_RIGHT" value="2"> Right Mouse Button </constant> - <constant name="BUTTON_MIDDLE" value="3" enum=""> + <constant name="BUTTON_MIDDLE" value="3"> Middle Mouse Button </constant> - <constant name="BUTTON_WHEEL_UP" value="4" enum=""> + <constant name="BUTTON_WHEEL_UP" value="4"> Mouse wheel up </constant> - <constant name="BUTTON_WHEEL_DOWN" value="5" enum=""> + <constant name="BUTTON_WHEEL_DOWN" value="5"> Mouse wheel down </constant> - <constant name="BUTTON_WHEEL_LEFT" value="6" enum=""> + <constant name="BUTTON_WHEEL_LEFT" value="6"> Mouse wheel left button </constant> - <constant name="BUTTON_WHEEL_RIGHT" value="7" enum=""> + <constant name="BUTTON_WHEEL_RIGHT" value="7"> Mouse wheel right button </constant> - <constant name="BUTTON_MASK_LEFT" value="1" enum=""> + <constant name="BUTTON_MASK_LEFT" value="1"> Left Mouse Button Mask </constant> - <constant name="BUTTON_MASK_RIGHT" value="2" enum=""> + <constant name="BUTTON_MASK_RIGHT" value="2"> Right Mouse Button Mask </constant> - <constant name="BUTTON_MASK_MIDDLE" value="4" enum=""> + <constant name="BUTTON_MASK_MIDDLE" value="4"> Middle Mouse Button Mask </constant> - <constant name="JOY_BUTTON_0" value="0" enum=""> + <constant name="JOY_BUTTON_0" value="0"> Joypad Button 0 </constant> - <constant name="JOY_BUTTON_1" value="1" enum=""> + <constant name="JOY_BUTTON_1" value="1"> Joypad Button 1 </constant> - <constant name="JOY_BUTTON_2" value="2" enum=""> + <constant name="JOY_BUTTON_2" value="2"> Joypad Button 2 </constant> - <constant name="JOY_BUTTON_3" value="3" enum=""> + <constant name="JOY_BUTTON_3" value="3"> Joypad Button 3 </constant> - <constant name="JOY_BUTTON_4" value="4" enum=""> + <constant name="JOY_BUTTON_4" value="4"> Joypad Button 4 </constant> - <constant name="JOY_BUTTON_5" value="5" enum=""> + <constant name="JOY_BUTTON_5" value="5"> Joypad Button 5 </constant> - <constant name="JOY_BUTTON_6" value="6" enum=""> + <constant name="JOY_BUTTON_6" value="6"> Joypad Button 6 </constant> - <constant name="JOY_BUTTON_7" value="7" enum=""> + <constant name="JOY_BUTTON_7" value="7"> Joypad Button 7 </constant> - <constant name="JOY_BUTTON_8" value="8" enum=""> + <constant name="JOY_BUTTON_8" value="8"> Joypad Button 8 </constant> - <constant name="JOY_BUTTON_9" value="9" enum=""> + <constant name="JOY_BUTTON_9" value="9"> Joypad Button 9 </constant> - <constant name="JOY_BUTTON_10" value="10" enum=""> + <constant name="JOY_BUTTON_10" value="10"> Joypad Button 10 </constant> - <constant name="JOY_BUTTON_11" value="11" enum=""> + <constant name="JOY_BUTTON_11" value="11"> Joypad Button 11 </constant> - <constant name="JOY_BUTTON_12" value="12" enum=""> + <constant name="JOY_BUTTON_12" value="12"> Joypad Button 12 </constant> - <constant name="JOY_BUTTON_13" value="13" enum=""> + <constant name="JOY_BUTTON_13" value="13"> Joypad Button 13 </constant> - <constant name="JOY_BUTTON_14" value="14" enum=""> + <constant name="JOY_BUTTON_14" value="14"> Joypad Button 14 </constant> - <constant name="JOY_BUTTON_15" value="15" enum=""> + <constant name="JOY_BUTTON_15" value="15"> Joypad Button 15 </constant> - <constant name="JOY_BUTTON_MAX" value="16" enum=""> + <constant name="JOY_BUTTON_MAX" value="16"> Joypad Button 16 </constant> - <constant name="JOY_SONY_CIRCLE" value="1" enum=""> + <constant name="JOY_SONY_CIRCLE" value="1"> DUALSHOCK circle button </constant> - <constant name="JOY_SONY_X" value="0" enum=""> + <constant name="JOY_SONY_X" value="0"> DUALSHOCK X button </constant> - <constant name="JOY_SONY_SQUARE" value="2" enum=""> + <constant name="JOY_SONY_SQUARE" value="2"> DUALSHOCK square button </constant> - <constant name="JOY_SONY_TRIANGLE" value="3" enum=""> + <constant name="JOY_SONY_TRIANGLE" value="3"> DUALSHOCK triangle button </constant> - <constant name="JOY_XBOX_B" value="1" enum=""> + <constant name="JOY_XBOX_B" value="1"> XBOX controller B button </constant> - <constant name="JOY_XBOX_A" value="0" enum=""> + <constant name="JOY_XBOX_A" value="0"> XBOX controller A button </constant> - <constant name="JOY_XBOX_X" value="2" enum=""> + <constant name="JOY_XBOX_X" value="2"> XBOX controller X button </constant> - <constant name="JOY_XBOX_Y" value="3" enum=""> + <constant name="JOY_XBOX_Y" value="3"> XBOX controller Y button </constant> - <constant name="JOY_DS_A" value="1" enum=""> + <constant name="JOY_DS_A" value="1"> DualShock controller A button </constant> - <constant name="JOY_DS_B" value="0" enum=""> + <constant name="JOY_DS_B" value="0"> DualShock controller B button </constant> - <constant name="JOY_DS_X" value="3" enum=""> + <constant name="JOY_DS_X" value="3"> DualShock controller X button </constant> - <constant name="JOY_DS_Y" value="2" enum=""> + <constant name="JOY_DS_Y" value="2"> DualShock controller Y button </constant> - <constant name="JOY_SELECT" value="10" enum=""> + <constant name="JOY_SELECT" value="10"> Joypad Button Select </constant> - <constant name="JOY_START" value="11" enum=""> + <constant name="JOY_START" value="11"> Joypad Button Start </constant> - <constant name="JOY_DPAD_UP" value="12" enum=""> + <constant name="JOY_DPAD_UP" value="12"> Joypad DPad Up </constant> - <constant name="JOY_DPAD_DOWN" value="13" enum=""> + <constant name="JOY_DPAD_DOWN" value="13"> Joypad DPad Down </constant> - <constant name="JOY_DPAD_LEFT" value="14" enum=""> + <constant name="JOY_DPAD_LEFT" value="14"> Joypad DPad Left </constant> - <constant name="JOY_DPAD_RIGHT" value="15" enum=""> + <constant name="JOY_DPAD_RIGHT" value="15"> Joypad DPad Right </constant> - <constant name="JOY_L" value="4" enum=""> + <constant name="JOY_L" value="4"> Joypad Left Shoulder Button </constant> - <constant name="JOY_L2" value="6" enum=""> + <constant name="JOY_L2" value="6"> Joypad Left Trigger </constant> - <constant name="JOY_L3" value="8" enum=""> + <constant name="JOY_L3" value="8"> Joypad Left Stick Click </constant> - <constant name="JOY_R" value="5" enum=""> + <constant name="JOY_R" value="5"> Joypad Right Shoulder Button </constant> - <constant name="JOY_R2" value="7" enum=""> + <constant name="JOY_R2" value="7"> Joypad Right Trigger </constant> - <constant name="JOY_R3" value="9" enum=""> + <constant name="JOY_R3" value="9"> Joypad Right Stick Click </constant> - <constant name="JOY_AXIS_0" value="0" enum=""> + <constant name="JOY_AXIS_0" value="0"> Joypad Left Stick Horizontal Axis </constant> - <constant name="JOY_AXIS_1" value="1" enum=""> + <constant name="JOY_AXIS_1" value="1"> Joypad Left Stick Vertical Axis </constant> - <constant name="JOY_AXIS_2" value="2" enum=""> + <constant name="JOY_AXIS_2" value="2"> Joypad Right Stick Horizontal Axis </constant> - <constant name="JOY_AXIS_3" value="3" enum=""> + <constant name="JOY_AXIS_3" value="3"> Joypad Right Stick Vertical Axis </constant> - <constant name="JOY_AXIS_4" value="4" enum=""> + <constant name="JOY_AXIS_4" value="4"> </constant> - <constant name="JOY_AXIS_5" value="5" enum=""> + <constant name="JOY_AXIS_5" value="5"> </constant> - <constant name="JOY_AXIS_6" value="6" enum=""> + <constant name="JOY_AXIS_6" value="6"> Joypad Left Trigger Analog Axis </constant> - <constant name="JOY_AXIS_7" value="7" enum=""> + <constant name="JOY_AXIS_7" value="7"> Joypad Right Trigger Analog Axis </constant> - <constant name="JOY_AXIS_MAX" value="8" enum=""> + <constant name="JOY_AXIS_MAX" value="8"> </constant> - <constant name="JOY_ANALOG_LX" value="0" enum=""> + <constant name="JOY_ANALOG_LX" value="0"> Joypad Left Stick Horizontal Axis </constant> - <constant name="JOY_ANALOG_LY" value="1" enum=""> + <constant name="JOY_ANALOG_LY" value="1"> Joypad Left Stick Vertical Axis </constant> - <constant name="JOY_ANALOG_RX" value="2" enum=""> + <constant name="JOY_ANALOG_RX" value="2"> Joypad Right Stick Horizontal Axis </constant> - <constant name="JOY_ANALOG_RY" value="3" enum=""> + <constant name="JOY_ANALOG_RY" value="3"> Joypad Right Stick Vertical Axis </constant> - <constant name="JOY_ANALOG_L2" value="6" enum=""> + <constant name="JOY_ANALOG_L2" value="6"> Joypad Left Analog Trigger </constant> - <constant name="JOY_ANALOG_R2" value="7" enum=""> + <constant name="JOY_ANALOG_R2" value="7"> Joypad Right Analog Trigger </constant> <constant name="OK" value="0"> @@ -1377,7 +1377,7 @@ Variable is of type [PoolColorArray]. </constant> <constant name="TYPE_MAX" value="27"> - </constant> Marker for end of type constants. + </constant> </constants> </class> 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/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index da8f0f235b..c276a8f661 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -39,8 +39,8 @@ return [{"name": "my_option", "default_value": false}] func load(src, dst, opts, r_platform_variants, r_gen_files): - var f = File.new() - if f.open(src, File.READ) != OK: + var file = File.new() + if file.open(src, File.READ) != OK: return FAILED var mesh = Mesh.new() diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 2918200633..4d40d5af9a 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -238,6 +238,12 @@ <description> </description> </method> + <method name="get_ssao_blur" qualifiers="const"> + <return type="int" enum="Environment.SSAOBlur"> + </return> + <description> + </description> + </method> <method name="get_ssao_color" qualifiers="const"> <return type="Color"> </return> @@ -250,6 +256,12 @@ <description> </description> </method> + <method name="get_ssao_edge_sharpness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_ssao_intensity" qualifiers="const"> <return type="float"> </return> @@ -262,6 +274,12 @@ <description> </description> </method> + <method name="get_ssao_quality" qualifiers="const"> + <return type="int" enum="Environment.SSAOQuality"> + </return> + <description> + </description> + </method> <method name="get_ssao_radius" qualifiers="const"> <return type="float"> </return> @@ -408,12 +426,6 @@ <description> </description> </method> - <method name="is_ssao_blur_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_ssao_enabled" qualifiers="const"> <return type="bool"> </return> @@ -813,7 +825,7 @@ <method name="set_ssao_blur"> <return type="void"> </return> - <argument index="0" name="enabled" type="bool"> + <argument index="0" name="mode" type="int" enum="Environment.SSAOBlur"> </argument> <description> </description> @@ -834,6 +846,14 @@ <description> </description> </method> + <method name="set_ssao_edge_sharpness"> + <return type="void"> + </return> + <argument index="0" name="edge_sharpness" type="float"> + </argument> + <description> + </description> + </method> <method name="set_ssao_enabled"> <return type="void"> </return> @@ -858,6 +878,14 @@ <description> </description> </method> + <method name="set_ssao_quality"> + <return type="void"> + </return> + <argument index="0" name="quality" type="int" enum="Environment.SSAOQuality"> + </argument> + <description> + </description> + </method> <method name="set_ssao_radius"> <return type="void"> </return> @@ -1172,10 +1200,12 @@ </member> <member name="ssao_bias" type="float" setter="set_ssao_bias" getter="get_ssao_bias"> </member> - <member name="ssao_blur" type="bool" setter="set_ssao_blur" getter="is_ssao_blur_enabled"> + <member name="ssao_blur" type="int" setter="set_ssao_blur" getter="is_ssao_blur_enabled" enum="Environment.SSAOBlur"> </member> <member name="ssao_color" type="Color" setter="set_ssao_color" getter="get_ssao_color"> </member> + <member name="ssao_edge_sharpness" type="float" setter="set_ssao_edge_sharpness" getter="get_ssao_edge_sharpness"> + </member> <member name="ssao_enabled" type="bool" setter="set_ssao_enabled" getter="is_ssao_enabled"> </member> <member name="ssao_intensity" type="float" setter="set_ssao_intensity" getter="get_ssao_intensity"> @@ -1184,6 +1214,8 @@ </member> <member name="ssao_light_affect" type="float" setter="set_ssao_direct_light_affect" getter="get_ssao_direct_light_affect"> </member> + <member name="ssao_quality" type="int" setter="set_ssao_quality" getter="get_ssao_quality" enum="Environment.SSAOQuality"> + </member> <member name="ssao_radius" type="float" setter="set_ssao_radius" getter="get_ssao_radius"> </member> <member name="ssao_radius2" type="float" setter="set_ssao_radius2" getter="get_ssao_radius2"> @@ -1253,5 +1285,19 @@ <constant name="DOF_BLUR_QUALITY_HIGH" value="2"> High depth-of-field blur quality. </constant> + <constant name="SSAO_BLUR_DISABLED" value="0"> + </constant> + <constant name="SSAO_BLUR_1x1" value="1"> + </constant> + <constant name="SSAO_BLUR_2x2" value="2"> + </constant> + <constant name="SSAO_BLUR_3x3" value="3"> + </constant> + <constant name="SSAO_QUALITY_LOW" value="0"> + </constant> + <constant name="SSAO_QUALITY_MEDIUM" value="1"> + </constant> + <constant name="SSAO_QUALITY_HIGH" value="2"> + </constant> </constants> </class> 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/Image.xml b/doc/classes/Image.xml index 2e76eb6d0b..d5bea810ad 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -4,7 +4,7 @@ Image datatype. </brief_description> <description> - Native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it. + Native image datatype. Contains image data, which can be converted to a [Texture], and several functions to interact with it. The maximum width and height for an [code]Image[/code] is 16384 pixels. </description> <tutorials> </tutorials> @@ -21,7 +21,7 @@ <argument index="2" name="dst" type="Vector2"> </argument> <description> - Alpha-blends a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] on coordinates "dest". + Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dest[/code]. </description> </method> <method name="blend_rect_mask"> @@ -36,7 +36,7 @@ <argument index="3" name="dst" type="Vector2"> </argument> <description> - Alpha-blends a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] using a "mask" [code]Image[/code] on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" [code]Image[/code] and "mask" [code]Image[/code] *must* have the same size (width and height) but they can have different formats + Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image using [code]mask[/code] image at coordinates [code]dst[/code]. Alpha channels are required for both [code]src[/code] and [code]mask[/code]. [code]dst[/code] pixels and [code]src[/code] pixels will blend if the corresponding mask pixel's alpha value is not 0. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. </description> </method> <method name="blit_rect"> @@ -49,7 +49,7 @@ <argument index="2" name="dst" type="Vector2"> </argument> <description> - Copy a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] on coordinates "dest". + Copies [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dst[/code]. </description> </method> <method name="blit_rect_mask"> @@ -64,13 +64,14 @@ <argument index="3" name="dst" type="Vector2"> </argument> <description> - Blits a "src_rect" [Rect2] from "src" [code]Image[/code] to this [code]Image[/code] using a "mask" [code]Image[/code] on coordinates "dest". Alpha channel is required for "mask", will copy src pixel onto dest if the corresponding mask pixel's alpha value is not 0. "src" [code]Image[/code] and "mask" [code]Image[/code] *must* have the same size (width and height) but they can have different formats + Blits [code]src_rect[/code] area from [code]src[/code] image to this image at the coordinates given by [code]dst[/code]. [code]src[/code] pixel is copied onto [code]dst[/code] if the corresponding [code]mask[/code] pixel's alpha value is not 0. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. </description> </method> <method name="clear_mipmaps"> <return type="void"> </return> <description> + Removes the image's mipmaps. </description> </method> <method name="compress"> @@ -83,6 +84,7 @@ <argument index="2" name="lossy_quality" type="float"> </argument> <description> + Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See [code]COMPRESS_*[/code] constants. </description> </method> <method name="convert"> @@ -91,6 +93,7 @@ <argument index="0" name="format" type="int" enum="Image.Format"> </argument> <description> + Converts the image's format. See [code]FORMAT_*[/code] constants. </description> </method> <method name="copy_from"> @@ -99,6 +102,7 @@ <argument index="0" name="src" type="Image"> </argument> <description> + Copies [code]src[/code] image to this image. </description> </method> <method name="create"> @@ -113,7 +117,7 @@ <argument index="3" name="format" type="int" enum="Image.Format"> </argument> <description> - Create an empty image of a specific size and format. + Creates an empty image of given size and format. See [code]FORMAT_*[/code] constants. If [code]use_mipmaps[/code] is true then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. </description> </method> <method name="create_from_data"> @@ -130,6 +134,7 @@ <argument index="4" name="data" type="PoolByteArray"> </argument> <description> + Creates a new image of given size and format. See [code]FORMAT_*[/code] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is true then generate mipmaps for this image. See the [code]generate_mipmaps[/code] method. </description> </method> <method name="crop"> @@ -140,24 +145,28 @@ <argument index="1" name="height" type="int"> </argument> <description> + Crops the image to the given [code]width[/code] and [code]height[/code]. If the specified size is larger than the current size, the extra area is filled with black pixels. </description> </method> <method name="decompress"> <return type="int" enum="Error"> </return> <description> + Decompresses the image if it is compressed. Returns an error if decompress function is not available. </description> </method> <method name="detect_alpha" qualifiers="const"> <return type="int" enum="Image.AlphaMode"> </return> <description> + Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are below a certain threshold or the maximum value. Returns ALPHA_NONE if no data for alpha values is found. </description> </method> <method name="expand_x2_hq2x"> <return type="void"> </return> <description> + Stretches the image and enlarges it by a factor of 2. No interpolation is done. </description> </method> <method name="fill"> @@ -166,52 +175,56 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Fills an [code]Image[/code] with a specified [Color] + Fills the image with a given [Color]. </description> </method> <method name="fix_alpha_edges"> <return type="void"> </return> <description> + Blends low-alpha pixels with nearby pixels. </description> </method> <method name="flip_x"> <return type="void"> </return> <description> + Flips the image horizontally. </description> </method> <method name="flip_y"> <return type="void"> </return> <description> + Flips the image vertically. </description> </method> <method name="generate_mipmaps"> <return type="int" enum="Error"> </return> <description> + Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution copies of the image. Mipmaps are automatically used if the image needs to be scaled down when rendered. This improves image quality and the performance of the rendering. Returns an error if the image is compressed, in a custom format or if the image's width/height is 0. </description> </method> <method name="get_data" qualifiers="const"> <return type="PoolByteArray"> </return> <description> - Return the raw data of the [code]Image[/code]. + Returns the image's raw data. </description> </method> <method name="get_format" qualifiers="const"> <return type="int" enum="Image.Format"> </return> <description> - Return the format of the [code]Image[/code], one of [code]Image[/code].FORMAT_*. + Returns the image's raw data. </description> </method> <method name="get_height" qualifiers="const"> <return type="int"> </return> <description> - Return the height of the [code]Image[/code]. + Returns the image's height. </description> </method> <method name="get_mipmap_offset" qualifiers="const"> @@ -220,6 +233,7 @@ <argument index="0" name="mipmap" type="int"> </argument> <description> + Returns the offset where the image's mipmap with index [code]mipmap[/code] is stored in the [code]data[/code] dictionary. </description> </method> <method name="get_pixel" qualifiers="const"> @@ -230,6 +244,7 @@ <argument index="1" name="y" type="int"> </argument> <description> + Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. </description> </method> <method name="get_rect" qualifiers="const"> @@ -238,51 +253,56 @@ <argument index="0" name="rect" type="Rect2"> </argument> <description> - Return a new [code]Image[/code] that is a copy of "area" in this [code]Image[/code]. + Returns a new image that is a copy of the image's area specified with [code]rect[/code]. </description> </method> <method name="get_size" qualifiers="const"> <return type="Vector2"> </return> <description> + Returns the image's size (width and height). </description> </method> <method name="get_used_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the area of this [code]Image[/code] that is used/visibly colored/opaque. + Returns a [Rect2] enclosing the visible portion of the image. </description> </method> <method name="get_width" qualifiers="const"> <return type="int"> </return> <description> - Return the width of the [code]Image[/code]. + Returns the image's width. </description> </method> <method name="has_mipmaps" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the image has generated mipmaps. </description> </method> <method name="is_compressed" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the image is compressed. </description> </method> <method name="is_empty" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the image has no data. </description> </method> <method name="is_invisible" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if all the image's pixels have an alpha value of 0. Returns [code]false[/code] if any pixel has an alpha value higher than 0. </description> </method> <method name="load"> @@ -291,25 +311,28 @@ <argument index="0" name="path" type="String"> </argument> <description> - Load an [code]Image[/code]. + Loads an image from file [code]path[/code]. </description> </method> <method name="lock"> <return type="void"> </return> <description> + Locks the data and prevents changes. </description> </method> <method name="normalmap_to_xy"> <return type="void"> </return> <description> + Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normalmap. A normalmap can add lots of detail to a 3D surface without increasing the polygon count. </description> </method> <method name="premultiply_alpha"> <return type="void"> </return> <description> + Multiplies color values with alpha values. Resulting color values for a pixel are [code](color * alpha)/256[/code]. </description> </method> <method name="resize"> @@ -322,6 +345,7 @@ <argument index="2" name="interpolation" type="int" enum="Image.Interpolation" default="1"> </argument> <description> + Resizes the image to the given [code]width[/code] and [code]height[/code]. New pixels are calculated using [code]interpolation[/code]. See [code]interpolation[/code] constants. </description> </method> <method name="resize_to_po2"> @@ -330,6 +354,7 @@ <argument index="0" name="square" type="bool" default="false"> </argument> <description> + Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. </description> </method> <method name="save_png" qualifiers="const"> @@ -338,7 +363,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Save this [code]Image[/code] as a png. + Saves the image as a PNG file to [code]path[/code]. </description> </method> <method name="set_pixel"> @@ -351,29 +376,43 @@ <argument index="2" name="color" type="Color"> </argument> <description> + Sets the [Color] of the pixel at [code](x, y)[/code] if the image is unlocked. Example: + [code] + var img = Image.new() + img.lock() + img.set_pixel(x, y, color) # Does not have an effect + img.unlock() + img.set_pixel(x, y, color) # Works + [/code]. </description> </method> <method name="shrink_x2"> <return type="void"> </return> <description> + Shrinks the image by a factor of 2. </description> </method> <method name="srgb_to_linear"> <return type="void"> </return> <description> + Converts the raw data from the sRGB colorspace to a linear scale. </description> </method> <method name="unlock"> <return type="void"> </return> <description> + Unlocks the data for writing access. </description> </method> </methods> <members> - <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + <member name="data" type="Dictionary"> + <description> + Holds all of the image's color data in a given format. See [code]FORMAT_*[/code] constants. + </description> </member> </members> <constants> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 50bff87a80..850f724714 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -17,14 +17,14 @@ <argument index="0" name="text" type="String"> </argument> <description> - Append text at cursor, scrolling the [code]LineEdit[/code] when needed. + Adds [code]text[/code] after the cursor. If the resulting value is longer than [member max_length], nothing happens. </description> </method> <method name="clear"> <return type="void"> </return> <description> - Clear the [code]LineEdit[/code] text. + Erases the [LineEdit] text. </description> </method> <method name="cursor_get_blink_enabled" qualifiers="const"> @@ -70,7 +70,7 @@ <return type="int"> </return> <description> - Return the cursor position inside the [code]LineEdit[/code]. + Returns the cursor position inside the [code]LineEdit[/code]. </description> </method> <method name="get_expand_to_text_length" qualifiers="const"> @@ -90,7 +90,7 @@ <return type="PopupMenu"> </return> <description> - Return the [PopupMenu] of this [code]LineEdit[/code]. + Returns the [PopupMenu] of this [code]LineEdit[/code]. By default, this menu is displayed when right-clicking on the [LineEdit]. </description> </method> <method name="get_placeholder" qualifiers="const"> @@ -134,7 +134,7 @@ <argument index="0" name="option" type="int"> </argument> <description> - Execute a given action as defined in the MENU_* enum. + Executes a given action as defined in the MENU_* enum. </description> </method> <method name="select"> @@ -145,11 +145,12 @@ <argument index="1" name="to" type="int" default="-1"> </argument> <description> - Select the text inside [code]LineEdit[/code] by the given character positions. [code]from[/code] is default to the beginning. [code]to[/code] is default to the end. + Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default [code]from[/code] is at the beginning and [code]to[/code] at the end. [codeblock] - select() # select all - select(5) # select from the fifth character to the end. - select(2, 5) # select from the second to the fifth character. + text = "Welcome" + select() # Welcome + select(4) # ome + select(2, 5) # lco [/codeblock] </description> </method> @@ -157,7 +158,7 @@ <return type="void"> </return> <description> - Select the whole string. + Selects the whole [String]. </description> </method> <method name="set_align"> @@ -175,7 +176,7 @@ <argument index="0" name="position" type="int"> </argument> <description> - Set the cursor position inside the [code]LineEdit[/code], causing it to scroll if needed. + Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed. </description> </method> <method name="set_editable"> @@ -243,26 +244,37 @@ </methods> <members> <member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align"> + Text alignment as defined in the ALIGN_* enum. </member> <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled"> + If [code]true[/code] the caret (visual cursor) blinks. </member> <member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed"> + Duration (in seconds) of a caret's blinking cycle. </member> <member name="editable" type="bool" setter="set_editable" getter="is_editable"> + If [code]false[/code] existing text cannot be modified and new text cannot be added. </member> <member name="expand_to_len" type="bool" setter="set_expand_to_text_length" getter="get_expand_to_text_length"> + If [code]true[/code] the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened. </member> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode"> + Defines how the [LineEdit] can grab focus (Keyboard and mouse, only keyboard, or none). See [code]enum FocusMode[/code] in [Control] for details. </member> <member name="max_length" type="int" setter="set_max_length" getter="get_max_length"> + Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit. </member> <member name="placeholder_alpha" type="float" setter="set_placeholder_alpha" getter="get_placeholder_alpha"> + Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code]. </member> <member name="placeholder_text" type="String" setter="set_placeholder" getter="get_placeholder"> + Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]). </member> <member name="secret" type="bool" setter="set_secret" getter="is_secret"> + If [code]true[/code] every character is shown as "*". </member> <member name="text" type="String" setter="set_text" getter="get_text"> + String value of the [LineEdit]. </member> </members> <signals> @@ -270,47 +282,47 @@ <argument index="0" name="text" type="String"> </argument> <description> - When the text changes, this signal is emitted. + Emitted when the text changes. </description> </signal> <signal name="text_entered"> <argument index="0" name="text" type="String"> </argument> <description> - This signal is emitted when the user presses KEY_ENTER on the [code]LineEdit[/code]. This signal is often used as an alternate confirmation mechanism in dialogs. + Emitted when the user presses KEY_ENTER on the [code]LineEdit[/code]. </description> </signal> </signals> <constants> <constant name="ALIGN_LEFT" value="0"> - Align left. + Aligns the text on the left hand side of the [LineEdit]. </constant> <constant name="ALIGN_CENTER" value="1"> - Align center. + Centers the text in the middle of the [LineEdit]. </constant> <constant name="ALIGN_RIGHT" value="2"> - Align right. + Aligns the text on the right hand side of the [LineEdit]. </constant> <constant name="ALIGN_FILL" value="3"> - Align fill. + Stretches whitespaces to fit the [LineEdit]'s width. </constant> <constant name="MENU_CUT" value="0"> - Cut (Copy and clear). + Cuts (Copies and clears) the selected text. </constant> <constant name="MENU_COPY" value="1"> - Copy the selected text. + Copies the selected text. </constant> <constant name="MENU_PASTE" value="2"> - Paste the clipboard text over the selected text. + Pastes the clipboard text over the selected text (or at the cursor's position). </constant> <constant name="MENU_CLEAR" value="3"> - Clear the text. + Erases the whole [Linedit] text. </constant> <constant name="MENU_SELECT_ALL" value="4"> - Select all text. + Selects the whole [Linedit] text. </constant> <constant name="MENU_UNDO" value="5"> - Undo an action. + Undoes the previous action. </constant> <constant name="MENU_MAX" value="6"> </constant> 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/ParallaxLayer.xml b/doc/classes/ParallaxLayer.xml index 8de7e05578..f1e6f9e046 100644 --- a/doc/classes/ParallaxLayer.xml +++ b/doc/classes/ParallaxLayer.xml @@ -64,7 +64,7 @@ The ParallaxLayer's [Texture] mirroring. Useful for creating an infinite scrolling background. If an axis is set to [code]0[/code] the [Texture] will not be mirrored. Default value: [code](0, 0)[/code]. </member> <member name="motion_offset" type="Vector2" setter="set_motion_offset" getter="get_motion_offset"> - The ParallaxLayer's offset relative to the parent ParallaxBackground's [member ParallaxBackground.scroll_offset]. + The ParallaxLayer's offset relative to the parent ParallaxBackground's [member ParallaxBackground.scroll_offset]. </member> <member name="motion_scale" type="Vector2" setter="set_motion_scale" getter="get_motion_scale"> Multiplies the ParallaxLayer's motion. If an axis is set to [code]0[/code] it will not scroll. diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index d351cdfbc0..056d7d10fa 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -127,7 +127,7 @@ <argument index="1" name="t" type="float"> </argument> <description> - Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°. + Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°. </description> </method> <method name="xform"> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index fc96a183eb..3f999f7fe2 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -85,6 +85,14 @@ Returns the collision mask for this ray. </description> </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3"> </return> @@ -156,6 +164,16 @@ Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_enabled"> <return type="void"> </return> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 8fef07a859..45a83f7ded 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -84,6 +84,14 @@ Returns the collision mask for this ray. </description> </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2"> </return> @@ -162,6 +170,16 @@ Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_enabled"> <return type="void"> </return> 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> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 9a500af347..43e5158515 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -239,6 +239,12 @@ Returns true if highlight all occurrences is enabled. </description> </method> + <method name="is_highlight_current_line_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_overriding_selected_font_color" qualifiers="const"> <return type="bool"> </return> @@ -340,6 +346,14 @@ Set to enable highlighting all occurrences of the current selection. </description> </method> + <method name="set_highlight_current_line"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_max_chars"> <return type="void"> </return> @@ -435,6 +449,8 @@ </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> </member> + <member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled"> + </member> <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> </member> <member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled"> |