summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/EditorPlugin.xml24
-rw-r--r--doc/classes/FileDialog.xml6
-rw-r--r--doc/classes/GeometryInstance.xml18
-rw-r--r--doc/classes/Image.xml10
-rw-r--r--doc/classes/ItemList.xml4
-rw-r--r--doc/classes/Tree.xml4
-rw-r--r--doc/classes/VisualInstance.xml7
-rw-r--r--doc/classes/VisualServer.xml4
8 files changed, 65 insertions, 12 deletions
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml
index 50f36c2c87..edd1f721b5 100644
--- a/doc/classes/EditorPlugin.xml
+++ b/doc/classes/EditorPlugin.xml
@@ -135,15 +135,20 @@
<description>
</description>
</method>
- <method name="forward_draw_over_canvas" qualifiers="virtual">
+ <method name="forward_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
- <argument index="0" name="canvas_xform" type="Transform2D">
+ <argument index="0" name="overlay" type="Control">
</argument>
- <argument index="1" name="canvas" type="Control">
+ <description>
+ </description>
+ </method>
+ <method name="forward_force_draw_over_viewport" qualifiers="virtual">
+ <return type="void">
+ </return>
+ <argument index="0" name="overlay" type="Control">
</argument>
<description>
- This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas].
</description>
</method>
<method name="forward_spatial_gui_input" qualifiers="virtual">
@@ -297,6 +302,12 @@
This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources.
</description>
</method>
+ <method name="set_force_draw_over_forwarding_enabled">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="set_input_event_forwarding_always_enabled">
<return type="void">
</return>
@@ -322,11 +333,10 @@
Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout].
</description>
</method>
- <method name="update_canvas">
- <return type="void">
+ <method name="update_overlays" qualifiers="const">
+ <return type="int">
</return>
<description>
- Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event].
</description>
</method>
</methods>
diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml
index 7f6fc13758..0f7038238e 100644
--- a/doc/classes/FileDialog.xml
+++ b/doc/classes/FileDialog.xml
@@ -27,6 +27,12 @@
Clear all the added filters in the dialog.
</description>
</method>
+ <method name="deselect_items">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="get_current_dir" qualifiers="const">
<return type="String">
</return>
diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml
index 93db093c8b..981873b1fe 100644
--- a/doc/classes/GeometryInstance.xml
+++ b/doc/classes/GeometryInstance.xml
@@ -14,32 +14,50 @@
</methods>
<members>
<member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting">
+ The selected shadow casting flag. See SHADOW_CASTING_SETTING_* constants for values.
</member>
<member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin">
+ The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.
</member>
<member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance">
+ The GeometryInstance's max LOD distance.
</member>
<member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis">
+ The GeometryInstance's max LOD margin.
</member>
<member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance">
+ The GeometryInstance's min LOD distance.
</member>
<member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis">
+ The GeometryInstance's min LOD margin.
</member>
<member name="material_override" type="Material" setter="set_material_override" getter="get_material_override">
+ The material override for the whole geometry.
+ If there is a material in material_override, it will be used instead of any material set in any material slot of the mesh.
</member>
<member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag">
+ If [code]true[/code] this GeometryInstance will be used when baking lights using a [GIProbe] and/or any other form of baked lighting.
</member>
</members>
<constants>
<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
+ Will not cast any shadows.
</constant>
<constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting">
+ Will cast shadows from all visible faces in the GeometryInstance.
+ Will take culling into account, so faces not being rendered will not be taken into account when shadow casting.
</constant>
<constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2" enum="ShadowCastingSetting">
+ Will cast shadows from all visible faces in the GeometryInstance.
+ Will not take culling into account, so all faces will be taken into account when shadow casting.
</constant>
<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting">
+ Will only show the shadows casted from this object.
+ In other words: The actual mesh will not be visible, only the shadows casted from the mesh.
</constant>
<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">
+ Will allow the GeometryInstance to be used when baking lights using a [GIProbe] and/or any other form of baked lighting.
+ Added documentation for GeometryInstance and VisualInstance
</constant>
<constant name="FLAG_MAX" value="1" enum="Flags">
</constant>
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index 4e905445ed..54eaf6cc7a 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -318,7 +318,7 @@
<return type="void">
</return>
<description>
- Locks the data and prevents changes.
+ Locks the data for writing access.
</description>
</method>
<method name="normalmap_to_xy">
@@ -376,13 +376,13 @@
<argument index="2" name="color" type="Color">
</argument>
<description>
- Sets the [Color] of the pixel at [code](x, y)[/code] if the image is unlocked. Example:
+ Sets the [Color] of the pixel at [code](x, y)[/code] if the image is locked. Example:
[codeblock]
var img = Image.new()
img.lock()
- img.set_pixel(x, y, color) # Does not have an effect
- img.unlock()
img.set_pixel(x, y, color) # Works
+ img.unlock()
+ img.set_pixel(x, y, color) # Does not have an effect
[/codeblock]
</description>
</method>
@@ -404,7 +404,7 @@
<return type="void">
</return>
<description>
- Unlocks the data for writing access.
+ Unlocks the data and prevents changes.
</description>
</method>
</methods>
diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml
index 6e9ffb7f35..d10722d411 100644
--- a/doc/classes/ItemList.xml
+++ b/doc/classes/ItemList.xml
@@ -378,6 +378,10 @@
Fired when a multiple selection is altered on a list allowing multiple selection.
</description>
</signal>
+ <signal name="nothing_selected">
+ <description>
+ </description>
+ </signal>
<signal name="rmb_clicked">
<argument index="0" name="at_position" type="Vector2">
</argument>
diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml
index 3d1144e81e..11bd3b3b86 100644
--- a/doc/classes/Tree.xml
+++ b/doc/classes/Tree.xml
@@ -405,6 +405,10 @@
Emitted instead of [code]item_selected[/code] when [code]select_mode[/code] is [code]SELECT_MULTI[/code].
</description>
</signal>
+ <signal name="nothing_selected">
+ <description>
+ </description>
+ </signal>
</signals>
<constants>
<constant name="SELECT_SINGLE" value="0" enum="SelectMode">
diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml
index 2c9fe4f43e..bd66880719 100644
--- a/doc/classes/VisualInstance.xml
+++ b/doc/classes/VisualInstance.xml
@@ -13,12 +13,15 @@
<return type="AABB">
</return>
<description>
+ Returns the [AABB] (also known as the bounding box) for this VisualInstance.
</description>
</method>
<method name="get_transformed_aabb" qualifiers="const">
<return type="AABB">
</return>
<description>
+ Returns the transformed [AABB] (also known as the bounding box) for this VisualInstance.
+ Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]s [Transform]
</description>
</method>
<method name="set_base">
@@ -27,11 +30,15 @@
<argument index="0" name="base" type="RID">
</argument>
<description>
+ Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood.
+ It is recommended to only use set_base if you know what you're doing.
</description>
</method>
</methods>
<members>
<member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask">
+ The render layer(s) this VisualInstance is drawn on.
+ This object will only be visible for [Camera]s whose cull mask includes the render object this VisualInstance is set to.
</member>
</members>
<constants>
diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml
index c84aad26a1..479c0606f2 100644
--- a/doc/classes/VisualServer.xml
+++ b/doc/classes/VisualServer.xml
@@ -817,6 +817,8 @@
<method name="draw">
<return type="void">
</return>
+ <argument index="0" name="swap_buffers" type="bool" default="true">
+ </argument>
<description>
</description>
</method>
@@ -829,6 +831,8 @@
<method name="force_draw">
<return type="void">
</return>
+ <argument index="0" name="swap_buffers" type="bool" default="true">
+ </argument>
<description>
</description>
</method>
generated by cgit v1.2.3 (git 2.25.1) at 2025-02-26 09:03:15 +0000