diff options
Diffstat (limited to 'doc/classes')
35 files changed, 533 insertions, 387 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 222b70c9c7..03eb733e54 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -77,9 +77,6 @@ <member name="ProjectSettings" type="ProjectSettings" setter="" getter=""> The [ProjectSettings] singleton. </member> - <member name="RenderingDevice" type="RenderingDevice" setter="" getter=""> - The [RenderingDevice] singleton. - </member> <member name="RenderingServer" type="RenderingServer" setter="" getter=""> The [RenderingServer] singleton. </member> @@ -946,212 +943,185 @@ <constant name="BUTTON_MASK_XBUTTON2" value="256" enum="ButtonList"> Extra mouse button 2 mask. </constant> - <constant name="JOY_BUTTON_0" value="0" enum="JoystickList"> - Gamepad button 0. - </constant> - <constant name="JOY_BUTTON_1" value="1" enum="JoystickList"> - Gamepad button 1. - </constant> - <constant name="JOY_BUTTON_2" value="2" enum="JoystickList"> - Gamepad button 2. - </constant> - <constant name="JOY_BUTTON_3" value="3" enum="JoystickList"> - Gamepad button 3. - </constant> - <constant name="JOY_BUTTON_4" value="4" enum="JoystickList"> - Gamepad button 4. - </constant> - <constant name="JOY_BUTTON_5" value="5" enum="JoystickList"> - Gamepad button 5. - </constant> - <constant name="JOY_BUTTON_6" value="6" enum="JoystickList"> - Gamepad button 6. - </constant> - <constant name="JOY_BUTTON_7" value="7" enum="JoystickList"> - Gamepad button 7. - </constant> - <constant name="JOY_BUTTON_8" value="8" enum="JoystickList"> - Gamepad button 8. - </constant> - <constant name="JOY_BUTTON_9" value="9" enum="JoystickList"> - Gamepad button 9. + <constant name="JOY_INVALID_BUTTON" value="-1" enum="JoyButtonList"> + An invalid game controller button. </constant> - <constant name="JOY_BUTTON_10" value="10" enum="JoystickList"> - Gamepad button 10. + <constant name="JOY_BUTTON_A" value="0" enum="JoyButtonList"> + Game controller SDL button A. </constant> - <constant name="JOY_BUTTON_11" value="11" enum="JoystickList"> - Gamepad button 11. + <constant name="JOY_BUTTON_B" value="1" enum="JoyButtonList"> + Game controller SDL button B. </constant> - <constant name="JOY_BUTTON_12" value="12" enum="JoystickList"> - Gamepad button 12. + <constant name="JOY_BUTTON_X" value="2" enum="JoyButtonList"> + Game controller SDL button X. </constant> - <constant name="JOY_BUTTON_13" value="13" enum="JoystickList"> - Gamepad button 13. + <constant name="JOY_BUTTON_Y" value="3" enum="JoyButtonList"> + Game controller SDL button Y. </constant> - <constant name="JOY_BUTTON_14" value="14" enum="JoystickList"> - Gamepad button 14. + <constant name="JOY_BUTTON_BACK" value="4" enum="JoyButtonList"> + Game controller SDL back button. </constant> - <constant name="JOY_BUTTON_15" value="15" enum="JoystickList"> - Gamepad button 15. + <constant name="JOY_BUTTON_GUIDE" value="5" enum="JoyButtonList"> + Game controller SDL guide button. </constant> - <constant name="JOY_BUTTON_MAX" value="16" enum="JoystickList"> - Represents the maximum number of joystick buttons supported. + <constant name="JOY_BUTTON_START" value="6" enum="JoyButtonList"> + Game controller SDL start button. </constant> - <constant name="JOY_SONY_CIRCLE" value="1" enum="JoystickList"> - DualShock circle button. + <constant name="JOY_BUTTON_LEFT_STICK" value="7" enum="JoyButtonList"> + Game controller SDL left stick button. </constant> - <constant name="JOY_SONY_X" value="0" enum="JoystickList"> - DualShock X button. + <constant name="JOY_BUTTON_RIGHT_STICK" value="8" enum="JoyButtonList"> + Game controller SDL right stick button. </constant> - <constant name="JOY_SONY_SQUARE" value="2" enum="JoystickList"> - DualShock square button. + <constant name="JOY_BUTTON_LEFT_SHOULDER" value="9" enum="JoyButtonList"> + Game controller SDL left shoulder button. </constant> - <constant name="JOY_SONY_TRIANGLE" value="3" enum="JoystickList"> - DualShock triangle button. + <constant name="JOY_BUTTON_RIGHT_SHOULDER" value="10" enum="JoyButtonList"> + Game controller SDL right shoulder button. </constant> - <constant name="JOY_XBOX_B" value="1" enum="JoystickList"> - Xbox controller B button. + <constant name="JOY_BUTTON_DPAD_UP" value="11" enum="JoyButtonList"> + Game controller SDL D-pad up button. </constant> - <constant name="JOY_XBOX_A" value="0" enum="JoystickList"> - Xbox controller A button. + <constant name="JOY_BUTTON_DPAD_DOWN" value="12" enum="JoyButtonList"> + Game controller SDL D-pad down button. </constant> - <constant name="JOY_XBOX_X" value="2" enum="JoystickList"> - Xbox controller X button. + <constant name="JOY_BUTTON_DPAD_LEFT" value="13" enum="JoyButtonList"> + Game controller SDL D-pad left button. </constant> - <constant name="JOY_XBOX_Y" value="3" enum="JoystickList"> - Xbox controller Y button. + <constant name="JOY_BUTTON_DPAD_RIGHT" value="14" enum="JoyButtonList"> + Game controller SDL D-pad right button. </constant> - <constant name="JOY_DS_A" value="1" enum="JoystickList"> - Nintendo controller A button. + <constant name="JOY_SDL_BUTTONS" value="15" enum="JoyButtonList"> + The number of SDL game controller buttons. </constant> - <constant name="JOY_DS_B" value="0" enum="JoystickList"> - Nintendo controller B button. + <constant name="JOY_SONY_X" value="0" enum="JoyButtonList"> + Sony DualShock controller X button maps to SDL button A. </constant> - <constant name="JOY_DS_X" value="3" enum="JoystickList"> - Nintendo controller X button. + <constant name="JOY_SONY_CROSS" value="0" enum="JoyButtonList"> + Sony DualShock controller cross button maps to SDL button A. </constant> - <constant name="JOY_DS_Y" value="2" enum="JoystickList"> - Nintendo controller Y button. + <constant name="JOY_SONY_CIRCLE" value="1" enum="JoyButtonList"> + Sony DualShock controller circle button maps to SDL button B. </constant> - <constant name="JOY_VR_GRIP" value="2" enum="JoystickList"> - Grip (side) buttons on a VR controller. + <constant name="JOY_SONY_SQUARE" value="2" enum="JoyButtonList"> + Sony DualShock controller square button maps to SDL button X. </constant> - <constant name="JOY_VR_PAD" value="14" enum="JoystickList"> - Push down on the touchpad or main joystick on a VR controller. + <constant name="JOY_SONY_TRIANGLE" value="3" enum="JoyButtonList"> + Sony DualShock controller triangle button maps to SDL button Y. </constant> - <constant name="JOY_VR_TRIGGER" value="15" enum="JoystickList"> - Trigger on a VR controller. + <constant name="JOY_SONY_SELECT" value="4" enum="JoyButtonList"> + Sony DualShock controller select button maps to SDL back button. </constant> - <constant name="JOY_OCULUS_AX" value="7" enum="JoystickList"> - A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR). + <constant name="JOY_SONY_START" value="6" enum="JoyButtonList"> + Sony DualShock controller start button maps to SDL start button. </constant> - <constant name="JOY_OCULUS_BY" value="1" enum="JoystickList"> - B button on the right Oculus Touch controller, Y button on the left controller (also when used in OpenVR). + <constant name="JOY_SONY_PS" value="5" enum="JoyButtonList"> + Sony DualShock controller PS button maps to SDL guide button. </constant> - <constant name="JOY_OCULUS_MENU" value="3" enum="JoystickList"> - Menu button on either Oculus Touch controller. + <constant name="JOY_SONY_L1" value="9" enum="JoyButtonList"> + Sony DualShock controller L1 button maps to SDL left shoulder button. </constant> - <constant name="JOY_OPENVR_MENU" value="1" enum="JoystickList"> - Menu button in OpenVR (Except when Oculus Touch controllers are used). + <constant name="JOY_SONY_R1" value="10" enum="JoyButtonList"> + Sony DualShock controller R1 button maps to SDL right shoulder button. </constant> - <constant name="JOY_SELECT" value="10" enum="JoystickList"> - Gamepad button Select. + <constant name="JOY_SONY_L3" value="7" enum="JoyButtonList"> + Sony DualShock controller L3 button maps to SDL left stick button. </constant> - <constant name="JOY_START" value="11" enum="JoystickList"> - Gamepad button Start. + <constant name="JOY_SONY_R3" value="8" enum="JoyButtonList"> + Sony DualShock controller R3 button maps to SDL right stick button. </constant> - <constant name="JOY_DPAD_UP" value="12" enum="JoystickList"> - Gamepad DPad up. + <constant name="JOY_XBOX_A" value="0" enum="JoyButtonList"> + Xbox game controller A button maps to SDL button A. </constant> - <constant name="JOY_DPAD_DOWN" value="13" enum="JoystickList"> - Gamepad DPad down. + <constant name="JOY_XBOX_B" value="1" enum="JoyButtonList"> + Xbox game controller B button maps to SDL button B. </constant> - <constant name="JOY_DPAD_LEFT" value="14" enum="JoystickList"> - Gamepad DPad left. + <constant name="JOY_XBOX_X" value="2" enum="JoyButtonList"> + Xbox game controller X button maps to SDL button X. </constant> - <constant name="JOY_DPAD_RIGHT" value="15" enum="JoystickList"> - Gamepad DPad right. + <constant name="JOY_XBOX_Y" value="3" enum="JoyButtonList"> + Xbox game controller Y button maps to SDL button Y. </constant> - <constant name="JOY_L" value="4" enum="JoystickList"> - Gamepad left Shoulder button. + <constant name="JOY_XBOX_BACK" value="4" enum="JoyButtonList"> + Xbox game controller back button maps to SDL back button. </constant> - <constant name="JOY_L2" value="6" enum="JoystickList"> - Gamepad left trigger. + <constant name="JOY_XBOX_START" value="6" enum="JoyButtonList"> + Xbox game controller start button maps to SDL start button. </constant> - <constant name="JOY_L3" value="8" enum="JoystickList"> - Gamepad left stick click. + <constant name="JOY_XBOX_HOME" value="5" enum="JoyButtonList"> + Xbox game controller home button maps to SDL guide button. </constant> - <constant name="JOY_R" value="5" enum="JoystickList"> - Gamepad right Shoulder button. + <constant name="JOY_XBOX_LS" value="7" enum="JoyButtonList"> + Xbox game controller left stick button maps to SDL left stick button. </constant> - <constant name="JOY_R2" value="7" enum="JoystickList"> - Gamepad right trigger. + <constant name="JOY_XBOX_RS" value="8" enum="JoyButtonList"> + Xbox game controller right stick button maps to SDL right stick button. </constant> - <constant name="JOY_R3" value="9" enum="JoystickList"> - Gamepad right stick click. + <constant name="JOY_XBOX_LB" value="9" enum="JoyButtonList"> + Xbox game controller left bumper button maps to SDL left shoulder button. </constant> - <constant name="JOY_AXIS_0" value="0" enum="JoystickList"> - Gamepad left stick horizontal axis. + <constant name="JOY_XBOX_RB" value="10" enum="JoyButtonList"> + Xbox game controller right bumper button maps to SDL right shoulder button. </constant> - <constant name="JOY_AXIS_1" value="1" enum="JoystickList"> - Gamepad left stick vertical axis. + <constant name="JOY_BUTTON_MAX" value="36" enum="JoyButtonList"> + The maximum number of game controller buttons. </constant> - <constant name="JOY_AXIS_2" value="2" enum="JoystickList"> - Gamepad right stick horizontal axis. + <constant name="JOY_INVALID_AXIS" value="-1" enum="JoyAxisList"> + An invalid game controller axis. </constant> - <constant name="JOY_AXIS_3" value="3" enum="JoystickList"> - Gamepad right stick vertical axis. + <constant name="JOY_AXIS_LEFT_X" value="0" enum="JoyAxisList"> + Game controller left joystick x-axis. </constant> - <constant name="JOY_AXIS_4" value="4" enum="JoystickList"> - Generic gamepad axis 4. + <constant name="JOY_AXIS_LEFT_Y" value="1" enum="JoyAxisList"> + Game controller left joystick y-axis. </constant> - <constant name="JOY_AXIS_5" value="5" enum="JoystickList"> - Generic gamepad axis 5. + <constant name="JOY_AXIS_RIGHT_X" value="2" enum="JoyAxisList"> + Game controller right joystick x-axis. </constant> - <constant name="JOY_AXIS_6" value="6" enum="JoystickList"> - Gamepad left trigger analog axis. + <constant name="JOY_AXIS_RIGHT_Y" value="3" enum="JoyAxisList"> + Game controller right joystick y-axis. </constant> - <constant name="JOY_AXIS_7" value="7" enum="JoystickList"> - Gamepad right trigger analog axis. + <constant name="JOY_AXIS_TRIGGER_LEFT" value="4" enum="JoyAxisList"> + Game controller left trigger axis. </constant> - <constant name="JOY_AXIS_8" value="8" enum="JoystickList"> - Generic gamepad axis 8. + <constant name="JOY_AXIS_TRIGGER_RIGHT" value="5" enum="JoyAxisList"> + Game controller right trigger axis. </constant> - <constant name="JOY_AXIS_9" value="9" enum="JoystickList"> - Generic gamepad axis 9. + <constant name="JOY_SDL_AXES" value="6" enum="JoyAxisList"> + The number of SDL game controller axes. </constant> - <constant name="JOY_AXIS_MAX" value="10" enum="JoystickList"> - Represents the maximum number of joystick axes supported. + <constant name="JOY_AXIS_0_X" value="0" enum="JoyAxisList"> + Game controller joystick 0 x-axis. </constant> - <constant name="JOY_ANALOG_LX" value="0" enum="JoystickList"> - Gamepad left stick horizontal axis. + <constant name="JOY_AXIS_0_Y" value="1" enum="JoyAxisList"> + Game controller joystick 0 y-axis. </constant> - <constant name="JOY_ANALOG_LY" value="1" enum="JoystickList"> - Gamepad left stick vertical axis. + <constant name="JOY_AXIS_1_X" value="2" enum="JoyAxisList"> + Game controller joystick 1 x-axis. </constant> - <constant name="JOY_ANALOG_RX" value="2" enum="JoystickList"> - Gamepad right stick horizontal axis. + <constant name="JOY_AXIS_1_Y" value="3" enum="JoyAxisList"> + Game controller joystick 1 y-axis. </constant> - <constant name="JOY_ANALOG_RY" value="3" enum="JoystickList"> - Gamepad right stick vertical axis. + <constant name="JOY_AXIS_2_X" value="4" enum="JoyAxisList"> + Game controller joystick 2 x-axis. </constant> - <constant name="JOY_ANALOG_L2" value="6" enum="JoystickList"> - Gamepad left analog trigger. + <constant name="JOY_AXIS_2_Y" value="5" enum="JoyAxisList"> + Game controller joystick 2 y-axis. </constant> - <constant name="JOY_ANALOG_R2" value="7" enum="JoystickList"> - Gamepad right analog trigger. + <constant name="JOY_AXIS_3_X" value="6" enum="JoyAxisList"> + Game controller joystick 3 x-axis. </constant> - <constant name="JOY_VR_ANALOG_TRIGGER" value="2" enum="JoystickList"> - VR Controller analog trigger. + <constant name="JOY_AXIS_3_Y" value="7" enum="JoyAxisList"> + Game controller joystick 3 y-axis. </constant> - <constant name="JOY_VR_ANALOG_GRIP" value="4" enum="JoystickList"> - VR Controller analog grip (side buttons). + <constant name="JOY_AXIS_4_X" value="8" enum="JoyAxisList"> + Game controller joystick 4 x-axis. </constant> - <constant name="JOY_OPENVR_TOUCHPADX" value="0" enum="JoystickList"> - OpenVR touchpad X axis (Joystick axis on Oculus Touch and Windows MR controllers). + <constant name="JOY_AXIS_4_Y" value="9" enum="JoyAxisList"> + Game controller joystick 4 y-axis. </constant> - <constant name="JOY_OPENVR_TOUCHPADY" value="1" enum="JoystickList"> - OpenVR touchpad Y axis (Joystick axis on Oculus Touch and Windows MR controllers). + <constant name="JOY_AXIS_MAX" value="10" enum="JoyAxisList"> + The maximum number of game controller axes. </constant> <constant name="MIDI_MESSAGE_NOTE_OFF" value="8" enum="MidiMessageList"> MIDI note OFF message. diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml new file mode 100644 index 0000000000..6fd08fc4e4 --- /dev/null +++ b/doc/classes/BakedLightmap.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BakedLightmap" inherits="VisualInstance3D" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="bias" type="float" setter="set_bias" getter="get_bias" default="0.0005"> + </member> + <member name="bounces" type="int" setter="set_bounces" getter="get_bounces" default="1"> + </member> + <member name="directional" type="bool" setter="set_directional" getter="is_directional" default="false"> + </member> + <member name="environment_custom_color" type="Color" setter="set_environment_custom_color" getter="get_environment_custom_color"> + </member> + <member name="environment_custom_energy" type="float" setter="set_environment_custom_energy" getter="get_environment_custom_energy"> + </member> + <member name="environment_custom_sky" type="Sky" setter="set_environment_custom_sky" getter="get_environment_custom_sky"> + </member> + <member name="environment_mode" type="int" setter="set_environment_mode" getter="get_environment_mode" enum="BakedLightmap.EnvironmentMode" default="0"> + </member> + <member name="generate_probes_subdiv" type="int" setter="set_generate_probes" getter="get_generate_probes" enum="BakedLightmap.GenerateProbes" default="0"> + </member> + <member name="interior" type="bool" setter="set_interior" getter="is_interior" default="false"> + </member> + <member name="light_data" type="BakedLightmapData" setter="set_light_data" getter="get_light_data"> + </member> + <member name="max_texture_size" type="int" setter="set_max_texture_size" getter="get_max_texture_size" default="16384"> + </member> + <member name="quality" type="int" setter="set_bake_quality" getter="get_bake_quality" enum="BakedLightmap.BakeQuality" default="1"> + </member> + <member name="use_denoiser" type="bool" setter="set_use_denoiser" getter="is_using_denoiser" default="true"> + </member> + </members> + <constants> + <constant name="BAKE_QUALITY_LOW" value="0" enum="BakeQuality"> + </constant> + <constant name="BAKE_QUALITY_MEDIUM" value="1" enum="BakeQuality"> + </constant> + <constant name="BAKE_QUALITY_HIGH" value="2" enum="BakeQuality"> + </constant> + <constant name="BAKE_QUALITY_ULTRA" value="3" enum="BakeQuality"> + </constant> + <constant name="GENERATE_PROBES_DISABLED" value="0" enum="GenerateProbes"> + </constant> + <constant name="GENERATE_PROBES_SUBDIV_4" value="1" enum="GenerateProbes"> + </constant> + <constant name="GENERATE_PROBES_SUBDIV_8" value="2" enum="GenerateProbes"> + </constant> + <constant name="GENERATE_PROBES_SUBDIV_16" value="3" enum="GenerateProbes"> + </constant> + <constant name="GENERATE_PROBES_SUBDIV_32" value="4" enum="GenerateProbes"> + </constant> + <constant name="BAKE_ERROR_OK" value="0" enum="BakeError"> + </constant> + <constant name="BAKE_ERROR_NO_LIGHTMAPPER" value="1" enum="BakeError"> + </constant> + <constant name="BAKE_ERROR_NO_SAVE_PATH" value="2" enum="BakeError"> + </constant> + <constant name="BAKE_ERROR_NO_MESHES" value="3" enum="BakeError"> + </constant> + <constant name="BAKE_ERROR_MESHES_INVALID" value="4" enum="BakeError"> + </constant> + <constant name="BAKE_ERROR_CANT_CREATE_IMAGE" value="5" enum="BakeError"> + </constant> + <constant name="BAKE_ERROR_USER_ABORTED" value="6" enum="BakeError"> + </constant> + <constant name="ENVIRONMENT_MODE_DISABLED" value="0" enum="EnvironmentMode"> + </constant> + <constant name="ENVIRONMENT_MODE_SCENE" value="1" enum="EnvironmentMode"> + </constant> + <constant name="ENVIRONMENT_MODE_CUSTOM_SKY" value="2" enum="EnvironmentMode"> + </constant> + <constant name="ENVIRONMENT_MODE_CUSTOM_COLOR" value="3" enum="EnvironmentMode"> + </constant> + </constants> +</class> diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml new file mode 100644 index 0000000000..026477782a --- /dev/null +++ b/doc/classes/BakedLightmapData.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BakedLightmapData" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_user"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <argument index="1" name="lightmap" type="Rect2"> + </argument> + <argument index="2" name="offset" type="int"> + </argument> + <argument index="3" name="arg3" type="int"> + </argument> + <description> + </description> + </method> + <method name="clear_users"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_user_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_user_path" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="user_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_using_spherical_harmonics" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_uses_spherical_harmonics"> + <return type="void"> + </return> + <argument index="0" name="uses_spherical_harmonics" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="light_texture" type="TextureLayered" setter="set_light_texture" getter="get_light_texture"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 6ff4875364..598b4bd685 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -176,6 +176,7 @@ If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] for objects changed in particular [code]_process[/code] methods. See [enum DopplerTracking] for possible values. </member> <member name="effects" type="CameraEffects" setter="set_effects" getter="get_effects"> + The [CameraEffects] to use for this camera. </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> The [Environment] to use for this camera. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 38e4453cf2..b3a3722836 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -608,8 +608,10 @@ If [code]true[/code], the object draws on top of its parent. </member> <member name="texture_filter" type="int" setter="set_texture_filter" getter="get_texture_filter" enum="CanvasItem.TextureFilter" default="0"> + The texture filtering mode to use on this [CanvasItem]. </member> <member name="texture_repeat" type="int" setter="set_texture_repeat" getter="get_texture_repeat" enum="CanvasItem.TextureRepeat" default="0"> + The texture repeating mode to use on this [CanvasItem]. </member> <member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false"> If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. @@ -666,12 +668,18 @@ The texture filter blends between the nearest four pixels. Use this for most cases where you want to avoid a pixelated style. </constant> <constant name="TEXTURE_FILTER_NEAREST_WITH_MIPMAPS" value="3" enum="TextureFilter"> + The texture filter reads from the nearest pixel in the nearest mipmap. This is the fastest way to read from textures with mipmaps. </constant> <constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS" value="4" enum="TextureFilter"> + The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to [Camera2D] zoom), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. </constant> <constant name="TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC" value="5" enum="TextureFilter"> + The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. + [b]Note:[/b] This texture filter is rarely useful in 2D projects. [constant TEXTURE_FILTER_NEAREST_WITH_MIPMAPS] is usually more appropriate. </constant> <constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC" value="6" enum="TextureFilter"> + The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing. + [b]Note:[/b] This texture filter is rarely useful in 2D projects. [constant TEXTURE_FILTER_LINEAR_WITH_MIPMAPS] is usually more appropriate. </constant> <constant name="TEXTURE_FILTER_MAX" value="7" enum="TextureFilter"> Represents the size of the [enum TextureFilter] enum. diff --git a/doc/classes/Cubemap.xml b/doc/classes/Cubemap.xml index 16431c65c9..61cb1d43f0 100644 --- a/doc/classes/Cubemap.xml +++ b/doc/classes/Cubemap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Cubemap" inherits="TextureLayered" version="4.0"> +<class name="Cubemap" inherits="ImageTextureLayered" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/CubemapArray.xml b/doc/classes/CubemapArray.xml index 03cfd75acf..627baf79e0 100644 --- a/doc/classes/CubemapArray.xml +++ b/doc/classes/CubemapArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CubemapArray" inherits="TextureLayered" version="4.0"> +<class name="CubemapArray" inherits="ImageTextureLayered" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index df50244c77..23dd562653 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -19,7 +19,7 @@ <argument index="1" name="create_visual_debug" type="bool" default="false"> </argument> <description> - Bakes the effect from all [GeometryInstance3D]s marked with [member GeometryInstance3D.use_in_baked_light] and [Light3D]s marked with either [constant Light3D.BAKE_INDIRECT] or [constant Light3D.BAKE_ALL]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [GIProbe]'s data and debug any issues that may be occurring. + Bakes the effect from all [GeometryInstance3D]s marked with [constant GeometryInstance3D.GI_MODE_BAKED] and [Light3D]s marked with either [constant Light3D.BAKE_INDIRECT] or [constant Light3D.BAKE_ALL]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [GIProbe]'s data and debug any issues that may be occurring. </description> </method> <method name="debug_bake"> diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index 518a172973..cc85ce295b 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -9,15 +9,6 @@ <tutorials> </tutorials> <methods> - <method name="get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int" enum="GeometryInstance3D.Flags"> - </argument> - <description> - Returns the [enum GeometryInstance3D.Flags] that have been set for this object. - </description> - </method> <method name="get_shader_instance_uniform" qualifiers="const"> <return type="Variant"> </return> @@ -35,17 +26,6 @@ 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> - <method name="set_flag"> - <return type="void"> - </return> - <argument index="0" name="flag" type="int" enum="GeometryInstance3D.Flags"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - Sets the [enum GeometryInstance3D.Flags] specified. See [enum GeometryInstance3D.Flags] for options. - </description> - </method> <method name="set_shader_instance_uniform"> <return type="void"> </return> @@ -64,6 +44,10 @@ <member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin" default="0.0"> The extra distance added to the GeometryInstance3D's bounding box ([AABB]) to increase its cull box. </member> + <member name="gi_lightmap_scale" type="int" setter="set_lightmap_scale" getter="get_lightmap_scale" enum="GeometryInstance3D.LightmapScale" default="0"> + </member> + <member name="gi_mode" type="int" setter="set_gi_mode" getter="get_gi_mode" enum="GeometryInstance3D.GIMode" default="0"> + </member> <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance" default="0.0"> The GeometryInstance3D's max LOD distance. [b]Note:[/b] This property currently has no effect. @@ -84,11 +68,6 @@ The material override for the whole geometry. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. </member> - <member name="use_dynamic_gi" type="bool" setter="set_flag" getter="get_flag" default="false"> - </member> - <member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag" default="false"> - If [code]true[/code], this GeometryInstance3D will be used when baking lights using a [GIProbe]. - </member> </members> <constants> <constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting"> @@ -106,16 +85,21 @@ 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 will be. </constant> - <constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags"> - Will allow the GeometryInstance3D to be used when baking lights using a [GIProbe]. + <constant name="GI_MODE_DISABLED" value="0" enum="GIMode"> + </constant> + <constant name="GI_MODE_BAKED" value="1" enum="GIMode"> + </constant> + <constant name="GI_MODE_DYNAMIC" value="2" enum="GIMode"> + </constant> + <constant name="LIGHTMAP_SCALE_1X" value="0" enum="LightmapScale"> + </constant> + <constant name="LIGHTMAP_SCALE_2X" value="1" enum="LightmapScale"> </constant> - <constant name="FLAG_USE_DYNAMIC_GI" value="1" enum="Flags"> + <constant name="LIGHTMAP_SCALE_4X" value="2" enum="LightmapScale"> </constant> - <constant name="FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="2" enum="Flags"> - Unused in this class, exposed for consistency with [enum RenderingServer.InstanceFlags]. + <constant name="LIGHTMAP_SCALE_8X" value="3" enum="LightmapScale"> </constant> - <constant name="FLAG_MAX" value="3" enum="Flags"> - Represents the size of the [enum Flags] enum. + <constant name="LIGHTMAP_SCALE_MAX" value="4" enum="LightmapScale"> </constant> </constants> </class> diff --git a/doc/classes/ImageTextureLayered.xml b/doc/classes/ImageTextureLayered.xml new file mode 100644 index 0000000000..d06b44afa9 --- /dev/null +++ b/doc/classes/ImageTextureLayered.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ImageTextureLayered" inherits="TextureLayered" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="create_from_images"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="images" type="Array"> + </argument> + <description> + </description> + </method> + <method name="update_layer"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 0f212e7498..fc3c3776ce 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -96,7 +96,7 @@ <argument index="1" name="axis" type="int"> </argument> <description> - Returns the current value of the joypad axis at given index (see [enum JoystickList]). + Returns the current value of the joypad axis at given index (see [enum JoyAxisList]). </description> </method> <method name="get_joy_axis_index_from_string"> @@ -114,7 +114,7 @@ <argument index="0" name="axis_index" type="int"> </argument> <description> - Receives a [enum JoystickList] axis and returns its equivalent name as a string. + Receives a [enum JoyAxisList] axis and returns its equivalent name as a string. </description> </method> <method name="get_joy_button_index_from_string"> @@ -132,7 +132,7 @@ <argument index="0" name="button_index" type="int"> </argument> <description> - Receives a gamepad button from [enum JoystickList] and returns its equivalent name as a string. + Receives a gamepad button from [enum JoyButtonList] and returns its equivalent name as a string. </description> </method> <method name="get_joy_guid" qualifiers="const"> @@ -235,7 +235,7 @@ <argument index="1" name="button" type="int"> </argument> <description> - Returns [code]true[/code] if you are pressing the joypad button (see [enum JoystickList]). + Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButtonList]). </description> </method> <method name="is_joy_known"> @@ -244,7 +244,7 @@ <argument index="0" name="device" type="int"> </argument> <description> - Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in [enum JoystickList]. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. + Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. </description> </method> <method name="is_key_pressed" qualifiers="const"> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 19aa97e1ec..7876bace75 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -13,7 +13,7 @@ </methods> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" default="0"> - Button identifier. One of the [enum JoystickList] button constants. + Button identifier. One of the [enum JoyButtonList] button constants. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> If [code]true[/code], the button's state is pressed. If [code]false[/code], the button's state is released. diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 01e02b79b1..bfd961ce1f 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -13,7 +13,7 @@ </methods> <members> <member name="axis" type="int" setter="set_axis" getter="get_axis" default="0"> - Axis identifier. Use one of the [enum JoystickList] axis constants. + Axis identifier. Use one of the [enum JoyAxisList] axis constants. </member> <member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value" default="0.0"> Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position. diff --git a/doc/classes/LightmapProbe.xml b/doc/classes/LightmapProbe.xml new file mode 100644 index 0000000000..3af71f3774 --- /dev/null +++ b/doc/classes/LightmapProbe.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LightmapProbe" inherits="Node3D" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Lightmapper.xml b/doc/classes/Lightmapper.xml new file mode 100644 index 0000000000..e80194858a --- /dev/null +++ b/doc/classes/Lightmapper.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Lightmapper" inherits="Reference" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/LightmapperRD.xml b/doc/classes/LightmapperRD.xml new file mode 100644 index 0000000000..0993b28f19 --- /dev/null +++ b/doc/classes/LightmapperRD.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LightmapperRD" inherits="Lightmapper" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 6958c815a6..367099e455 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -102,7 +102,7 @@ </method> </methods> <members> - <member name="lightmap_size_hint" type="Vector2" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint" default="Vector2( 0, 0 )"> + <member name="lightmap_size_hint" type="Vector2i" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint" default="Vector2i( 0, 0 )"> Sets a hint to be used for lightmap resolution. </member> </members> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 569da5c58b..59450b7ea2 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -242,6 +242,12 @@ Removes all items from the [PopupMenu]. </description> </method> + <method name="get_current_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_item_accelerator" qualifiers="const"> <return type="int"> </return> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index dc07dd8837..055af18e25 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -844,38 +844,15 @@ <member name="network/limits/webrtc/max_channel_in_buffer_kb" type="int" setter="" getter="" default="64"> Maximum size (in kiB) for the [WebRTCDataChannel] input buffer. </member> - <member name="network/limits/websocket_client/max_in_buffer_kb" type="int" setter="" getter="" default="64"> - Maximum size (in kiB) for the [WebSocketClient] input buffer. - </member> - <member name="network/limits/websocket_client/max_in_packets" type="int" setter="" getter="" default="1024"> - Maximum number of concurrent input packets for [WebSocketClient]. - </member> - <member name="network/limits/websocket_client/max_out_buffer_kb" type="int" setter="" getter="" default="64"> - Maximum size (in kiB) for the [WebSocketClient] output buffer. - </member> - <member name="network/limits/websocket_client/max_out_packets" type="int" setter="" getter="" default="1024"> - Maximum number of concurrent output packets for [WebSocketClient]. - </member> - <member name="network/limits/websocket_server/max_in_buffer_kb" type="int" setter="" getter="" default="64"> - Maximum size (in kiB) for the [WebSocketServer] input buffer. - </member> - <member name="network/limits/websocket_server/max_in_packets" type="int" setter="" getter="" default="1024"> - Maximum number of concurrent input packets for [WebSocketServer]. - </member> - <member name="network/limits/websocket_server/max_out_buffer_kb" type="int" setter="" getter="" default="64"> - Maximum size (in kiB) for the [WebSocketServer] output buffer. - </member> - <member name="network/limits/websocket_server/max_out_packets" type="int" setter="" getter="" default="1024"> - Maximum number of concurrent output packets for [WebSocketServer]. - </member> <member name="network/remote_fs/page_read_ahead" type="int" setter="" getter="" default="4"> Amount of read ahead used by remote filesystem. Higher values decrease the effects of latency at the cost of higher bandwidth usage. </member> <member name="network/remote_fs/page_size" type="int" setter="" getter="" default="65536"> Page size used by remote filesystem (in bytes). </member> - <member name="network/ssl/certificates" type="String" setter="" getter="" default=""""> - CA certificates bundle to use for SSL connections. If not defined, Godot's internal CA certificates are used. + <member name="network/ssl/certificate_bundle_override" type="String" setter="" getter="" default=""""> + The CA certificates bundle to use for SSL connections. If this is set to a non-empty value, this will [i]override[/i] Godot's default [url=https://github.com/godotengine/godot/blob/master/thirdparty/certs/ca-certificates.crt]Mozilla certificate bundle[/url]. If left empty, the default certificate bundle will be used. + If in doubt, leave this setting empty. </member> <member name="node/name_casing" type="int" setter="" getter="" default="0"> When creating node names automatically, set the type of casing in this project. This is mostly an editor setting. @@ -977,8 +954,32 @@ <member name="rendering/environment/default_environment" type="String" setter="" getter="" default=""""> [Environment] that will be used as a fallback environment in case a scene does not specify its own environment. The default environment is loaded in at scene load time regardless of whether you have set an environment or not. If you do not rely on the fallback environment, it is best to delete [code]default_env.tres[/code], or to specify a different default environment here. </member> + <member name="rendering/gpu_lightmapper/performance/max_rays_per_pass" type="int" setter="" getter="" default="32"> + </member> + <member name="rendering/gpu_lightmapper/performance/max_rays_per_probe_pass" type="int" setter="" getter="" default="64"> + </member> + <member name="rendering/gpu_lightmapper/performance/region_size" type="int" setter="" getter="" default="512"> + </member> + <member name="rendering/gpu_lightmapper/quality/high_quality_probe_ray_count" type="int" setter="" getter="" default="512"> + </member> + <member name="rendering/gpu_lightmapper/quality/high_quality_ray_count" type="int" setter="" getter="" default="256"> + </member> + <member name="rendering/gpu_lightmapper/quality/low_quality_probe_ray_count" type="int" setter="" getter="" default="64"> + </member> + <member name="rendering/gpu_lightmapper/quality/low_quality_ray_count" type="int" setter="" getter="" default="16"> + </member> + <member name="rendering/gpu_lightmapper/quality/medium_quality_probe_ray_count" type="int" setter="" getter="" default="256"> + </member> + <member name="rendering/gpu_lightmapper/quality/medium_quality_ray_count" type="int" setter="" getter="" default="64"> + </member> + <member name="rendering/gpu_lightmapper/quality/ultra_quality_probe_ray_count" type="int" setter="" getter="" default="2048"> + </member> + <member name="rendering/gpu_lightmapper/quality/ultra_quality_ray_count" type="int" setter="" getter="" default="1024"> + </member> <member name="rendering/high_end/global_shader_variables_buffer_size" type="int" setter="" getter="" default="65536"> </member> + <member name="rendering/lightmapper/probe_capture_update_speed" type="float" setter="" getter="" default="15"> + </member> <member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter="" default="128000"> Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves. </member> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 648f4d0107..d8be6d4bd7 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -1282,7 +1282,7 @@ <argument index="1" name="base" type="RID"> </argument> <description> - Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap capture, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario. + Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario. </description> </method> <method name="instance_set_blend_shape_weight"> @@ -1377,19 +1377,6 @@ Sets the world space transform of the instance. Equivalent to [member Node3D.transform]. </description> </method> - <method name="instance_set_use_lightmap"> - <return type="void"> - </return> - <argument index="0" name="instance" type="RID"> - </argument> - <argument index="1" name="lightmap_instance" type="RID"> - </argument> - <argument index="2" name="lightmap" type="RID"> - </argument> - <description> - Sets the lightmap to use with this instance. - </description> - </method> <method name="instance_set_visible"> <return type="void"> </return> @@ -1584,115 +1571,6 @@ Sets whether GI probes capture light information from this light. </description> </method> - <method name="lightmap_capture_create"> - <return type="RID"> - </return> - <description> - Creates a lightmap capture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]lightmap_capture_*[/code] RenderingServer functions. - Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. - To place in a scene, attach this lightmap capture to an instance using [method instance_set_base] using the returned RID. - </description> - </method> - <method name="lightmap_capture_get_bounds" qualifiers="const"> - <return type="AABB"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <description> - Returns the size of the lightmap capture area. - </description> - </method> - <method name="lightmap_capture_get_energy" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <description> - Returns the energy multiplier used by the lightmap capture. - </description> - </method> - <method name="lightmap_capture_get_octree" qualifiers="const"> - <return type="PackedByteArray"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <description> - Returns the octree used by the lightmap capture. - </description> - </method> - <method name="lightmap_capture_get_octree_cell_subdiv" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <description> - Returns the cell subdivision amount used by this lightmap capture's octree. - </description> - </method> - <method name="lightmap_capture_get_octree_cell_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <description> - Returns the cell transform for this lightmap capture's octree. - </description> - </method> - <method name="lightmap_capture_set_bounds"> - <return type="void"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <argument index="1" name="bounds" type="AABB"> - </argument> - <description> - Sets the size of the area covered by the lightmap capture. - </description> - </method> - <method name="lightmap_capture_set_energy"> - <return type="void"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <argument index="1" name="energy" type="float"> - </argument> - <description> - Sets the energy multiplier for this lightmap capture. - </description> - </method> - <method name="lightmap_capture_set_octree"> - <return type="void"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <argument index="1" name="octree" type="PackedByteArray"> - </argument> - <description> - Sets the octree to be used by this lightmap capture. - </description> - </method> - <method name="lightmap_capture_set_octree_cell_subdiv"> - <return type="void"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <argument index="1" name="subdiv" type="int"> - </argument> - <description> - Sets the subdivision level of this lightmap capture's octree. - </description> - </method> - <method name="lightmap_capture_set_octree_cell_transform"> - <return type="void"> - </return> - <argument index="0" name="capture" type="RID"> - </argument> - <argument index="1" name="xform" type="Transform"> - </argument> - <description> - Sets the octree cell transform for this lightmap capture's octree. - </description> - </method> <method name="make_sphere_mesh"> <return type="RID"> </return> @@ -3725,8 +3603,8 @@ <constant name="INSTANCE_GI_PROBE" value="8" enum="InstanceType"> The instance is a GI probe. </constant> - <constant name="INSTANCE_LIGHTMAP_CAPTURE" value="9" enum="InstanceType"> - The instance is a lightmap capture. + <constant name="INSTANCE_LIGHTMAP" value="9" enum="InstanceType"> + The instance is a lightmap. </constant> <constant name="INSTANCE_MAX" value="10" enum="InstanceType"> Represents the size of the [enum InstanceType] enum. diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index 713f2c1726..ad0c438f98 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -6,7 +6,7 @@ <description> Godot loads resources in the editor or in exported games using ResourceFormatLoaders. They are queried automatically via the [ResourceLoader] singleton, or when a resource with internal dependencies is loaded. Each file type may load as a different resource type, so multiple ResourceFormatLoaders are registered in the engine. Extending this class allows you to define your own loader. Be sure to respect the documented return types and values. You should give it a global class name with [code]class_name[/code] for it to be registered. Like built-in ResourceFormatLoaders, it will be called automatically when loading resources of its handled type(s). You may also implement a [ResourceFormatSaver]. - [b]Note:[/b] You can also extend [EditorImportPlugin] if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. For example, it's better to import [code].png[/code] textures as [code].stex[/code] ([StreamTexture]) first, so they can be loaded with better efficiency on the graphics card. + [b]Note:[/b] You can also extend [EditorImportPlugin] if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. For example, it's better to import [code].png[/code] textures as [code].stex[/code] ([StreamTexture2D]) first, so they can be loaded with better efficiency on the graphics card. </description> <tutorials> </tutorials> diff --git a/doc/classes/StreamCubemap.xml b/doc/classes/StreamCubemap.xml new file mode 100644 index 0000000000..16648266eb --- /dev/null +++ b/doc/classes/StreamCubemap.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamCubemap" inherits="StreamTextureLayered" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/StreamCubemapArray.xml b/doc/classes/StreamCubemapArray.xml new file mode 100644 index 0000000000..b84973fd14 --- /dev/null +++ b/doc/classes/StreamCubemapArray.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamCubemapArray" inherits="StreamTextureLayered" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture2D.xml index 03afcb5b0d..214298475c 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamTexture" inherits="Texture2D" version="4.0"> +<class name="StreamTexture2D" inherits="Texture2D" version="4.0"> <brief_description> A [code].stex[/code] texture. </brief_description> diff --git a/doc/classes/StreamTexture2DArray.xml b/doc/classes/StreamTexture2DArray.xml new file mode 100644 index 0000000000..ec545b24d0 --- /dev/null +++ b/doc/classes/StreamTexture2DArray.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamTexture2DArray" inherits="StreamTextureLayered" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/StreamTextureLayered.xml b/doc/classes/StreamTextureLayered.xml new file mode 100644 index 0000000000..10a7aae976 --- /dev/null +++ b/doc/classes/StreamTextureLayered.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamTextureLayered" inherits="TextureLayered" 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=""""> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 03f62732c4..0dd6923129 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -620,6 +620,19 @@ Returns [code]true[/code] if this string contains a valid IP address. </description> </method> + <method name="join"> + <return type="String"> + </return> + <argument index="0" name="parts" type="PackedStringArray"> + </argument> + <description> + Return a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. + Example: + [codeblock] + print(", ".join(["One", "Two", "Three", "Four"])) + [/codeblock] + </description> + </method> <method name="json_escape"> <return type="String"> </return> @@ -837,19 +850,6 @@ Returns a copy of the string with characters removed from the right. </description> </method> - <method name="join"> - <return type="String"> - </return> - <argument index="0" name="parts" type="PackedStringArray"> - </argument> - <description> - Return a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. - Example: - [codeblock] - print(", ".join(["One", "Two", "Three", "Four"])) - [/codeblock] - </description> - </method> <method name="sha1_buffer"> <return type="PackedByteArray"> </return> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index bb2d355bf6..e553518b39 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -343,26 +343,26 @@ Select all the text. </description> </method> - <method name="set_line_as_hidden"> + <method name="set_line"> <return type="void"> </return> <argument index="0" name="line" type="int"> </argument> - <argument index="1" name="enable" type="bool"> + <argument index="1" name="new_text" type="String"> </argument> <description> - If [code]true[/code], hides the line of the specified index. + Sets the text for a specific line. </description> </method> - <method name="set_line"> + <method name="set_line_as_hidden"> <return type="void"> </return> <argument index="0" name="line" type="int"> </argument> - <argument index="1" name="new_text" type="String"> + <argument index="1" name="enable" type="bool"> </argument> <description> - Sets the text for a specific line. + If [code]true[/code], hides the line of the specified index. </description> </method> <method name="toggle_fold_line"> diff --git a/doc/classes/Texture2DArray.xml b/doc/classes/Texture2DArray.xml index 657506120e..bb9283803d 100644 --- a/doc/classes/Texture2DArray.xml +++ b/doc/classes/Texture2DArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Texture2DArray" inherits="TextureLayered" version="4.0"> +<class name="Texture2DArray" inherits="ImageTextureLayered" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index 66e5b69ab4..d81c3c7c5a 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -9,14 +9,6 @@ <tutorials> </tutorials> <methods> - <method name="create_from_images"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="images" type="Array"> - </argument> - <description> - </description> - </method> <method name="get_format" qualifiers="const"> <return type="int" enum="Image.Format"> </return> @@ -40,6 +32,12 @@ Returns an [Image] resource with the data from specified [code]layer[/code]. </description> </method> + <method name="get_layered_type" qualifiers="const"> + <return type="int" enum="TextureLayered.LayeredType"> + </return> + <description> + </description> + </method> <method name="get_layers" qualifiers="const"> <return type="int"> </return> @@ -53,17 +51,19 @@ Returns the width of the texture. Width is typically represented by the X-axis. </description> </method> - <method name="update_layer"> - <return type="void"> + <method name="has_mipmaps" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="image" type="Image"> - </argument> - <argument index="1" name="layer" type="int"> - </argument> <description> </description> </method> </methods> <constants> + <constant name="LAYERED_TYPE_2D_ARRAY" value="0" enum="LayeredType"> + </constant> + <constant name="LAYERED_TYPE_CUBEMAP" value="1" enum="LayeredType"> + </constant> + <constant name="LAYERED_TYPE_CUBEMAP_ARRAY" value="2" enum="LayeredType"> + </constant> </constants> </class> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index bfe6983f06..9df2b656f4 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -80,13 +80,13 @@ Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]). </description> </method> - <method name="get_used_cells_by_id" qualifiers="const"> + <method name="get_used_cells_by_index" qualifiers="const"> <return type="Vector2i[]"> </return> - <argument index="0" name="id" type="int"> + <argument index="0" name="index" type="int"> </argument> <description> - Returns an array of all cells with the given tile [code]id[/code]. + Returns an array of all cells with the given tile [code]index[/code]. </description> </method> <method name="get_used_rect"> @@ -273,7 +273,7 @@ <member name="cell_tile_origin" type="int" setter="set_tile_origin" getter="get_tile_origin" enum="TileMap.TileOrigin" default="0"> Position for tile origin. See [enum TileOrigin] for possible values. </member> - <member name="cell_y_sort" type="bool" setter="set_y_sort_mode" getter="is_y_sort_mode_enabled" default="false"> + <member name="cell_y_sort" type="bool" setter="set_y_sort_enabled" getter="is_y_sort_enabled" default="false"> If [code]true[/code], the TileMap's children will be drawn in order of their Y coordinate. </member> <member name="centered_textures" type="bool" setter="set_centered_textures" getter="is_centered_textures_enabled" default="false"> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index a8a17370c2..126d6b4180 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -249,6 +249,14 @@ <description> </description> </method> + <method name="get_suffix" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> <method name="get_text" qualifiers="const"> <return type="String"> </return> @@ -572,6 +580,16 @@ If [code]true[/code], the given column is selectable. </description> </method> + <method name="set_suffix"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> + <description> + </description> + </method> <method name="set_text"> <return type="void"> </return> diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index 2d8382b7e3..e66f21a0e7 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -16,7 +16,7 @@ The [RID] of this world's canvas resource. Used by the [RenderingServer] for 2D drawing. </member> <member name="direct_space_state" type="PhysicsDirectSpaceState2D" setter="" getter="get_direct_space_state"> - The state of this world's physics space. This allows arbitrary querying for collision. + Direct access to the world's physics 2D space state. Used for querying current and potential collisions. Must only be accessed from the main thread within [code]_physics_process(delta)[/code]. </member> <member name="space" type="RID" setter="" getter="get_space"> The [RID] of this world's physics space resource. Used by the [PhysicsServer2D] for 2D physics, treating it as both a space and an area. diff --git a/doc/classes/World3D.xml b/doc/classes/World3D.xml index 4224a2a2c3..6d3b94794e 100644 --- a/doc/classes/World3D.xml +++ b/doc/classes/World3D.xml @@ -15,7 +15,7 @@ <member name="camera_effects" type="CameraEffects" setter="set_camera_effects" getter="get_camera_effects"> </member> <member name="direct_space_state" type="PhysicsDirectSpaceState3D" setter="" getter="get_direct_space_state"> - The World3D's physics direct space state, used for making various queries. Might be used only during [code]_physics_process[/code]. + Direct access to the world's physics 3D space state. Used for querying current and potential collisions. Must only be accessed from within [code]_physics_process(delta)[/code]. </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> The World3D's [Environment]. diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index e4a06a80db..8e80eb9a32 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -62,7 +62,7 @@ <argument index="0" name="button" type="int"> </argument> <description> - Returns [code]true[/code] if the button at index [code]button[/code] is pressed. See [enum JoystickList], in particular the [code]JOY_VR_*[/code] constants. + Returns [code]true[/code] if the button at index [code]button[/code] is pressed. See [enum JoyButtonList]. </description> </method> </methods> |