From a2a78a80663674a1cd348a860184be8507bb76e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 11 Sep 2020 12:22:10 +0200 Subject: doc: Sync classref with current source Bind missing enums. --- doc/classes/CodeEdit.xml | 203 ++++++++++++++++++++++ doc/classes/GPUParticles3D.xml | 28 +++ doc/classes/HTTPRequest.xml | 26 +-- doc/classes/ImageTexture3D.xml | 39 +++++ doc/classes/PackedByteArray.xml | 2 +- doc/classes/ParticlesMaterial.xml | 27 ++- doc/classes/RayCast2D.xml | 6 +- doc/classes/RayCast3D.xml | 6 +- doc/classes/SpriteFrames.xml | 2 +- doc/classes/StreamTexture3D.xml | 25 +++ doc/classes/TextEdit.xml | 306 ++++++++++++++++++++++++++++----- doc/classes/VisualShader.xml | 9 +- doc/classes/VisualShaderNode.xml | 6 + scene/main/http_request.cpp | 1 + scene/resources/particles_material.cpp | 6 + scene/resources/particles_material.h | 1 - scene/resources/visual_shader.cpp | 3 + 17 files changed, 620 insertions(+), 76 deletions(-) create mode 100644 doc/classes/CodeEdit.xml create mode 100644 doc/classes/ImageTexture3D.xml create mode 100644 doc/classes/StreamTexture3D.xml diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml new file mode 100644 index 0000000000..f6bc9e2cca --- /dev/null +++ b/doc/classes/CodeEdit.xml @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index 3fc9e73ccf..8444610f49 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -18,6 +18,22 @@ Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. + + + + + + + + + + + + + + + + @@ -101,6 +117,8 @@ Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. + + 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. @@ -115,6 +133,16 @@ Particles are drawn in order of depth. + + + + + + + + + + Maximum number of draw passes supported. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 2ba2249d21..dc88c53810 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -135,7 +135,7 @@ - + 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 @@ + + 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]. + 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. @@ -162,12 +168,6 @@ If [code]true[/code], multithreading is used to improve performance. - - 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]. - @@ -208,19 +208,21 @@ Request exceeded its maximum size limit, see [member body_size_limit]. - + + + Request failed (currently unused). - + HTTPRequest couldn't open the download file. - + HTTPRequest couldn't write to the download file. - + Request reached its maximum redirect limit, see [member max_redirects]. - + diff --git a/doc/classes/ImageTexture3D.xml b/doc/classes/ImageTexture3D.xml new file mode 100644 index 0000000000..d05082487d --- /dev/null +++ b/doc/classes/ImageTexture3D.xml @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 7bfc502fbb..0fcfed0595 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -60,7 +60,7 @@ - + diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index d04ac5bdce..f6fa3cf38b 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -243,6 +243,14 @@ Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes. + + + + + + + + Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. @@ -252,15 +260,6 @@ Tangential acceleration randomness ratio. - - Trail particles' color will vary along this [GradientTexture]. - - - Emitter will emit [code]amount[/code] divided by [code]trail_divisor[/code] particles. The remaining particles will be used as trail(s). - - - Trail particles' size will vary along this [CurveTexture]. - @@ -332,5 +331,15 @@ Represents the size of the [enum EmissionShape] enum. + + + + + + + + + + diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 5fc5b09833..e30d7df63f 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -123,9 +123,6 @@ - - The ray's destination point, relative to the RayCast's [code]position[/code]. - If [code]true[/code], collision with [Area2D]s will be reported. @@ -141,6 +138,9 @@ If [code]true[/code], the parent node will be excluded from collision detection. + + The ray's destination point, relative to the RayCast's [code]position[/code]. + diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml index d8bff65bff..1d8edf0adb 100644 --- a/doc/classes/RayCast3D.xml +++ b/doc/classes/RayCast3D.xml @@ -126,9 +126,6 @@ - - The ray's destination point, relative to the RayCast's [code]position[/code]. - If [code]true[/code], collision with [Area3D]s will be reported. @@ -144,6 +141,9 @@ If [code]true[/code], collisions will be ignored for this RayCast3D's immediate parent. + + The ray's destination point, relative to the RayCast's [code]position[/code]. + diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index f7c9be7900..1c7d84c5a2 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -54,7 +54,7 @@ - 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]. diff --git a/doc/classes/StreamTexture3D.xml b/doc/classes/StreamTexture3D.xml new file mode 100644 index 0000000000..7054a4ee99 --- /dev/null +++ b/doc/classes/StreamTexture3D.xml @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index ccc99dc8e3..a23a4936f8 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -9,6 +9,14 @@ + + + + + + + + @@ -112,11 +120,34 @@ Folds the given line, if possible (see [method can_fold]). - - + + + + + + + + + + + + + + + + + + + + + + + + + + - Returns an array containing the line number of each breakpoint. @@ -135,6 +166,46 @@ Returns the amount of total lines in the text. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -202,6 +273,40 @@ Returns whether the line at the specified index is folded or not. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -241,11 +346,12 @@ Perform redo operation. - + + + - Removes all the breakpoints. This will not fire the [signal breakpoint_toggled] signal. @@ -295,6 +401,78 @@ If [member selecting_enabled] is [code]false[/code], no selection will occur. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -317,6 +495,66 @@ If [code]true[/code], hides the line of the specified index. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -351,9 +589,6 @@ - - If [code]true[/code], the breakpoint gutter is visible. - If [code]true[/code], the caret (visual cursor) blinks. @@ -378,9 +613,6 @@ If [code]true[/code], the "tab" character will have a visible representation. - - If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines. - If [code]true[/code], all lines that have been set to hidden by [method set_line_as_hidden], will not be visible. @@ -416,9 +648,6 @@ If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled. - - If [code]true[/code], line numbers are displayed to the left of the text. - If [code]true[/code], sets the [code]step[/code] of the scrollbars to [code]0.25[/code] which results in smoother scrolling. @@ -438,29 +667,31 @@ - - - + - Emitted when a breakpoint is placed via the breakpoint gutter. + Emitted when the cursor changes. - + - Emitted when the cursor changes. - - + + - + - Emitted when the info icon is clicked. - - + + + + + + + + @@ -501,6 +732,12 @@ Search from end to beginning. + + + + + + Cuts (copies and clears) the selected text. @@ -530,14 +767,8 @@ Sets the background [Color] of this [TextEdit]. [member syntax_highlighting] has to be enabled. - - Sets the [Color] of the bookmark marker. [member syntax_highlighting] has to be enabled. - - - Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled. - @@ -565,14 +796,8 @@ Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled. - - - - - - Sets the default [Font]. @@ -584,9 +809,6 @@ Sets the [Color] of the selected text. [member override_selected_font_color] has to be enabled. - - Sets the [Color] of the line numbers. [member show_line_numbers] has to be enabled. - Sets the spacing between the lines. @@ -599,8 +821,6 @@ Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled. - - Sets the highlight [Color] of text selections. diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 12954beb43..f03550bd5e 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -209,10 +209,13 @@ A shader for light calculations. - - A compute shader, to use the GPU for abstract computation. + - + + + + + Represents the size of the [enum Type] enum. diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 6327ab534f..3bb527f3d4 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -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). + + + + + + diff --git a/scene/main/http_request.cpp b/scene/main/http_request.cpp index 2b506b686b..da0169b60b 100644 --- a/scene/main/http_request.cpp +++ b/scene/main/http_request.cpp @@ -631,6 +631,7 @@ void HTTPRequest::_bind_methods() { BIND_ENUM_CONSTANT(RESULT_SSL_HANDSHAKE_ERROR); BIND_ENUM_CONSTANT(RESULT_NO_RESPONSE); 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_DOWNLOAD_FILE_CANT_OPEN); BIND_ENUM_CONSTANT(RESULT_DOWNLOAD_FILE_WRITE_ERROR); diff --git a/scene/resources/particles_material.cpp b/scene/resources/particles_material.cpp index 49b8cbe7e0..4bbfa8965a 100644 --- a/scene/resources/particles_material.cpp +++ b/scene/resources/particles_material.cpp @@ -1246,6 +1246,12 @@ void ParticlesMaterial::_bind_methods() { BIND_ENUM_CONSTANT(EMISSION_SHAPE_POINTS); BIND_ENUM_CONSTANT(EMISSION_SHAPE_DIRECTED_POINTS); 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() : diff --git a/scene/resources/particles_material.h b/scene/resources/particles_material.h index 9d41c91937..fa8858f67f 100644 --- a/scene/resources/particles_material.h +++ b/scene/resources/particles_material.h @@ -50,7 +50,6 @@ class ParticlesMaterial : public Material { public: enum Parameter { - PARAM_INITIAL_LINEAR_VELOCITY, PARAM_ANGULAR_VELOCITY, PARAM_ORBIT_VELOCITY, diff --git a/scene/resources/visual_shader.cpp b/scene/resources/visual_shader.cpp index 4ee9b22b25..7554550f3a 100644 --- a/scene/resources/visual_shader.cpp +++ b/scene/resources/visual_shader.cpp @@ -1638,6 +1638,9 @@ void VisualShader::_bind_methods() { BIND_ENUM_CONSTANT(TYPE_VERTEX); BIND_ENUM_CONSTANT(TYPE_FRAGMENT); 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_CONSTANT(NODE_ID_INVALID); -- cgit v1.2.3