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

doc: Sync classref with current source

Browse Source 
Bind missing enums.
This commit is contained in:
Rémi Verschelde 2020-09-11 12:22:10 +02:00
parent 9d9ee2d4c2
commit a2a78a8066
No known key found for this signature in database
GPG Key ID: C3336907360768E1
17 changed files with 622 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

203
doc/classes/CodeEdit.xml Normal file
View File

@ -0,0 +1,203 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CodeEdit" inherits="TextEdit" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear_bookmarked_lines">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_breakpointed_lines">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_executing_lines">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_bookmarked_lines" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_breakpointed_lines" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_executing_lines" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="is_line_bookmarked" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</method>
<method name="is_line_breakpointed" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</method>
<method name="is_line_executing" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</method>
<method name="set_line_as_bookmarked">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="bookmarked" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_line_as_breakpoint">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="breakpointed" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_line_as_executing">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="executing" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="draw_bookmarks" type="bool" setter="set_draw_bookmarks_gutter" getter="is_drawing_bookmarks_gutter" default="false">
</member>
<member name="draw_breakpoints_gutter" type="bool" setter="set_draw_breakpoints_gutter" getter="is_drawing_breakpoints_gutter" default="false">
</member>
<member name="draw_executing_lines" type="bool" setter="set_draw_executing_lines_gutter" getter="is_drawing_executing_lines_gutter" default="false">
</member>
<member name="draw_fold_gutter" type="bool" setter="set_draw_fold_gutter" getter="is_drawing_fold_gutter" default="false">
</member>
<member name="draw_line_numbers" type="bool" setter="set_draw_line_numbers" getter="is_draw_line_numbers_enabled" default="false">
</member>
<member name="zero_pad_line_numbers" type="bool" setter="set_line_numbers_zero_padded" getter="is_line_numbers_zero_padded" default="false">
</member>
</members>
<signals>
<signal name="breakpoint_toggled">
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
</constants>
<theme_items>
<theme_item name="background_color" type="Color" default="Color( 0, 0, 0, 0 )">
</theme_item>
<theme_item name="bookmark" type="Texture2D">
</theme_item>
<theme_item name="bookmark_color" type="Color" default="Color( 0.5, 0.64, 1, 0.8 )">
</theme_item>
<theme_item name="brace_mismatch_color" type="Color" default="Color( 1, 0.2, 0.2, 1 )">
</theme_item>
<theme_item name="breakpoint" type="Texture2D">
</theme_item>
<theme_item name="breakpoint_color" type="Color" default="Color( 0.9, 0.29, 0.3, 1 )">
</theme_item>
<theme_item name="can_fold" type="Texture2D">
</theme_item>
<theme_item name="caret_background_color" type="Color" default="Color( 0, 0, 0, 1 )">
</theme_item>
<theme_item name="caret_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
</theme_item>
<theme_item name="code_folding_color" type="Color" default="Color( 0.8, 0.8, 0.8, 0.8 )">
</theme_item>
<theme_item name="completion" type="StyleBox">
</theme_item>
<theme_item name="completion_background_color" type="Color" default="Color( 0.17, 0.16, 0.2, 1 )">
</theme_item>
<theme_item name="completion_existing_color" type="Color" default="Color( 0.87, 0.87, 0.87, 0.13 )">
</theme_item>
<theme_item name="completion_font_color" type="Color" default="Color( 0.67, 0.67, 0.67, 1 )">
</theme_item>
<theme_item name="completion_lines" type="int" default="7">
</theme_item>
<theme_item name="completion_max_width" type="int" default="50">
</theme_item>
<theme_item name="completion_scroll_color" type="Color" default="Color( 1, 1, 1, 1 )">
</theme_item>
<theme_item name="completion_scroll_width" type="int" default="3">
</theme_item>
<theme_item name="completion_selected_color" type="Color" default="Color( 0.26, 0.26, 0.27, 1 )">
</theme_item>
<theme_item name="current_line_color" type="Color" default="Color( 0.25, 0.25, 0.26, 0.8 )">
</theme_item>
<theme_item name="executing_line" type="Texture2D">
</theme_item>
<theme_item name="executing_line_color" type="Color" default="Color( 0.98, 0.89, 0.27, 1 )">
</theme_item>
<theme_item name="focus" type="StyleBox">
</theme_item>
<theme_item name="folded" type="Texture2D">
</theme_item>
<theme_item name="font" type="Font">
</theme_item>
<theme_item name="font_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
</theme_item>
<theme_item name="font_color_readonly" type="Color" default="Color( 0.88, 0.88, 0.88, 0.5 )">
</theme_item>
<theme_item name="font_color_selected" type="Color" default="Color( 0, 0, 0, 1 )">
</theme_item>
<theme_item name="line_number_color" type="Color" default="Color( 0.67, 0.67, 0.67, 0.4 )">
</theme_item>
<theme_item name="line_spacing" type="int" default="4">
</theme_item>
<theme_item name="mark_color" type="Color" default="Color( 1, 0.4, 0.4, 0.4 )">
</theme_item>
<theme_item name="normal" type="StyleBox">
</theme_item>
<theme_item name="read_only" type="StyleBox">
</theme_item>
<theme_item name="safe_line_number_color" type="Color" default="Color( 0.67, 0.78, 0.67, 0.6 )">
</theme_item>
<theme_item name="selection_color" type="Color" default="Color( 0.49, 0.49, 0.49, 1 )">
</theme_item>
<theme_item name="space" type="Texture2D">
</theme_item>
<theme_item name="tab" type="Texture2D">
</theme_item>
<theme_item name="word_highlighted_color" type="Color" default="Color( 0.8, 0.9, 0.9, 0.15 )">
</theme_item>
</theme_items>
</class>

28
doc/classes/GPUParticles3D.xml
View File

@ -18,6 +18,22 @@
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="emit_particle">
<return type="void">
</return>
<argument index="0" name="xform" type="Transform">
</argument>
<argument index="1" name="velocity" type="Vector3">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<argument index="3" name="custom" type="Color">
</argument>
<argument index="4" name="flags" type="int">
</argument>
<description>
</description>
</method>
<method name="get_draw_pass_mesh" qualifiers="const"> <method name="get_draw_pass_mesh" qualifiers="const">
<return type="Mesh"> <return type="Mesh">
</return> </return>
@ -101,6 +117,8 @@
<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0"> <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0">
Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.
</member> </member>
<member name="sub_emitter" type="NodePath" setter="set_sub_emitter" getter="get_sub_emitter" default="NodePath(&quot;&quot;)">
</member>
<member name="visibility_aabb" type="AABB" setter="set_visibility_aabb" getter="get_visibility_aabb" default="AABB( -4, -4, -4, 8, 8, 8 )"> <member name="visibility_aabb" type="AABB" setter="set_visibility_aabb" getter="get_visibility_aabb" default="AABB( -4, -4, -4, 8, 8, 8 )">
The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active. The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active.
</member> </member>
@ -115,6 +133,16 @@
<constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder"> <constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder">
Particles are drawn in order of depth. Particles are drawn in order of depth.
</constant> </constant>
<constant name="EMIT_FLAG_POSITION" value="1" enum="EmitFlags">
</constant>
<constant name="EMIT_FLAG_ROTATION_SCALE" value="2" enum="EmitFlags">
</constant>
<constant name="EMIT_FLAG_VELOCITY" value="4" enum="EmitFlags">
</constant>
<constant name="EMIT_FLAG_COLOR" value="8" enum="EmitFlags">
</constant>
<constant name="EMIT_FLAG_CUSTOM" value="16" enum="EmitFlags">
</constant>
<constant name="MAX_DRAW_PASSES" value="4"> <constant name="MAX_DRAW_PASSES" value="4">
Maximum number of draw passes supported. Maximum number of draw passes supported.
</constant> </constant>

26
doc/classes/HTTPRequest.xml
View File

@ -135,7 +135,7 @@
</argument> </argument>
<argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0"> <argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0">
</argument> </argument>
<argument index="4" name="request_data_raw" type="PackedByteArray" default="PackedByteArray()"> <argument index="4" name="request_data_raw" type="PackedByteArray" default="PackedByteArray( )">
</argument> </argument>
<description> <description>
Creates request on the underlying [HTTPClient] using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. Creates request on the underlying [HTTPClient] using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
@ -144,6 +144,12 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="accept_gzip" type="bool" setter="set_accept_gzip" getter="is_accepting_gzip" default="true">
If [code]true[/code], this header will be added to each request: [code]Accept-Encoding: gzip, deflate[/code] telling servers that it's okay to compress response bodies.
Any Reponse body declaring a [code]Content-Encoding[/code] of either [code]gzip[/code] or [code]deflate[/code] will then be automatically decompressed, and the uncompressed bytes will be delivered via [code]request_completed[/code].
If the user has specified their own [code]Accept-Encoding[/code] header, then no header will be added regaurdless of [code]accept_gzip[/code].
If [code]false[/code] no header will be added, and no decompression will be performed on response bodies. The raw bytes of the response body will be returned via [code]request_completed[/code].
</member>
<member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit" default="-1"> <member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit" default="-1">
Maximum allowed size for response bodies. If the response body is compressed, this will be used as the maximum allowed size for the decompressed body. Maximum allowed size for response bodies. If the response body is compressed, this will be used as the maximum allowed size for the decompressed body.
</member> </member>
@ -162,12 +168,6 @@
<member name="use_threads" type="bool" setter="set_use_threads" getter="is_using_threads" default="false"> <member name="use_threads" type="bool" setter="set_use_threads" getter="is_using_threads" default="false">
If [code]true[/code], multithreading is used to improve performance. If [code]true[/code], multithreading is used to improve performance.
</member> </member>
<member name="accept_gzip" type="bool" setter="set_accept_gzip" getter="is_accepting_gzip" default="true">
If [code]true[/code], this header will be added to each request: [code]Accept-Encoding: gzip, deflate[/code] telling servers that it's okay to compress response bodies.
Any Reponse body declaring a [code]Content-Encoding[/code] of either [code]gzip[/code] or [code]deflate[/code] will then be automatically decompressed, and the uncompressed bytes will be delivered via [code]request_completed[/code].
If the user has specified their own [code]Accept-Encoding[/code] header, then no header will be added regaurdless of [code]accept_gzip[/code].
If [code]false[/code] no header will be added, and no decompression will be performed on response bodies. The raw bytes of the response body will be returned via [code]request_completed[/code].
</member>
</members> </members>
<signals> <signals>
<signal name="request_completed"> <signal name="request_completed">
@ -208,19 +208,21 @@
<constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7" enum="Result"> <constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7" enum="Result">
Request exceeded its maximum size limit, see [member body_size_limit]. Request exceeded its maximum size limit, see [member body_size_limit].
</constant> </constant>
<constant name="RESULT_REQUEST_FAILED" value="8" enum="Result"> <constant name="RESULT_BODY_DECOMPRESS_FAILED" value="8" enum="Result">
</constant>
<constant name="RESULT_REQUEST_FAILED" value="9" enum="Result">
Request failed (currently unused). Request failed (currently unused).
</constant> </constant>
<constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9" enum="Result"> <constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="10" enum="Result">
HTTPRequest couldn't open the download file. HTTPRequest couldn't open the download file.
</constant> </constant>
<constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10" enum="Result"> <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="11" enum="Result">
HTTPRequest couldn't write to the download file. HTTPRequest couldn't write to the download file.
</constant> </constant>
<constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11" enum="Result"> <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="12" enum="Result">
Request reached its maximum redirect limit, see [member max_redirects]. Request reached its maximum redirect limit, see [member max_redirects].
</constant> </constant>
<constant name="RESULT_TIMEOUT" value="12" enum="Result"> <constant name="RESULT_TIMEOUT" value="13" enum="Result">
</constant> </constant>
</constants> </constants>
</class> </class>

39
doc/classes/ImageTexture3D.xml Normal file
View File

@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ImageTexture3D" inherits="Texture3D" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="create">
<return type="int" enum="Error">
</return>
<argument index="0" name="format" type="int" enum="Image.Format">
</argument>
<argument index="1" name="width" type="int">
</argument>
<argument index="2" name="height" type="int">
</argument>
<argument index="3" name="depth" type="int">
</argument>
<argument index="4" name="use_mipmaps" type="bool">
</argument>
<argument index="5" name="data" type="Image[]">
</argument>
<description>
</description>
</method>
<method name="update">
<return type="void">
</return>
<argument index="0" name="data" type="Image[]">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

2
doc/classes/PackedByteArray.xml
View File

@ -60,7 +60,7 @@
<method name="decompress_dynamic"> <method name="decompress_dynamic">
<return type="PackedByteArray"> <return type="PackedByteArray">
</return> </return>
<argument index="0" name="max_output_size" type="int" default="0"> <argument index="0" name="max_output_size" type="int">
</argument> </argument>
<argument index="1" name="compression_mode" type="int" default="0"> <argument index="1" name="compression_mode" type="int" default="0">
</argument> </argument>

27
doc/classes/ParticlesMaterial.xml
View File

@ -243,6 +243,14 @@
<member name="spread" type="float" setter="set_spread" getter="get_spread" default="45.0"> <member name="spread" type="float" setter="set_spread" getter="get_spread" default="45.0">
Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes. Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes.
</member> </member>
<member name="sub_emitter_amount_at_end" type="int" setter="set_sub_emitter_amount_at_end" getter="get_sub_emitter_amount_at_end">
</member>
<member name="sub_emitter_frequency" type="float" setter="set_sub_emitter_frequency" getter="get_sub_emitter_frequency">
</member>
<member name="sub_emitter_keep_velocity" type="bool" setter="set_sub_emitter_keep_velocity" getter="get_sub_emitter_keep_velocity" default="false">
</member>
<member name="sub_emitter_mode" type="int" setter="set_sub_emitter_mode" getter="get_sub_emitter_mode" enum="ParticlesMaterial.SubEmitterMode" default="0">
</member>
<member name="tangential_accel" type="float" setter="set_param" getter="get_param" default="0.0"> <member name="tangential_accel" type="float" setter="set_param" getter="get_param" default="0.0">
Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
</member> </member>
@ -252,15 +260,6 @@
<member name="tangential_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0"> <member name="tangential_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
Tangential acceleration randomness ratio. Tangential acceleration randomness ratio.
</member> </member>
<member name="trail_color_modifier" type="GradientTexture" setter="set_trail_color_modifier" getter="get_trail_color_modifier">
Trail particles' color will vary along this [GradientTexture].
</member>
<member name="trail_divisor" type="int" setter="set_trail_divisor" getter="get_trail_divisor" default="1">
Emitter will emit [code]amount[/code] divided by [code]trail_divisor[/code] particles. The remaining particles will be used as trail(s).
</member>
<member name="trail_size_modifier" type="CurveTexture" setter="set_trail_size_modifier" getter="get_trail_size_modifier">
Trail particles' size will vary along this [CurveTexture].
</member>
</members> </members>
<constants> <constants>
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter"> <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
@ -332,5 +331,15 @@
<constant name="EMISSION_SHAPE_MAX" value="5" enum="EmissionShape"> <constant name="EMISSION_SHAPE_MAX" value="5" enum="EmissionShape">
Represents the size of the [enum EmissionShape] enum. Represents the size of the [enum EmissionShape] enum.
</constant> </constant>
<constant name="SUB_EMITTER_DISABLED" value="0" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_CONSTANT" value="1" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_AT_END" value="2" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_AT_COLLISION" value="3" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_MAX" value="4" enum="SubEmitterMode">
</constant>
</constants> </constants>
</class> </class>

6
doc/classes/RayCast2D.xml
View File

@ -123,9 +123,6 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2( 0, 50 )">
The ray's destination point, relative to the RayCast's [code]position[/code].
</member>
<member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">
If [code]true[/code], collision with [Area2D]s will be reported. If [code]true[/code], collision with [Area2D]s will be reported.
</member> </member>
@ -141,6 +138,9 @@
<member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true"> <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true">
If [code]true[/code], the parent node will be excluded from collision detection. If [code]true[/code], the parent node will be excluded from collision detection.
</member> </member>
<member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2( 0, 50 )">
The ray's destination point, relative to the RayCast's [code]position[/code].
</member>
</members> </members>
<constants> <constants>
</constants> </constants>

6
doc/classes/RayCast3D.xml
View File

@ -126,9 +126,6 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="target_position" type="Vector3" setter="set_target_position" getter="get_target_position" default="Vector3( 0, -1, 0 )">
The ray's destination point, relative to the RayCast's [code]position[/code].
</member>
<member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">
If [code]true[/code], collision with [Area3D]s will be reported. If [code]true[/code], collision with [Area3D]s will be reported.
</member> </member>
@ -144,6 +141,9 @@
<member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true"> <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true">
If [code]true[/code], collisions will be ignored for this RayCast3D's immediate parent. If [code]true[/code], collisions will be ignored for this RayCast3D's immediate parent.
</member> </member>
<member name="target_position" type="Vector3" setter="set_target_position" getter="get_target_position" default="Vector3( 0, -1, 0 )">
The ray's destination point, relative to the RayCast's [code]position[/code].
</member>
</members> </members>
<constants> <constants>
</constants> </constants>

2
doc/classes/SpriteFrames.xml
View File

@ -54,7 +54,7 @@
<argument index="0" name="anim" type="StringName"> <argument index="0" name="anim" type="StringName">
</argument> </argument>
<description> <description>
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code]. Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].
</description> </description>
</method> </method>
<method name="get_animation_names" qualifiers="const"> <method name="get_animation_names" qualifiers="const">

25
doc/classes/StreamTexture3D.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamTexture3D" inherits="Texture3D" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="load">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="load_path" type="String" setter="load" getter="get_load_path" default="&quot;&quot;">
</member>
</members>
<constants>
</constants>
</class>

310
doc/classes/TextEdit.xml
View File

@ -9,6 +9,14 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="add_gutter">
<return type="void">
</return>
<argument index="0" name="at" type="int" default="-1">
</argument>
<description>
</description>
</method>
<method name="can_fold" qualifiers="const"> <method name="can_fold" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
@ -112,11 +120,34 @@
Folds the given line, if possible (see [method can_fold]). Folds the given line, if possible (see [method can_fold]).
</description> </description>
</method> </method>
<method name="get_breakpoints" qualifiers="const"> <method name="get_gutter_count" qualifiers="const">
<return type="Array"> <return type="int">
</return> </return>
<description> <description>
Returns an array containing the line number of each breakpoint. </description>
</method>
<method name="get_gutter_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="get_gutter_type" qualifiers="const">
<return type="int" enum="TextEdit.GutterType">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="get_gutter_width" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<description>
</description> </description>
</method> </method>
<method name="get_line" qualifiers="const"> <method name="get_line" qualifiers="const">
@ -135,6 +166,46 @@
Returns the amount of total lines in the text. Returns the amount of total lines in the text.
</description> </description>
</method> </method>
<method name="get_line_gutter_icon" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="get_line_gutter_item_color">
<return type="Color">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="get_line_gutter_metadata" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="get_line_gutter_text" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="get_menu" qualifiers="const"> <method name="get_menu" qualifiers="const">
<return type="PopupMenu"> <return type="PopupMenu">
</return> </return>
@ -202,6 +273,40 @@
Returns whether the line at the specified index is folded or not. Returns whether the line at the specified index is folded or not.
</description> </description>
</method> </method>
<method name="is_gutter_clickable" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="is_gutter_drawn" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="is_gutter_overwritable" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="is_line_gutter_clickable" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<description>
</description>
</method>
<method name="is_line_hidden" qualifiers="const"> <method name="is_line_hidden" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
@ -241,11 +346,12 @@
Perform redo operation. Perform redo operation.
</description> </description>
</method> </method>
<method name="remove_breakpoints"> <method name="remove_gutter">
<return type="void"> <return type="void">
</return> </return>
<argument index="0" name="gutter" type="int">
</argument>
<description> <description>
Removes all the breakpoints. This will not fire the [signal breakpoint_toggled] signal.
</description> </description>
</method> </method>
<method name="search" qualifiers="const"> <method name="search" qualifiers="const">
@ -295,6 +401,78 @@
If [member selecting_enabled] is [code]false[/code], no selection will occur. If [member selecting_enabled] is [code]false[/code], no selection will occur.
</description> </description>
</method> </method>
<method name="set_gutter_clickable">
<return type="void">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<argument index="1" name="clickable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_gutter_custom_draw">
<return type="void">
</return>
<argument index="0" name="column" type="int">
</argument>
<argument index="1" name="object" type="Object">
</argument>
<argument index="2" name="callback" type="StringName">
</argument>
<description>
</description>
</method>
<method name="set_gutter_draw">
<return type="void">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<argument index="1" name="draw" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_gutter_name">
<return type="void">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<argument index="1" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_gutter_overwritable">
<return type="void">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<argument index="1" name="overwritable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_gutter_type">
<return type="void">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<argument index="1" name="type" type="int" enum="TextEdit.GutterType">
</argument>
<description>
</description>
</method>
<method name="set_gutter_width">
<return type="void">
</return>
<argument index="0" name="gutter" type="int">
</argument>
<argument index="1" name="width" type="int">
</argument>
<description>
</description>
</method>
<method name="set_line"> <method name="set_line">
<return type="void"> <return type="void">
</return> </return>
@ -317,6 +495,66 @@
If [code]true[/code], hides the line of the specified index. If [code]true[/code], hides the line of the specified index.
</description> </description>
</method> </method>
<method name="set_line_gutter_clickable">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<argument index="2" name="clickable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_line_gutter_icon">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<argument index="2" name="icon" type="Texture2D">
</argument>
<description>
</description>
</method>
<method name="set_line_gutter_item_color">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<description>
</description>
</method>
<method name="set_line_gutter_metadata">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<argument index="2" name="metadata" type="Variant">
</argument>
<description>
</description>
</method>
<method name="set_line_gutter_text">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="gutter" type="int">
</argument>
<argument index="2" name="text" type="String">
</argument>
<description>
</description>
</method>
<method name="toggle_fold_line"> <method name="toggle_fold_line">
<return type="void"> <return type="void">
</return> </return>
@ -351,9 +589,6 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="breakpoint_gutter" type="bool" setter="set_breakpoint_gutter_enabled" getter="is_breakpoint_gutter_enabled" default="false">
If [code]true[/code], the breakpoint gutter is visible.
</member>
<member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled" default="false"> <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled" default="false">
If [code]true[/code], the caret (visual cursor) blinks. If [code]true[/code], the caret (visual cursor) blinks.
</member> </member>
@ -378,9 +613,6 @@
If [code]true[/code], the "tab" character will have a visible representation. If [code]true[/code], the "tab" character will have a visible representation.
</member> </member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" /> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" />
<member name="fold_gutter" type="bool" setter="set_draw_fold_gutter" getter="is_drawing_fold_gutter" default="false">
If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines.
</member>
<member name="hiding_enabled" type="bool" setter="set_hiding_enabled" getter="is_hiding_enabled" default="false"> <member name="hiding_enabled" type="bool" setter="set_hiding_enabled" getter="is_hiding_enabled" default="false">
If [code]true[/code], all lines that have been set to hidden by [method set_line_as_hidden], will not be visible. If [code]true[/code], all lines that have been set to hidden by [method set_line_as_hidden], will not be visible.
</member> </member>
@ -416,9 +648,6 @@
<member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true"> <member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true">
If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled. If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled.
</member> </member>
<member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled" default="false">
If [code]true[/code], line numbers are displayed to the left of the text.
</member>
<member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled" default="false"> <member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled" default="false">
If [code]true[/code], sets the [code]step[/code] of the scrollbars to [code]0.25[/code] which results in smoother scrolling. If [code]true[/code], sets the [code]step[/code] of the scrollbars to [code]0.25[/code] which results in smoother scrolling.
</member> </member>
@ -438,30 +667,32 @@
</member> </member>
</members> </members>
<signals> <signals>
<signal name="breakpoint_toggled">
<argument index="0" name="row" type="int">
</argument>
<description>
Emitted when a breakpoint is placed via the breakpoint gutter.
</description>
</signal>
<signal name="cursor_changed"> <signal name="cursor_changed">
<description> <description>
Emitted when the cursor changes. Emitted when the cursor changes.
</description> </description>
</signal> </signal>
<signal name="info_clicked"> <signal name="gutter_added">
<argument index="0" name="row" type="int">
</argument>
<argument index="1" name="info" type="String">
</argument>
<description> <description>
Emitted when the info icon is clicked.
</description> </description>
</signal> </signal>
<signal name="line_edited_from"> <signal name="gutter_clicked">
<argument index="0" name="line" type="int"> <argument index="0" name="line" type="int">
</argument> </argument>
<argument index="1" name="gutter" type="int">
</argument>
<description>
</description>
</signal>
<signal name="gutter_removed">
<description>
</description>
</signal>
<signal name="lines_edited_from">
<argument index="0" name="from_line" type="int">
</argument>
<argument index="1" name="to_line" type="int">
</argument>
<description> <description>
</description> </description>
</signal> </signal>
@ -501,6 +732,12 @@
<constant name="SEARCH_BACKWARDS" value="4" enum="SearchFlags"> <constant name="SEARCH_BACKWARDS" value="4" enum="SearchFlags">
Search from end to beginning. Search from end to beginning.
</constant> </constant>
<constant name="GUTTER_TYPE_STRING" value="0" enum="GutterType">
</constant>
<constant name="GUTTER_TPYE_ICON" value="1" enum="GutterType">
</constant>
<constant name="GUTTER_TPYE_CUSTOM" value="2" enum="GutterType">
</constant>
<constant name="MENU_CUT" value="0" enum="MenuItems"> <constant name="MENU_CUT" value="0" enum="MenuItems">
Cuts (copies and clears) the selected text. Cuts (copies and clears) the selected text.
</constant> </constant>
@ -530,14 +767,8 @@
<theme_item name="background_color" type="Color" default="Color( 0, 0, 0, 0 )"> <theme_item name="background_color" type="Color" default="Color( 0, 0, 0, 0 )">
Sets the background [Color] of this [TextEdit]. [member syntax_highlighting] has to be enabled. Sets the background [Color] of this [TextEdit]. [member syntax_highlighting] has to be enabled.
</theme_item> </theme_item>
<theme_item name="bookmark_color" type="Color" default="Color( 0.08, 0.49, 0.98, 1 )">
Sets the [Color] of the bookmark marker. [member syntax_highlighting] has to be enabled.
</theme_item>
<theme_item name="brace_mismatch_color" type="Color" default="Color( 1, 0.2, 0.2, 1 )"> <theme_item name="brace_mismatch_color" type="Color" default="Color( 1, 0.2, 0.2, 1 )">
</theme_item> </theme_item>
<theme_item name="breakpoint_color" type="Color" default="Color( 0.8, 0.8, 0.4, 0.2 )">
Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled.
</theme_item>
<theme_item name="caret_background_color" type="Color" default="Color( 0, 0, 0, 1 )"> <theme_item name="caret_background_color" type="Color" default="Color( 0, 0, 0, 1 )">
</theme_item> </theme_item>
<theme_item name="caret_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )"> <theme_item name="caret_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
@ -565,14 +796,8 @@
<theme_item name="current_line_color" type="Color" default="Color( 0.25, 0.25, 0.26, 0.8 )"> <theme_item name="current_line_color" type="Color" default="Color( 0.25, 0.25, 0.26, 0.8 )">
Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled. Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled.
</theme_item> </theme_item>
<theme_item name="executing_line_color" type="Color" default="Color( 0.2, 0.8, 0.2, 0.4 )">
</theme_item>
<theme_item name="focus" type="StyleBox"> <theme_item name="focus" type="StyleBox">
</theme_item> </theme_item>
<theme_item name="fold" type="Texture2D">
</theme_item>
<theme_item name="folded" type="Texture2D">
</theme_item>
<theme_item name="font" type="Font"> <theme_item name="font" type="Font">
Sets the default [Font]. Sets the default [Font].
</theme_item> </theme_item>
@ -584,9 +809,6 @@
<theme_item name="font_color_selected" type="Color" default="Color( 0, 0, 0, 1 )"> <theme_item name="font_color_selected" type="Color" default="Color( 0, 0, 0, 1 )">
Sets the [Color] of the selected text. [member override_selected_font_color] has to be enabled. Sets the [Color] of the selected text. [member override_selected_font_color] has to be enabled.
</theme_item> </theme_item>
<theme_item name="line_number_color" type="Color" default="Color( 0.67, 0.67, 0.67, 0.4 )">
Sets the [Color] of the line numbers. [member show_line_numbers] has to be enabled.
</theme_item>
<theme_item name="line_spacing" type="int" default="4"> <theme_item name="line_spacing" type="int" default="4">
Sets the spacing between the lines. Sets the spacing between the lines.
</theme_item> </theme_item>
@ -599,8 +821,6 @@
<theme_item name="read_only" type="StyleBox"> <theme_item name="read_only" type="StyleBox">
Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled. Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled.
</theme_item> </theme_item>
<theme_item name="safe_line_number_color" type="Color" default="Color( 0.67, 0.78, 0.67, 0.6 )">
</theme_item>
<theme_item name="selection_color" type="Color" default="Color( 0.49, 0.49, 0.49, 1 )"> <theme_item name="selection_color" type="Color" default="Color( 0.49, 0.49, 0.49, 1 )">
Sets the highlight [Color] of text selections. Sets the highlight [Color] of text selections.
</theme_item> </theme_item>

9
doc/classes/VisualShader.xml
View File

@ -209,10 +209,13 @@
<constant name="TYPE_LIGHT" value="2" enum="Type"> <constant name="TYPE_LIGHT" value="2" enum="Type">
A shader for light calculations. A shader for light calculations.
</constant> </constant>
<constant name="TYPE_COMPUTE" value="3" enum="Type"> <constant name="TYPE_EMIT" value="3" enum="Type">
A compute shader, to use the GPU for abstract computation.
</constant> </constant>
<constant name="TYPE_MAX" value="4" enum="Type"> <constant name="TYPE_PROCESS" value="4" enum="Type">
</constant>
<constant name="TYPE_END" value="5" enum="Type">
</constant>
<constant name="TYPE_MAX" value="6" enum="Type">
Represents the size of the [enum Type] enum. Represents the size of the [enum Type] enum.
</constant> </constant>
<constant name="NODE_ID_INVALID" value="-1"> <constant name="NODE_ID_INVALID" value="-1">

6
doc/classes/VisualShaderNode.xml
View File

@ -57,6 +57,12 @@
Emitted when the node requests an editor refresh. Currently called only in setter of [member VisualShaderNodeTexture.source], [VisualShaderNodeTexture], and [VisualShaderNodeCubemap] (and their derivatives). Emitted when the node requests an editor refresh. Currently called only in setter of [member VisualShaderNodeTexture.source], [VisualShaderNodeTexture], and [VisualShaderNodeCubemap] (and their derivatives).
</description> </description>
</signal> </signal>
<signal name="show_port_preview">
<argument index="0" name="port_id" type="int">
</argument>
<description>
</description>
</signal>
</signals> </signals>
<constants> <constants>
<constant name="PORT_TYPE_SCALAR" value="0" enum="PortType"> <constant name="PORT_TYPE_SCALAR" value="0" enum="PortType">

1
scene/main/http_request.cpp
View File

@ -631,6 +631,7 @@ void HTTPRequest::_bind_methods() {
BIND_ENUM_CONSTANT(RESULT_SSL_HANDSHAKE_ERROR); BIND_ENUM_CONSTANT(RESULT_SSL_HANDSHAKE_ERROR);
BIND_ENUM_CONSTANT(RESULT_NO_RESPONSE); BIND_ENUM_CONSTANT(RESULT_NO_RESPONSE);
BIND_ENUM_CONSTANT(RESULT_BODY_SIZE_LIMIT_EXCEEDED); BIND_ENUM_CONSTANT(RESULT_BODY_SIZE_LIMIT_EXCEEDED);
BIND_ENUM_CONSTANT(RESULT_BODY_DECOMPRESS_FAILED);
BIND_ENUM_CONSTANT(RESULT_REQUEST_FAILED); BIND_ENUM_CONSTANT(RESULT_REQUEST_FAILED);
BIND_ENUM_CONSTANT(RESULT_DOWNLOAD_FILE_CANT_OPEN); BIND_ENUM_CONSTANT(RESULT_DOWNLOAD_FILE_CANT_OPEN);
BIND_ENUM_CONSTANT(RESULT_DOWNLOAD_FILE_WRITE_ERROR); BIND_ENUM_CONSTANT(RESULT_DOWNLOAD_FILE_WRITE_ERROR);

6
scene/resources/particles_material.cpp
View File

@ -1246,6 +1246,12 @@ void ParticlesMaterial::_bind_methods() {
BIND_ENUM_CONSTANT(EMISSION_SHAPE_POINTS); BIND_ENUM_CONSTANT(EMISSION_SHAPE_POINTS);
BIND_ENUM_CONSTANT(EMISSION_SHAPE_DIRECTED_POINTS); BIND_ENUM_CONSTANT(EMISSION_SHAPE_DIRECTED_POINTS);
BIND_ENUM_CONSTANT(EMISSION_SHAPE_MAX); BIND_ENUM_CONSTANT(EMISSION_SHAPE_MAX);
BIND_ENUM_CONSTANT(SUB_EMITTER_DISABLED);
BIND_ENUM_CONSTANT(SUB_EMITTER_CONSTANT);
BIND_ENUM_CONSTANT(SUB_EMITTER_AT_END);
BIND_ENUM_CONSTANT(SUB_EMITTER_AT_COLLISION);
BIND_ENUM_CONSTANT(SUB_EMITTER_MAX);
} }
ParticlesMaterial::ParticlesMaterial() : ParticlesMaterial::ParticlesMaterial() :

1
scene/resources/particles_material.h
View File

@ -50,7 +50,6 @@ class ParticlesMaterial : public Material {
public: public:
enum Parameter { enum Parameter {
PARAM_INITIAL_LINEAR_VELOCITY, PARAM_INITIAL_LINEAR_VELOCITY,
PARAM_ANGULAR_VELOCITY, PARAM_ANGULAR_VELOCITY,
PARAM_ORBIT_VELOCITY, PARAM_ORBIT_VELOCITY,

3
scene/resources/visual_shader.cpp
View File

@ -1638,6 +1638,9 @@ void VisualShader::_bind_methods() {
BIND_ENUM_CONSTANT(TYPE_VERTEX); BIND_ENUM_CONSTANT(TYPE_VERTEX);
BIND_ENUM_CONSTANT(TYPE_FRAGMENT); BIND_ENUM_CONSTANT(TYPE_FRAGMENT);
BIND_ENUM_CONSTANT(TYPE_LIGHT); BIND_ENUM_CONSTANT(TYPE_LIGHT);
BIND_ENUM_CONSTANT(TYPE_EMIT);
BIND_ENUM_CONSTANT(TYPE_PROCESS);
BIND_ENUM_CONSTANT(TYPE_END);
BIND_ENUM_CONSTANT(TYPE_MAX); BIND_ENUM_CONSTANT(TYPE_MAX);
BIND_CONSTANT(NODE_ID_INVALID); BIND_CONSTANT(NODE_ID_INVALID);