diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/@GlobalScope.xml | 267 | ||||
| -rw-r--r-- | doc/classes/Array.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Camera3D.xml | 1 | ||||
| -rw-r--r-- | doc/classes/CanvasItem.xml | 8 | ||||
| -rw-r--r-- | doc/classes/Dictionary.xml | 1 | ||||
| -rw-r--r-- | doc/classes/Image.xml | 7 | ||||
| -rw-r--r-- | doc/classes/ImageTextureLayered.xml | 31 | ||||
| -rw-r--r-- | doc/classes/Input.xml | 10 | ||||
| -rw-r--r-- | doc/classes/InputEventJoypadButton.xml | 2 | ||||
| -rw-r--r-- | doc/classes/InputEventJoypadMotion.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Lightmapper.xml | 13 | ||||
| -rw-r--r-- | doc/classes/Node.xml | 12 | ||||
| -rw-r--r-- | doc/classes/Object.xml | 2 | ||||
| -rw-r--r-- | doc/classes/PhysicalSkyMaterial.xml | 3 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 24 | ||||
| -rw-r--r-- | doc/classes/World2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/World3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/XRController3D.xml | 2 | ||||
| -rw-r--r-- | doc/translations/classes.pot | 20 | ||||
| -rw-r--r-- | doc/translations/fr.po | 20 |
20 files changed, 212 insertions, 219 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 602ad43103..03eb733e54 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -943,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 name="JOY_INVALID_BUTTON" value="-1" enum="JoyButtonList"> + An invalid game controller button. </constant> - <constant name="JOY_BUTTON_1" value="1" enum="JoystickList"> - Gamepad button 1. + <constant name="JOY_BUTTON_A" value="0" enum="JoyButtonList"> + Game controller SDL button A. </constant> - <constant name="JOY_BUTTON_2" value="2" enum="JoystickList"> - Gamepad button 2. + <constant name="JOY_BUTTON_B" value="1" enum="JoyButtonList"> + Game controller SDL button B. </constant> - <constant name="JOY_BUTTON_3" value="3" enum="JoystickList"> - Gamepad button 3. + <constant name="JOY_BUTTON_X" value="2" enum="JoyButtonList"> + Game controller SDL button X. </constant> - <constant name="JOY_BUTTON_4" value="4" enum="JoystickList"> - Gamepad button 4. + <constant name="JOY_BUTTON_Y" value="3" enum="JoyButtonList"> + Game controller SDL button Y. </constant> - <constant name="JOY_BUTTON_5" value="5" enum="JoystickList"> - Gamepad button 5. + <constant name="JOY_BUTTON_BACK" value="4" enum="JoyButtonList"> + Game controller SDL back button. </constant> - <constant name="JOY_BUTTON_6" value="6" enum="JoystickList"> - Gamepad button 6. + <constant name="JOY_BUTTON_GUIDE" value="5" enum="JoyButtonList"> + Game controller SDL guide button. </constant> - <constant name="JOY_BUTTON_7" value="7" enum="JoystickList"> - Gamepad button 7. + <constant name="JOY_BUTTON_START" value="6" enum="JoyButtonList"> + Game controller SDL start button. </constant> - <constant name="JOY_BUTTON_8" value="8" enum="JoystickList"> - Gamepad button 8. + <constant name="JOY_BUTTON_LEFT_STICK" value="7" enum="JoyButtonList"> + Game controller SDL left stick button. </constant> - <constant name="JOY_BUTTON_9" value="9" enum="JoystickList"> - Gamepad button 9. + <constant name="JOY_BUTTON_RIGHT_STICK" value="8" enum="JoyButtonList"> + Game controller SDL right stick button. </constant> - <constant name="JOY_BUTTON_10" value="10" enum="JoystickList"> - Gamepad button 10. + <constant name="JOY_BUTTON_LEFT_SHOULDER" value="9" enum="JoyButtonList"> + Game controller SDL left shoulder button. </constant> - <constant name="JOY_BUTTON_11" value="11" enum="JoystickList"> - Gamepad button 11. + <constant name="JOY_BUTTON_RIGHT_SHOULDER" value="10" enum="JoyButtonList"> + Game controller SDL right shoulder button. </constant> - <constant name="JOY_BUTTON_12" value="12" enum="JoystickList"> - Gamepad button 12. + <constant name="JOY_BUTTON_DPAD_UP" value="11" enum="JoyButtonList"> + Game controller SDL D-pad up button. </constant> - <constant name="JOY_BUTTON_13" value="13" enum="JoystickList"> - Gamepad button 13. + <constant name="JOY_BUTTON_DPAD_DOWN" value="12" enum="JoyButtonList"> + Game controller SDL D-pad down button. </constant> - <constant name="JOY_BUTTON_14" value="14" enum="JoystickList"> - Gamepad button 14. + <constant name="JOY_BUTTON_DPAD_LEFT" value="13" enum="JoyButtonList"> + Game controller SDL D-pad left button. </constant> - <constant name="JOY_BUTTON_15" value="15" enum="JoystickList"> - Gamepad button 15. + <constant name="JOY_BUTTON_DPAD_RIGHT" value="14" enum="JoyButtonList"> + Game controller SDL D-pad right button. </constant> - <constant name="JOY_BUTTON_MAX" value="16" enum="JoystickList"> - Represents the maximum number of joystick buttons supported. + <constant name="JOY_SDL_BUTTONS" value="15" enum="JoyButtonList"> + The number of SDL game controller buttons. </constant> - <constant name="JOY_SONY_CIRCLE" value="1" enum="JoystickList"> - DualShock circle button. + <constant name="JOY_SONY_X" value="0" enum="JoyButtonList"> + Sony DualShock controller X button maps to SDL button A. </constant> - <constant name="JOY_SONY_X" value="0" enum="JoystickList"> - DualShock 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_SONY_SQUARE" value="2" enum="JoystickList"> - DualShock square button. + <constant name="JOY_SONY_CIRCLE" value="1" enum="JoyButtonList"> + Sony DualShock controller circle button maps to SDL button B. </constant> - <constant name="JOY_SONY_TRIANGLE" value="3" enum="JoystickList"> - DualShock triangle button. + <constant name="JOY_SONY_SQUARE" value="2" enum="JoyButtonList"> + Sony DualShock controller square button maps to SDL button X. </constant> - <constant name="JOY_XBOX_B" value="1" enum="JoystickList"> - Xbox controller B button. + <constant name="JOY_SONY_TRIANGLE" value="3" enum="JoyButtonList"> + Sony DualShock controller triangle button maps to SDL button Y. </constant> - <constant name="JOY_XBOX_A" value="0" enum="JoystickList"> - Xbox controller A button. + <constant name="JOY_SONY_SELECT" value="4" enum="JoyButtonList"> + Sony DualShock controller select button maps to SDL back button. </constant> - <constant name="JOY_XBOX_X" value="2" enum="JoystickList"> - Xbox controller X button. + <constant name="JOY_SONY_START" value="6" enum="JoyButtonList"> + Sony DualShock controller start button maps to SDL start button. </constant> - <constant name="JOY_XBOX_Y" value="3" enum="JoystickList"> - Xbox controller Y button. + <constant name="JOY_SONY_PS" value="5" enum="JoyButtonList"> + Sony DualShock controller PS button maps to SDL guide button. </constant> - <constant name="JOY_DS_A" value="1" enum="JoystickList"> - Nintendo controller A button. + <constant name="JOY_SONY_L1" value="9" enum="JoyButtonList"> + Sony DualShock controller L1 button maps to SDL left shoulder button. </constant> - <constant name="JOY_DS_B" value="0" enum="JoystickList"> - Nintendo controller B button. + <constant name="JOY_SONY_R1" value="10" enum="JoyButtonList"> + Sony DualShock controller R1 button maps to SDL right shoulder button. </constant> - <constant name="JOY_DS_X" value="3" enum="JoystickList"> - Nintendo controller X button. + <constant name="JOY_SONY_L3" value="7" enum="JoyButtonList"> + Sony DualShock controller L3 button maps to SDL left stick button. </constant> - <constant name="JOY_DS_Y" value="2" enum="JoystickList"> - Nintendo controller Y button. + <constant name="JOY_SONY_R3" value="8" enum="JoyButtonList"> + Sony DualShock controller R3 button maps to SDL right stick button. </constant> - <constant name="JOY_VR_GRIP" value="2" enum="JoystickList"> - Grip (side) buttons on a VR controller. + <constant name="JOY_XBOX_A" value="0" enum="JoyButtonList"> + Xbox game controller A button maps to SDL button A. </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_XBOX_B" value="1" enum="JoyButtonList"> + Xbox game controller B button maps to SDL button B. </constant> - <constant name="JOY_VR_TRIGGER" value="15" enum="JoystickList"> - Trigger on a VR controller. + <constant name="JOY_XBOX_X" value="2" enum="JoyButtonList"> + Xbox game controller X button maps to SDL button X. </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_XBOX_Y" value="3" enum="JoyButtonList"> + Xbox game controller Y button maps to SDL button Y. </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_XBOX_BACK" value="4" enum="JoyButtonList"> + Xbox game controller back button maps to SDL back button. </constant> - <constant name="JOY_OCULUS_MENU" value="3" enum="JoystickList"> - Menu button on either Oculus Touch controller. + <constant name="JOY_XBOX_START" value="6" enum="JoyButtonList"> + Xbox game controller start button maps to SDL start 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_XBOX_HOME" value="5" enum="JoyButtonList"> + Xbox game controller home button maps to SDL guide button. </constant> - <constant name="JOY_SELECT" value="10" enum="JoystickList"> - Gamepad button Select. + <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_START" value="11" enum="JoystickList"> - Gamepad button Start. + <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_DPAD_UP" value="12" enum="JoystickList"> - Gamepad DPad up. + <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_DPAD_DOWN" value="13" enum="JoystickList"> - Gamepad DPad down. + <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_DPAD_LEFT" value="14" enum="JoystickList"> - Gamepad DPad left. + <constant name="JOY_BUTTON_MAX" value="36" enum="JoyButtonList"> + The maximum number of game controller buttons. </constant> - <constant name="JOY_DPAD_RIGHT" value="15" enum="JoystickList"> - Gamepad DPad right. + <constant name="JOY_INVALID_AXIS" value="-1" enum="JoyAxisList"> + An invalid game controller axis. </constant> - <constant name="JOY_L" value="4" enum="JoystickList"> - Gamepad left Shoulder button. + <constant name="JOY_AXIS_LEFT_X" value="0" enum="JoyAxisList"> + Game controller left joystick x-axis. </constant> - <constant name="JOY_L2" value="6" enum="JoystickList"> - Gamepad left trigger. + <constant name="JOY_AXIS_LEFT_Y" value="1" enum="JoyAxisList"> + Game controller left joystick y-axis. </constant> - <constant name="JOY_L3" value="8" enum="JoystickList"> - Gamepad left stick click. + <constant name="JOY_AXIS_RIGHT_X" value="2" enum="JoyAxisList"> + Game controller right joystick x-axis. </constant> - <constant name="JOY_R" value="5" enum="JoystickList"> - Gamepad right Shoulder button. + <constant name="JOY_AXIS_RIGHT_Y" value="3" enum="JoyAxisList"> + Game controller right joystick y-axis. </constant> - <constant name="JOY_R2" value="7" enum="JoystickList"> - Gamepad right trigger. + <constant name="JOY_AXIS_TRIGGER_LEFT" value="4" enum="JoyAxisList"> + Game controller left trigger axis. </constant> - <constant name="JOY_R3" value="9" enum="JoystickList"> - Gamepad right stick click. + <constant name="JOY_AXIS_TRIGGER_RIGHT" value="5" enum="JoyAxisList"> + Game controller right trigger axis. </constant> - <constant name="JOY_AXIS_0" value="0" enum="JoystickList"> - Gamepad left stick horizontal axis. + <constant name="JOY_SDL_AXES" value="6" enum="JoyAxisList"> + The number of SDL game controller axes. </constant> - <constant name="JOY_AXIS_1" value="1" enum="JoystickList"> - Gamepad left stick vertical axis. + <constant name="JOY_AXIS_0_X" value="0" enum="JoyAxisList"> + Game controller joystick 0 x-axis. </constant> - <constant name="JOY_AXIS_2" value="2" enum="JoystickList"> - Gamepad right stick horizontal axis. + <constant name="JOY_AXIS_0_Y" value="1" enum="JoyAxisList"> + Game controller joystick 0 y-axis. </constant> - <constant name="JOY_AXIS_3" value="3" enum="JoystickList"> - Gamepad right stick vertical axis. + <constant name="JOY_AXIS_1_X" value="2" enum="JoyAxisList"> + Game controller joystick 1 x-axis. </constant> - <constant name="JOY_AXIS_4" value="4" enum="JoystickList"> - Generic gamepad axis 4. + <constant name="JOY_AXIS_1_Y" value="3" enum="JoyAxisList"> + Game controller joystick 1 y-axis. </constant> - <constant name="JOY_AXIS_5" value="5" enum="JoystickList"> - Generic gamepad axis 5. + <constant name="JOY_AXIS_2_X" value="4" enum="JoyAxisList"> + Game controller joystick 2 x-axis. </constant> - <constant name="JOY_AXIS_6" value="6" enum="JoystickList"> - Gamepad left trigger analog axis. + <constant name="JOY_AXIS_2_Y" value="5" enum="JoyAxisList"> + Game controller joystick 2 y-axis. </constant> - <constant name="JOY_AXIS_7" value="7" enum="JoystickList"> - Gamepad right trigger analog axis. + <constant name="JOY_AXIS_3_X" value="6" enum="JoyAxisList"> + Game controller joystick 3 x-axis. </constant> - <constant name="JOY_AXIS_8" value="8" enum="JoystickList"> - Generic gamepad axis 8. + <constant name="JOY_AXIS_3_Y" value="7" enum="JoyAxisList"> + Game controller joystick 3 y-axis. </constant> - <constant name="JOY_AXIS_9" value="9" enum="JoystickList"> - Generic gamepad axis 9. + <constant name="JOY_AXIS_4_X" value="8" enum="JoyAxisList"> + Game controller joystick 4 x-axis. </constant> - <constant name="JOY_AXIS_MAX" value="10" enum="JoystickList"> - Represents the maximum number of joystick axes supported. + <constant name="JOY_AXIS_4_Y" value="9" enum="JoyAxisList"> + Game controller joystick 4 y-axis. </constant> - <constant name="JOY_ANALOG_LX" value="0" enum="JoystickList"> - Gamepad left stick horizontal axis. - </constant> - <constant name="JOY_ANALOG_LY" value="1" enum="JoystickList"> - Gamepad left stick vertical axis. - </constant> - <constant name="JOY_ANALOG_RX" value="2" enum="JoystickList"> - Gamepad right stick horizontal axis. - </constant> - <constant name="JOY_ANALOG_RY" value="3" enum="JoystickList"> - Gamepad right stick vertical axis. - </constant> - <constant name="JOY_ANALOG_L2" value="6" enum="JoystickList"> - Gamepad left analog trigger. - </constant> - <constant name="JOY_ANALOG_R2" value="7" enum="JoystickList"> - Gamepad right analog trigger. - </constant> - <constant name="JOY_VR_ANALOG_TRIGGER" value="2" enum="JoystickList"> - VR Controller analog trigger. - </constant> - <constant name="JOY_VR_ANALOG_GRIP" value="4" enum="JoystickList"> - VR Controller analog grip (side buttons). - </constant> - <constant name="JOY_OPENVR_TOUCHPADX" value="0" enum="JoystickList"> - OpenVR touchpad X axis (Joystick axis on Oculus Touch and Windows MR controllers). - </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/Array.xml b/doc/classes/Array.xml index 20296bbf45..7593f7dff4 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -20,7 +20,7 @@ var array2 = [3, "Four"] print(array1 + array2) # ["One", 2, 3, "Four"] [/codeblock] - Arrays are always passed by reference. + [b]Note:[/b] Arrays are always passed by reference. To get a copy of an array which can be modified independently of the original array, use [method duplicate]. </description> <tutorials> </tutorials> 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/Dictionary.xml b/doc/classes/Dictionary.xml index e982e00d6d..385f4b7e59 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -7,6 +7,7 @@ Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are composed of pairs of keys (which must be unique) and values. Dictionaries will preserve the insertion order when adding elements, even though this may not be reflected when printing the dictionary. In other programming languages, this data structure is sometimes referred to as an hash map or associative array. You can define a dictionary by placing a comma-separated list of [code]key: value[/code] pairs in curly braces [code]{}[/code]. Erasing elements while iterating over them [b]is not supported[/b] and will result in undefined behavior. + [b]Note:[/b] Dictionaries are always passed by reference. To get a copy of a dictionary which can be modified independently of the original dictionary, use [method duplicate]. Creating a dictionary: [codeblock] var my_dir = {} # Creates an empty dictionary. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 99253e8840..55d2275194 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -190,13 +190,6 @@ <description> </description> </method> - <method name="expand_x2_hq2x"> - <return type="void"> - </return> - <description> - Stretches the image and enlarges it by a factor of 2. No interpolation is done. - </description> - </method> <method name="fill"> <return type="void"> </return> 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/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/Node.xml b/doc/classes/Node.xml index 0c0d16753a..04c8d2bf57 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -129,21 +129,19 @@ child_node.get_parent().remove_child(child_node) add_child(child_node) [/codeblock] - If you need the child node to be added below a specific node in the list of children, use [method add_child_below_node] instead of this method. + If you need the child node to be added below a specific node in the list of children, use [method add_sibling] instead of this method. [b]Note:[/b] If you want a child to be persisted to a [PackedScene], you must set [member owner] in addition to calling [method add_child]. This is typically relevant for [url=https://godot.readthedocs.io/en/latest/tutorials/misc/running_code_in_the_editor.html]tool scripts[/url] and [url=https://godot.readthedocs.io/en/latest/tutorials/plugins/editor/index.html]editor plugins[/url]. If [method add_child] is called without setting [member owner], the newly added [Node] will not be visible in the scene tree, though it will be visible in the 2D/3D view. </description> </method> - <method name="add_child_below_node"> + <method name="add_sibling"> <return type="void"> </return> - <argument index="0" name="preceding_node" type="Node"> + <argument index="0" name="sibling" type="Node"> </argument> - <argument index="1" name="node" type="Node"> - </argument> - <argument index="2" name="legible_unique_name" type="bool" default="false"> + <argument index="1" name="legible_unique_name" type="bool" default="false"> </argument> <description> - Adds a child node below the [code]preceding_node[/code]. + Adds a [code]sibling[/code] node to current's node parent, at the the same level as that node, right below it. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have an human-readable name based on the name of the node being instanced instead of its type. Use [method add_child] instead of this method if you don't need the child node to be added below a specific node in the list of children. </description> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 35e87d1a2a..87bcab25db 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -192,7 +192,7 @@ <return type="void"> </return> <description> - Deletes the object from memory. Any pre-existing reference to the freed object will now return [code]null[/code]. + Deletes the object from memory. Any pre-existing reference to the freed object will become invalid, e.g. [code]is_instance_valid(object)[/code] will return [code]false[/code]. </description> </method> <method name="get" qualifiers="const"> diff --git a/doc/classes/PhysicalSkyMaterial.xml b/doc/classes/PhysicalSkyMaterial.xml index 89b43158dc..2e0f9c52f2 100644 --- a/doc/classes/PhysicalSkyMaterial.xml +++ b/doc/classes/PhysicalSkyMaterial.xml @@ -31,6 +31,9 @@ <member name="mie_eccentricity" type="float" setter="set_mie_eccentricity" getter="get_mie_eccentricity" default="0.8"> Controls the direction of the mie scattering. A value of [code]1[/code] means that when light hits a particle it passing through straight forward. A value of [code]-1[/code] means that all light is scatter backwards. </member> + <member name="night_sky" type="Texture2D" setter="set_night_sky" getter="get_night_sky"> + [Texture2D] for the night sky. This is added to the sky, so if it is bright enough, it may be visible during the day. + </member> <member name="rayleigh_coefficient" type="float" setter="set_rayleigh_coefficient" getter="get_rayleigh_coefficient" default="2.0"> Controls the strength of the rayleigh scattering. Rayleigh scattering results from light colliding with small particles. It is responsible for the blue color of the sky. </member> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 92f116c7ec..055af18e25 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -844,30 +844,6 @@ <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> 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> diff --git a/doc/translations/classes.pot b/doc/translations/classes.pot index d58b9d9472..28db7e4e04 100644 --- a/doc/translations/classes.pot +++ b/doc/translations/classes.pot @@ -24656,7 +24656,7 @@ msgstr "" #: doc/classes/Input.xml:99 msgid "" "Returns the current value of the joypad axis at given index (see [enum " -"JoystickList])." +"JoyAxisList])." msgstr "" #: doc/classes/Input.xml:108 @@ -24665,7 +24665,7 @@ msgstr "" #: doc/classes/Input.xml:117 msgid "" -"Receives a [enum JoystickList] axis and returns its equivalent name as a " +"Receives a [enum JoyAxisList] axis and returns its equivalent name as a " "string." msgstr "" @@ -24675,7 +24675,7 @@ msgstr "" #: doc/classes/Input.xml:135 msgid "" -"Receives a gamepad button from [enum JoystickList] and returns its " +"Receives a gamepad button from [enum JoyButtonList] and returns its " "equivalent name as a string." msgstr "" @@ -24750,15 +24750,14 @@ msgstr "" #: doc/classes/Input.xml:238 msgid "" "Returns [code]true[/code] if you are pressing the joypad button (see [enum " -"JoystickList])." +"JoyButtonList])." msgstr "" #: doc/classes/Input.xml:247 msgid "" "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." +"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." msgstr "" #: doc/classes/Input.xml:256 @@ -25150,7 +25149,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadButton.xml:16 -msgid "Button identifier. One of the [enum JoystickList] button constants." +msgid "Button identifier. One of the [enum JoyButtonList] button constants." msgstr "" #: doc/classes/InputEventJoypadButton.xml:19 @@ -25178,7 +25177,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadMotion.xml:16 -msgid "Axis identifier. Use one of the [enum JoystickList] axis constants." +msgid "Axis identifier. Use one of the [enum JoyAxisList] axis constants." msgstr "" #: doc/classes/InputEventJoypadMotion.xml:19 @@ -57946,8 +57945,7 @@ msgstr "" #: doc/classes/XRController3D.xml:65 msgid "" "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." +"pressed. See [enum JoyButtonList]." msgstr "" #: doc/classes/XRController3D.xml:71 diff --git a/doc/translations/fr.po b/doc/translations/fr.po index d39ab5f248..57466d0b04 100644 --- a/doc/translations/fr.po +++ b/doc/translations/fr.po @@ -24666,7 +24666,7 @@ msgstr "" #: doc/classes/Input.xml:99 msgid "" "Returns the current value of the joypad axis at given index (see [enum " -"JoystickList])." +"JoyAxisList])." msgstr "" #: doc/classes/Input.xml:108 @@ -24675,7 +24675,7 @@ msgstr "" #: doc/classes/Input.xml:117 msgid "" -"Receives a [enum JoystickList] axis and returns its equivalent name as a " +"Receives a [enum JoyAxisList] axis and returns its equivalent name as a " "string." msgstr "" @@ -24685,7 +24685,7 @@ msgstr "" #: doc/classes/Input.xml:135 msgid "" -"Receives a gamepad button from [enum JoystickList] and returns its " +"Receives a gamepad button from [enum JoyButtonList] and returns its " "equivalent name as a string." msgstr "" @@ -24760,15 +24760,14 @@ msgstr "" #: doc/classes/Input.xml:238 msgid "" "Returns [code]true[/code] if you are pressing the joypad button (see [enum " -"JoystickList])." +"JoyButtonList])." msgstr "" #: doc/classes/Input.xml:247 msgid "" "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." +"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." msgstr "" #: doc/classes/Input.xml:256 @@ -25160,7 +25159,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadButton.xml:16 -msgid "Button identifier. One of the [enum JoystickList] button constants." +msgid "Button identifier. One of the [enum JoyButtonList] button constants." msgstr "" #: doc/classes/InputEventJoypadButton.xml:19 @@ -25188,7 +25187,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadMotion.xml:16 -msgid "Axis identifier. Use one of the [enum JoystickList] axis constants." +msgid "Axis identifier. Use one of the [enum JoyAxisList] axis constants." msgstr "" #: doc/classes/InputEventJoypadMotion.xml:19 @@ -57956,8 +57955,7 @@ msgstr "" #: doc/classes/XRController3D.xml:65 msgid "" "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." +"pressed. See [enum JoyButtonList]." msgstr "" #: doc/classes/XRController3D.xml:71 |