diff options
Diffstat (limited to 'doc')
29 files changed, 430 insertions, 37 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index d1e2a9c910..760287e1b8 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -45,6 +45,8 @@ <member name="Marshalls" type="Reference" setter="" getter=""> [Marshalls] singleton </member> + <member name="NavigationMeshGenerator" type="EditorNavigationMeshGenerator" setter="" getter=""> + </member> <member name="OS" type="OS" setter="" getter=""> [OS] singleton </member> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 9885f30883..53d3663d4f 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -562,6 +562,19 @@ Set the value of an existing key. </description> </method> + <method name="track_set_key_time"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="time" type="float"> + </argument> + <description> + Set the time of an existing key. + </description> + </method> <method name="track_set_path"> <return type="void"> </return> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index e23080c9d3..4bcf8ea791 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.2"> <brief_description> - Plays audio. + Stores audio data loaded from [code].wav[/code] files. </brief_description> <description> - Plays audio, can loop. + AudioStreamSample stores sound samples loaded from [code].wav[/code] files. To play the stored sound use an [AudioStreamPlayer] (for background music) or [AudioStreamPlayer2D]/[AudioStreamPlayer3D] (for positional audio). The sound can be looped. + This class can also be used to store dynamically generated PCM audio data. </description> <tutorials> </tutorials> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 0b7021b4a1..cc869d28a2 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -18,6 +18,13 @@ If this is the current Camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next Camera current, if any. </description> </method> + <method name="get_camera_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Returns the camera's RID from the [VisualServer]. + </description> + </method> <method name="get_camera_transform" qualifiers="const"> <return type="Transform"> </return> @@ -39,13 +46,6 @@ <description> </description> </method> - <method name="get_camera_rid" qualifiers="const"> - <return type="RID"> - </return> - <description> - Returns the camera's RID from the [VisualServer]. - </description> - </method> <method name="is_position_behind" qualifiers="const"> <return type="bool"> </return> @@ -76,8 +76,10 @@ </return> <argument index="0" name="screen_point" type="Vector2"> </argument> + <argument index="1" name="z_depth" type="float" default="0"> + </argument> <description> - Returns the 3D point in worldspace that maps to the given 2D coordinate in the [Viewport] rectangle. + Returns the 3D point in worldspace that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given distance into the scene away from the camera. </description> </method> <method name="project_ray_normal" qualifiers="const"> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 9f48f6e018..ab5d7a0a5d 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -566,6 +566,8 @@ </constant> <constant name="tomato" value="Color( 1, 0.39, 0.28, 1 )"> </constant> + <constant name="transparent" value="Color( 1, 1, 1, 0 )"> + </constant> <constant name="turquoise" value="Color( 0.25, 0.88, 0.82, 1 )"> </constant> <constant name="violet" value="Color( 0.93, 0.51, 0.93, 1 )"> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 22061322c8..ec9d5bc3dc 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -4,7 +4,7 @@ All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. </brief_description> <description> - Base class for all User Interface or [i]UI[/i] related nodes. [Control] features a bounding rectangle that defines its extents, an anchor position relative to its parent and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change. + Base class for all User Interface or [i]UI[/i] related nodes. [Control] features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change. For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from [Control] and [Container] nodes. [b]User Interface nodes and input[/b] Godot sends input events to the scene's root node first, by calling [method Node._input]. [method Node._input] forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls [method MainLoop._input_event]. Call [method accept_event] so no other node receives the event. Once you accepted an input, it becomes handled so [method Node._unhandled_input] will not process it. diff --git a/doc/classes/CubeMesh.xml b/doc/classes/CubeMesh.xml index 814c2f21c1..6162474ed1 100644 --- a/doc/classes/CubeMesh.xml +++ b/doc/classes/CubeMesh.xml @@ -5,6 +5,7 @@ </brief_description> <description> Generate an axis-aligned cuboid [PrimitiveMesh]. + The cube's UV layout is arranged in a 3×2 layout that allows texturing each face individually. To apply the same texture on all faces, change the material's UV property to [code]Vector3(3, 2, 1)[/code]. </description> <tutorials> </tutorials> diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml index fa0a3bf412..dbdc7aeb92 100644 --- a/doc/classes/CylinderMesh.xml +++ b/doc/classes/CylinderMesh.xml @@ -4,7 +4,7 @@ Class representing a cylindrical [PrimitiveMesh]. </brief_description> <description> - Class representing a cylindrical [PrimitiveMesh]. + Class representing a cylindrical [PrimitiveMesh]. This class can be used to create cones by setting either the [member top_radius] or [member bottom_radius] properties to 0.0. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorNavigationMeshGenerator.xml b/doc/classes/EditorNavigationMeshGenerator.xml new file mode 100644 index 0000000000..3956e12509 --- /dev/null +++ b/doc/classes/EditorNavigationMeshGenerator.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorNavigationMeshGenerator" inherits="Object" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="bake"> + <return type="void"> + </return> + <argument index="0" name="nav_mesh" type="NavigationMesh"> + </argument> + <argument index="1" name="root_node" type="Node"> + </argument> + <description> + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <argument index="0" name="nav_mesh" type="NavigationMesh"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 6a89d81aa0..674f786149 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -9,6 +9,15 @@ <tutorials> </tutorials> <methods> + <method name="set_custom_aabb"> + <return type="void"> + </return> + <argument index="0" name="aabb" type="AABB"> + </argument> + <description> + Overrides the bounding box of this node with a custom one. To remove it, set an AABB with all fields set to zero. + </description> + </method> </methods> <members> <member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting"> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index bb180b591d..184987d2dd 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -166,6 +166,7 @@ </constant> <constant name="MENU_PASTE" value="2" enum="MenuItems"> Pastes the clipboard text over the selected text (or at the cursor's position). + Non-printable escape characters are automatically stripped from the OS clipboard via [method String.strip_escapes]. </constant> <constant name="MENU_CLEAR" value="3" enum="MenuItems"> Erases the whole [LineEdit] text. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 2788eb053a..79ad7f63ae 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -29,6 +29,14 @@ <description> </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_polygon"> <return type="PoolIntArray"> </return> @@ -49,6 +57,16 @@ <description> </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_vertices"> <return type="void"> </return> @@ -85,6 +103,10 @@ </member> <member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles"> </member> + <member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + </member> + <member name="geometry/parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type"> + </member> <member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly"> </member> <member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size"> @@ -101,5 +123,11 @@ </constant> <constant name="SAMPLE_PARTITION_LAYERS" value="2"> </constant> + <constant name="PARSED_GEOMETRY_MESH_INSTANCES" value="0"> + </constant> + <constant name="PARSED_GEOMETRY_STATIC_COLLIDERS" value="1"> + </constant> + <constant name="PARSED_GEOMETRY_BOTH" value="2"> + </constant> </constants> </class> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index ec2ee78701..dd0fcd63e7 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -97,6 +97,8 @@ </argument> <argument index="3" name="output" type="Array" default="[ ]"> </argument> + <argument index="4" name="read_stderr" type="bool" default="false"> + </argument> <description> Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-w', '3', 'godotengine.org'], false)[/code] will resolve to [code]ping -w 3 godotengine.org[/code] in the system's shell. @@ -701,17 +703,6 @@ The same image is used for window caption, taskbar/dock and window selection dialog. Image is scaled as needed. </description> </method> - <method name="set_native_icon"> - <return type="void"> - </return> - <argument index="0" name="filename" type="String"> - </argument> - <description> - Sets the game's icon using a multi-size platform-specific icon file ([code]*.ico[/code] on Windows and [code]*.icns[/code] on macOS). - Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog. - Note: This method is only implemented on macOS and Windows. - </description> - </method> <method name="set_ime_active"> <return type="void"> </return> @@ -730,6 +721,17 @@ Sets position of IME suggestion list popup (in window coordinates). </description> </method> + <method name="set_native_icon"> + <return type="void"> + </return> + <argument index="0" name="filename" type="String"> + </argument> + <description> + Sets the game's icon using a multi-size platform-specific icon file ([code]*.ico[/code] on Windows and [code]*.icns[/code] on macOS). + Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog. + Note: This method is only implemented on macOS and Windows. + </description> + </method> <method name="set_thread_name"> <return type="int" enum="Error"> </return> diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml index a8927f8479..a507f9f145 100644 --- a/doc/classes/PlaneMesh.xml +++ b/doc/classes/PlaneMesh.xml @@ -4,7 +4,7 @@ Class representing a planar [PrimitiveMesh]. </brief_description> <description> - Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness. + Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Z axes; this default rotation isn't suited for use with billboarded materials. For billboarded materials, use [QuadMesh] instead. </description> <tutorials> </tutorials> @@ -15,10 +15,10 @@ Size of the generated plane. Defaults to (2.0, 2.0). </member> <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth"> - Number of subdivision along the z-axis. Defaults to 0. + Number of subdivision along the Z axis. Defaults to 0. </member> <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width"> - Number of subdivision along the x-axis. Defaults to 0. + Number of subdivision along the X axis. Defaults to 0. </member> </members> <constants> diff --git a/doc/classes/PrismMesh.xml b/doc/classes/PrismMesh.xml index 4c282c5e8d..62f1278bba 100644 --- a/doc/classes/PrismMesh.xml +++ b/doc/classes/PrismMesh.xml @@ -12,19 +12,19 @@ </methods> <members> <member name="left_to_right" type="float" setter="set_left_to_right" getter="get_left_to_right"> - Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottom left edge. Defaults to 0.5 (positioned on the midpoint). + Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. Defaults to 0.5 (positioned on the midpoint). </member> <member name="size" type="Vector3" setter="set_size" getter="get_size"> Size of the prism. Defaults to (2.0, 2.0, 2.0). </member> <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth"> - Number of added edge loops along the z-axis. Defaults to 0. + Number of added edge loops along the Z axis. Defaults to 0. </member> <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height"> - Number of added edge loops along the y-axis. Defaults to 0. + Number of added edge loops along the Y axis. Defaults to 0. </member> <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width"> - Number of added edge loops along the x-axis. Defaults to 0. + Number of added edge loops along the X axis. Defaults to 0. </member> </members> <constants> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 4b5500d077..ff8b702859 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -180,6 +180,8 @@ <member name="application/config/icon" type="String" setter="" getter=""> Icon used for the project, set when project loads. Exporters will also use this icon when possible. </member> + <member name="application/config/macos_native_icon" type="String" setter="" getter=""> + </member> <member name="application/config/name" type="String" setter="" getter=""> The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. </member> @@ -189,6 +191,8 @@ <member name="application/config/use_custom_user_dir" type="bool" setter="" getter=""> If [code]true[/code], the project will save user data to its own user directory (see [member application/config/custom_user_dir_name]). This setting is only effective on desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect. If [code]false[/code], the project will save user data to [code](OS user data directory)/Godot/app_userdata/(project name)[/code]. </member> + <member name="application/config/windows_native_icon" type="String" setter="" getter=""> + </member> <member name="application/run/disable_stderr" type="bool" setter="" getter=""> If [code]true[/code], disables printing to standard error in an exported build. </member> diff --git a/doc/classes/QuadMesh.xml b/doc/classes/QuadMesh.xml index 1b33f62e0f..779ce11180 100644 --- a/doc/classes/QuadMesh.xml +++ b/doc/classes/QuadMesh.xml @@ -4,7 +4,7 @@ Class representing a square mesh. </brief_description> <description> - Class representing a square mesh with size (2,2,0). Consider using a [PlaneMesh] if you require a differently sized plane. + Class representing a square [PrimitiveMesh]. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Y axes; this default rotation is more suited for use with billboarded materials. Unlike [PlaneMesh], this mesh doesn't provide subdivision options. </description> <tutorials> </tutorials> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 9ea6bb0fe1..8dadca49e1 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -119,10 +119,10 @@ Lock the body's movement in the x-axis. </member> <member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the x-axis. + Lock the body's movement in the y-axis. </member> <member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - Lock the body's movement in the x-axis. + Lock the body's movement in the z-axis. </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> RigidBody's bounciness. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 0b1f659da3..a236d776c7 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -359,6 +359,12 @@ Emitted whenever a node is removed from the SceneTree. </description> </signal> + <signal name="node_renamed"> + <argument index="0" name="node" type="Node"> + </argument> + <description> + </description> + </signal> <signal name="physics_frame"> <description> Emitted immediately before [method Node._physics_process] is called on every node in the SceneTree. diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 8e93160af9..f0df5fac4a 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -120,6 +120,8 @@ <member name="flags_use_point_size" type="bool" setter="set_flag" getter="get_flag"> If [code]true[/code], render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size]. </member> + <member name="flags_use_shadow_to_opacity" type="bool" setter="set_flag" getter="get_flag"> + </member> <member name="flags_vertex_lighting" type="bool" setter="set_flag" getter="get_flag"> If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: [code]false[/code]. </member> @@ -390,7 +392,9 @@ </constant> <constant name="FLAG_ENSURE_CORRECT_NORMALS" value="16" enum="Flags"> </constant> - <constant name="FLAG_MAX" value="18" enum="Flags"> + <constant name="FLAG_USE_SHADOW_TO_OPACITY" value="18" enum="Flags"> + </constant> + <constant name="FLAG_MAX" value="19" enum="Flags"> </constant> <constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode"> Default diffuse scattering algorithm. diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml index 0124d8a4b0..4ebb2e919d 100644 --- a/doc/classes/SphereMesh.xml +++ b/doc/classes/SphereMesh.xml @@ -15,7 +15,7 @@ Full height of the sphere. Defaults to 2.0. </member> <member name="is_hemisphere" type="bool" setter="set_is_hemisphere" getter="get_is_hemisphere"> - Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to [code]false[/code]. + Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere, the height and radius of the sphere have to equal. Defaults to [code]false[/code]. </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments"> Number of radial segments on the sphere. Defaults to 64. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index e06f0738b8..5ea78c6f1c 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -741,7 +741,14 @@ <argument index="1" name="right" type="bool" default="True"> </argument> <description> - Returns a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. + Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. + </description> + </method> + <method name="strip_escapes"> + <return type="String"> + </return> + <description> + Returns a copy of the string stripped of any escape character. These include all non-printable control characters of the first page of the ASCII table (< 32), such as tabulation ([code]\t[/code] in C) and newline ([code]\n[/code] and [code]\r[/code]) characters, but not spaces. </description> </method> <method name="substr"> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 25188a80db..e97f9995ee 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -169,6 +169,12 @@ Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. </description> </method> + <method name="commit_to_arrays"> + <return type="Array"> + </return> + <description> + </description> + </method> <method name="create_from"> <return type="void"> </return> @@ -180,6 +186,18 @@ Creates a vertex array from an existing [Mesh]. </description> </method> + <method name="create_from_blend_shape"> + <return type="void"> + </return> + <argument index="0" name="existing" type="Mesh"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <argument index="2" name="blend_shape" type="String"> + </argument> + <description> + </description> + </method> <method name="deindex"> <return type="void"> </return> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index b60673bb5b..0272efeecb 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -271,6 +271,12 @@ Emitted when a cell with the [code]CELL_MODE_CUSTOM[/code] is clicked to be edited. </description> </signal> + <signal name="empty_rmb"> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + </description> + </signal> <signal name="empty_tree_rmb_selected"> <argument index="0" name="position" type="Vector2"> </argument> diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index f8dac82cb5..c3b668c170 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -9,6 +9,12 @@ <tutorials> </tutorials> <methods> + <method name="get_rpm" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="get_skidinfo" qualifiers="const"> <return type="float"> </return> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 3563120f0f..3997798cca 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -3597,7 +3597,7 @@ get_viewport().set_attach_to_screen_rect(Rect2()) $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600)) [/codeblock] - Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, [method set_render_direct_to_screen]. + Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, [method viewport_set_render_direct_to_screen]. </description> </method> <method name="viewport_create"> diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index d399f69c96..6d5f53d992 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -53,6 +53,22 @@ <description> </description> </method> + <method name="connect_nodes_forced"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> <method name="disconnect_nodes"> <return type="void"> </return> @@ -129,6 +145,12 @@ <description> </description> </method> + <method name="rebuild"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="remove_node"> <return type="void"> </return> diff --git a/doc/classes/VisualShaderNodeExpression.xml b/doc/classes/VisualShaderNodeExpression.xml new file mode 100644 index 0000000000..8a5477280f --- /dev/null +++ b/doc/classes/VisualShaderNodeExpression.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeExpression" inherits="VisualShaderNodeGroupBase" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="build"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="expression" type="String" setter="set_expression" getter="get_expression"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml new file mode 100644 index 0000000000..37d48956f6 --- /dev/null +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -0,0 +1,205 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeGroupBase" inherits="VisualShaderNode" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_input_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_output_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_input_ports"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="clear_output_ports"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_control"> + <return type="Control"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_free_input_port_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_free_output_port_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_input_port_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_inputs" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_output_port_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_outputs" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="has_input_port" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_output_port" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_input_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_output_port"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_control"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_input_port_name"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_input_port_type"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_inputs"> + <return type="void"> + </return> + <argument index="0" name="inputs" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_output_port_name"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_output_port_type"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_outputs"> + <return type="void"> + </return> + <argument index="0" name="outputs" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> |